-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
57 additions
and
33 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# ORBS-VM deploy |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# ORBS-VM Get Started | ||
All docker images can run on orbs network, but they need to be slightly adjusted to be able to run smoothly on the network. | ||
|
||
## Docker image Prerequistis and Specs and Best Practice | ||
|
||
### CPU architecture | ||
- Currently all ORBS permissionless nodes are running on x64-86 cpu architecture platforms | ||
- Make sure you build your docker image to support this architecture for the least | ||
|
||
### Storage | ||
- Orbs nodes are not designed to support big disk with big of data storage. | ||
- Most of ORBS nodes are 50-100 GB Disk size. | ||
- If you Docker container is going to use lots of disk space, ORBS-VM might not be the right choice. | ||
|
||
### Load and CPU consumption | ||
- Make your Docker image app as moderate cpu consumer as possible as your instance shares CPU time iwth ORBS core containers and other ORBS-VM instances. | ||
- Try to design your app to perform actions periodically in order to yield cpu consumption between executions. | ||
- Avoid long computation loops and actions which may take cpu time for human notable periods. | ||
- Avoid heavy IO operations that make take too long e.g writing and loading Huge JSON files to disk. | ||
|
||
### orchestration | ||
|
||
### contract with swarm | ||
|
||
### communication and ports | ||
|
||
It should maintain a [dockerfile HEALTHCHECK](https://docs.docker.com/engine/reference/builder/) and may benefit from orbs [status page](http://status.orbs.network), with its own representation, if maintains a status.json file according to a certain format. | ||
|
||
|
||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,26 @@ | ||
# orbs-vm introduction | ||
# ORBS-VM introduction | ||
|
||
## why use orbs-vm? | ||
- some logic is too hard to implement on smart contracts on any platform | ||
- smart contract can not trigger calls to themselves | ||
- interaction between several blockchain | ||
- decentralized backend complementry to your dapp smart contracts | ||
## Why use ORBS-VM? | ||
- Some logic is too hard to implement on smart contracts in any blockchain. | ||
- Implementing this login outside the blockchain is centralized. | ||
- Smart contract can not trigger calls to themselves. | ||
- Interaction between several blockchain. | ||
- Maintain fast cache logic. | ||
- Decentralized backend complementry to your dapp smart contracts. | ||
|
||
## how does it work | ||
- wrap your entire logic on a single docker image | ||
- push it to a public repo | ||
- open a pull request in v3-orbs-vm github repo | ||
- once authorized - you container is gradually deployed to the orbs-network. | ||
> Please note that ORBS-VM should be chosen only if ORBS-Lambda does not fulfill your dapp's requirement, As ORBS_Lambda is much easier to set up and maintain. | ||
## advantage use orbs-vm | ||
## keypoints using ORBS-VM | ||
- It can benefit from running on a decentralized permissionless network. | ||
- your container is always UP so long the network is alive | ||
- it can enjoy ORBS concensus decisions and data, for instace, which orbs-node with orbs-vm performs the next action, or split the computed data amongst several nodes to distribute computation. | ||
- it can enjoy ORBS concensus decisions and data, for instace, which orbs-node with ORBS-VM performs the next action, or split the computed data amongst several nodes to distribute computation. | ||
|
||
## how does it work | ||
You may get your dapp logic to run on as an ORBS-VM in a very few steps: | ||
|
||
- Wrap your entire logic on a single docker image | ||
- Push it to a public docker repo repo such as [https://hub.docker.com/](dockerhub) | ||
- Open a pull request in v3-ORBS-VM github as described [here](./deploy.md) | ||
- You container is gradually deployed to the orbs-network. | ||
|
||
|