This is a meta package of cosmos-sdk-based docker images and configuration meant to make deploying onto Akash easy and standardized across cosmos.
The goal is to have a simple way to launch any cosmos chain, with a variety of different bootstrapping options
- "normal" boostrap - using
fastsync. - Hand-made snapshots a la cosmos-snapshots
- The new
state-syncmechanism.
Configuration is achieved using environment variables, with shortcuts available for common setups. Every aspect of the node configuration can be achieved in this way.
Additional features are included to make running a node as simple as possible
- Chain configuration can be sourced from a remote JSON file
- Genesis file can be downloaded and unzipped in various ways
- Private keys can be backed up and restored from any S3 compatible storage provider, such as Sia or Storj via Filebase.
- Snapshots of a nodes data directory can be created at a certain time or day and uploaded to an S3 storage provider
Omnibus has a generic base image which can download the required binary at runtime. This is useful for chain upgrades, testnets, or using a different version than Omnibus primarily supports.
This generic image provides the Omnibus scripts and configuration helpers, and nothing else. Set the BINARY_URL environment variable to a .zip, .tar or .tar.gz URL, and configure PROJECT, PROJECT_DIR and PROJECT_BIN. Alternatively provide a Chain Registry CHAIN_JSON to configure everything automatically (where data is available).
Image URL: ghcr.io/akash-network/cosmos-omnibus:v0.4.0-generic
services:
node:
image: ghcr.io/akash-network/cosmos-omnibus:v0.4.0-generic
env:
- MONIKER=my-moniker-1
- CHAIN_JSON=https://raw.githubusercontent.com/akash-network/net/main/edgenet/meta.json
- BINARY_ZIP_PATH=akash_0.15.0-rc14_linux_amd64/akashMore information on the generic image can be found at /generic, and configuration is detailed in depth below.
The available docker images can be found here. They are
tagged with the form $COSMOS_OMNIBUS_VERSION-$PROJECT-$PROJECT_VERSION.
| Project | Version | Image | |
|---|---|---|---|
| agoric | agoric-upgrade-7-2 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-agoric-agoric-upgrade-7-2 |
Example |
| akash | v0.26.1 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-akash-v0.26.1 |
Example |
| assetmantle | v1.0.0 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-assetmantle-v1.0.0 |
Example |
| autonomy | v1.2.1 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-autonomy-v1.2.1 |
Example |
| bandchain | v2.5.1 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-bandchain-v2.5.1 |
Example |
| bitcanna | v2.0.3 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-bitcanna-v2.0.3 |
Example |
| bitsong | v0.14.0 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-bitsong-v0.14.0 |
Example |
| bostrom | v0.3.2 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-bostrom-v0.3.2 |
Example |
| canto | v7.0.0 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-canto-v7.0.0 |
Example |
| cheqd | 0.6.9 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-cheqd-0.6.9 |
Example |
| chihuahua | v5.0.4 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-chihuahua-v5.0.4 |
Example |
| comdex | v11.5.1 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-comdex-v11.5.1 |
Example |
| cosmoshub | v13.0.1 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-cosmoshub-v13.0.1 |
Example |
| crescent | v4.2.0 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-crescent-v4.2.0 |
Example |
| cronos | v1.0.9 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-cronos-v1.0.9 |
Example |
| cryptoorgchain | v4.2.6 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-cryptoorgchain-v4.2.6 |
Example |
| decentr | v1.6.2 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-decentr-v1.6.2 |
Example |
| defund | v0.1.0-alpha |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-defund-v0.1.0-alpha |
Example |
| desmos | v4.8.0 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-desmos-v4.8.0 |
Example |
| dig | v3.3.1 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-dig-v3.3.1 |
Example |
| dydx | v1.0.0 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-dydx-v1.0.0 |
Example |
| emoney | v1.2.0 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-emoney-v1.2.0 |
Example |
| empowerchain | v1.0.0 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-empowerchain-v1.0.0 |
Example |
| evmos | v14.1.0 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-evmos-v14.1.0 |
Example |
| fetchhub | v0.10.6 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-fetchhub-v0.10.6 |
Example |
| gitopia | v2.1.1 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-gitopia-v2.1.1 |
Example |
| gravitybridge | v1.7.2 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-gravitybridge-v1.7.2 |
Example |
| impacthub | v0.18.1 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-impacthub-v0.18.1 |
Example |
| injective | v1.11.6-1688984159 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-injective-v1.11.6-1688984159 |
Example |
| irisnet | v2.0.1 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-irisnet-v2.0.1 |
Example |
| jackal | v3.0.2 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-jackal-v3.0.2 |
Example |
| juno | v17.1.1 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-juno-v17.1.1 |
Example |
| kava | v0.24.0 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-kava-v0.24.0 |
Example |
| kichain | 5.0.1 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-kichain-5.0.1 |
Example |
| konstellation | v0.5.0 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-konstellation-v0.5.0 |
Example |
| kujira | v0.9.1 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-kujira-v0.9.1 |
Example |
| kyve | v1.3.1 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-kyve-v1.3.1 |
Example |
| likecoin | v4.0.2 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-likecoin-v4.0.2 |
Example |
| lumnetwork | v1.6.2 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-lumnetwork-v1.6.2 |
Example |
| mars | v1.0.2 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-mars-v1.0.2 |
Example |
| migaloo | v3.0.1-hotfix |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-migaloo-v3.0.1-hotfix |
Example |
| neutron | v1.0.4 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-neutron-v1.0.4 |
Example |
| nois | v1.0.4 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-nois-v1.0.4 |
Example |
| omniflixhub | v0.12.0 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-omniflixhub-v0.12.0 |
Example |
| osmosis | v20.1.2 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-osmosis-v20.1.2 |
Example |
| panacea | v2.0.5 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-panacea-v2.0.5 |
Example |
| passage | v2.2.0 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-passage-v2.2.0 |
Example |
| persistence | v10.0.0 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-persistence-v10.0.0 |
Example |
| regen | v5.1.1 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-regen-v5.1.1 |
Example |
| rizon | v0.4.1 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-rizon-v0.4.1 |
Example |
| seinetwork | 1.2.2beta-postfix |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-seinetwork-1.2.2beta-postfix |
Example |
| sentinel | v0.10.1 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-sentinel-v0.10.1 |
Example |
| shentu | v2.8.0 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-shentu-v2.8.0 |
Example |
| sifchain | v1.1.0-beta |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-sifchain-v1.1.0-beta |
Example |
| sommelier | v4.0.2 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-sommelier-v4.0.2 |
Example |
| stargaze | v12.0.0 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-stargaze-v12.0.0 |
Example |
| starname | v0.11.5 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-starname-v0.11.5 |
Example |
| stride | v16.0.0 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-stride-v16.0.0 |
Example |
| teritori | v1.4.0 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-teritori-v1.4.0 |
Example |
| umee | v6.1.0 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-umee-v6.1.0 |
Example |
| ununifi | v3.2.2 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-ununifi-v3.2.2 |
Example |
| vidulum | v1.2.0 |
ghcr.io/akash-network/cosmos-omnibus:v0.4.0-vidulum-v1.2.0 |
Example |
There are example files within each project subdirectory which include a sensible default configuration for each chain. Optional configuration options are commented out so you can easily enable them, and the node can be configured further using the docs below.
See the deploy.yml example file in each chain directory which details the minimum configuration required. Use the configuration options below to add functionality. Note the commented out persistent storage configuration if needed.
See the docker-compose.yml example file in each chain directory to run each node using docker-compose up.
Omnibus can import chain snapshots from almost any location. Some examples are Chain Layer's QuickSync service and Polkachu's Tendermint Snapshots.
Appropriate snapshot configuration is included in most example configurations in the Omnibus repository. Check the project directories for more information.
See the _examples directory for some common setups, including:
- Statesync
- Load Balanced RPC Nodes
- Validator and TMKMS
- Validator and Public Sentries
- Validator with Private Sentries
- Snapshot Backup
Cosmos blockchains can be configured entirely using environment variables instead of the config files. Every chain has it's own prefix, but the format of the configuration is the same.
For example to configure the seeds option in the p2p section of config.toml, for the Akash blockchain:
AKASH_P2P_SEEDS=id@node:26656
The namespace for each of the supported chains in the cosmos omnibus can be found in the README in each project directory.
The omnibus images allow some specific variables and shortcuts to configure extra functionality, detailed below.
Chain config can be sourced from a chain.json file as seen in the Cosmos Chain Registry.
| Variable | Description | Default | Examples |
|---|---|---|---|
CHAIN_JSON |
URL to a chain.json file detailing the chain meta |
https://github.com/cosmos/chain-registry/blob/master/akash/chain.json |
|
CHAIN_ID |
The cosmos chain ID | akashnet-2 |
|
GENESIS_URL |
URL to the genesis file in .gz, .tar.gz, or .zip format. Can be set by CHAIN_JSON |
https://raw.githubusercontent.com/akash-network/net/main/mainnet/genesis.json |
|
DOWNLOAD_GENESIS |
Force download of genesis file. If unset the node will only download if the genesis file is missing | 1 |
|
VALIDATE_GENESIS |
Set to 1 to enable validation of genesis file | 0 |
1 |
Peer information can be provided manually, or obtained automatically from the following sources:
CHAIN_JSONURL with peer information included.- Polkachu's live peers.
- Any
ADDRBOOK_URLwhere theconfig/addrbook.jsonfile is hosted.
See Cosmos docs for more information.
| Variable | Description | Default | Examples |
|---|---|---|---|
P2P_SEEDS |
Seed nodes. Can be set by CHAIN_JSON or GENESIS_URL | id@node:26656 |
|
P2P_PERSISTENT_PEERS |
Persistent peers. Can be set by CHAIN_JSON or GENESIS_URL | id@node:26656 |
|
ADDRBOOK_URL |
URL to an addrbook.json file | https://quicksync.io/addrbook.terra.json |
On boot, the container can restore a private key from any S3 storage provider. If this is configured and the key doesn't exist in S3 yet, it will be uploaded from the node.
This allows for a persistent node ID and validator key on Akash's ephemeral storage.
Filebase is a great way to use S3 with decentralised hosting such as Sia.
The node_key.json and priv_validator_key.json are both backed up, and can be encrypted with a password.
| Variable | Description | Default | Examples |
|---|---|---|---|
S3_KEY |
S3 access key | ||
S3_SECRET |
S3 secret key | ||
S3_HOST |
The S3 API host | https://s3.filebase.com |
https://s3.us-east-1.amazonaws.com |
STORJ_ACCESS_GRANT |
DCS Storj Access Grant token (replaces S3_KEY, S3_SECRET, S3_HOST |
||
KEY_PATH |
Bucket and directory to backup/restore to | bucket/nodes/node_1 |
|
KEY_PASSWORD |
An optional password to encrypt your private keys. Shouldn't be optional |
Some shortcuts for enabling statesync. Statesync requires 2x nodes with snapshots enabled.
Statesync nodes can also be sourced from Polkachu's Statesync service automatically.
See an example of a statesync deployment.
| Variable | Description | Default | Examples |
|---|---|---|---|
STATESYNC_SNAPSHOT_INTERVAL |
Take a snapshot to provide statesync every X blocks | 500 |
|
STATESYNC_ENABLE |
Enabling statesyncing from a node. Default true if STATESYNC_RPC_SERVERS is set |
||
STATESYNC_RPC_SERVERS |
Comma separated list of RPC nodes with snapshots enabled | ip:26657,ip2:26657 |
|
STATESYNC_TRUSTED_NODE |
A trusted node to obtain trust height and hash from. Defaults to the first STATESYNC_RPC_SERVERS if set |
ip:26657 |
|
STATESYNC_TRUST_PERIOD |
Trust period for the statesync snapshot | 168h0m0s |
|
STATESYNC_TRUST_HEIGHT |
Obtained from STATESYNC_TRUSTED_NODE |
||
STATESYNC_TRUST_HASH |
Obtained from STATESYNC_TRUSTED_NODE |
The node data directory can be restored from a .tar, .tar.gz or .lz4 file stored on a public URL.
The file can be obtained from the following sources:
- Direct URL to the archive file
- Base URL file listing, where the archive matches a given pattern.
- snapshot.json generated by Omnibus Snapshot backup feature.
- ChainLayer's Quicksync snapshots described by a JSON file.
- Polkachu's snapshot service, fully automatically.
Note that snapshots will be restored in-process, without downloading the snapshot to disk first. This saves disk space but is slower to extract, and could be made configurable in the future.
| Variable | Description | Default | Examples |
|---|---|---|---|
DOWNLOAD_SNAPSHOT |
Force bootstrapping from snapshot. If unset the node will only restore a snapshot if the data contents are missing |
1 |
|
SNAPSHOT_URL |
A URL to a .tar, .tar.gz or .lz4 file |
http://135.181.60.250/akash/akashnet-2_2021-06-16.tar |
|
SNAPSHOT_BASE_URL |
A base URL to a directory containing backup files | http://135.181.60.250/akash |
|
SNAPSHOT_JSON |
A URL to a snapshot.json as detailed in Snapshot backup |
https://cosmos-snapshots.s3.filebase.com/akash/pruned/snapshot.json |
|
SNAPSHOT_FORMAT |
The format of the snapshot file | tar.gz |
tar/tar.zst |
SNAPSHOT_PATTERN |
The pattern of the file in the SNAPSHOT_BASE_URL |
$CHAIN_ID.*$SNAPSHOT_FORMAT |
foobar.*tar.gz |
SNAPSHOT_DATA_PATH |
The path to the data directory within the archive | snapshot/data |
|
SNAPSHOT_WASM_PATH |
The path to the wasm directory within the archive, if exists outside of data | snapshot/wasm |
|
SNAPSHOT_PRUNING |
Type of snapshot to download, e.g. archive, pruned, default. |
pruned |
archive |
SNAPSHOT_QUICKSYNC |
A URL to a Quicksync JSON file describing their snapshots. Also see SNAPSHOT_PRUNING |
https://quicksync.io/terra.json |
Omnibus includes a script to automatically snapshot a node and upload the resulting archive to any S3 compatible service like Filebase.
At a specified time (or day), the script will shut down the tendermint server, create an archive of the data directory and upload it.
Snapshots older than a specified time can also be deleted. Finally a JSON metadata file is created listing the current snapshots. The server is then restarted and monitored.
See an example of a snapshot node deployment.
| Variable | Description | Default | Examples |
|---|---|---|---|
S3_KEY |
S3 access key | ||
S3_SECRET |
S3 secret key | ||
S3_HOST |
The S3 API host | https://s3.filebase.com |
s3.us-east-1.amazonaws.com |
STORJ_ACCESS_GRANT |
DCS Storj Access Grant token (replaces S3_KEY, S3_SECRET, S3_HOST |
||
STORJ_UPLINK_ARGS |
DCS Storj Uplink arguments | -p 4 -t 4 --progress=false |
-p 8 -t 8 --parallelism-chunk-size 256M --progress=false |
SNAPSHOT_PATH |
The S3 path to upload snapshots to, including the bucket | cosmos-snapshots/akash |
|
SNAPSHOT_PREFIX |
The prefix for the snapshot filename | $CHAIN_ID |
snapshot |
SNAPSHOT_TIME |
The time the snapshot will run | 00:00:00 |
09:00:00 |
SNAPSHOT_DAY |
The numeric day of the week the snapshot will run (Monday = 1) | * |
7 |
SNAPSHOT_DIR |
The directory on disk to snapshot | $PROJECT_ROOT/data |
/root/.akash |
SNAPSHOT_CMD |
The command to run the server | $START_CMD |
akash start --someflag |
SNAPSHOT_RETAIN |
How long to retain snapshots for (0 to disable) | 2 days |
1 week |
SNAPSHOT_METADATA |
Whether to create a snapshot.json metadata file | 1 |
0 |
SNAPSHOT_METADATA_URL |
The URL snapshots will be served from (for snapshot.json) | https://cosmos-snapshots.s3.filebase.com/akash |
|
SNAPSHOT_SAVE_FORMAT |
Overrides value from SNAPSHOT_FORMAT. |
tar.gz |
tar (no compression)/tar.zst (use zstd) |
When SNAPSHOT_SAVE_FORMAT is set to tar.zst, additional variables can be set:
ZSTD_CLEVEL- Compression level, default3ZSTD_NBTHREADS- No. of threads, default1,0= detected no. of cpu cores
The node binary can be downloaded at runtime when using the Generic image. All configuration can be sourced from CHAIN_JSON if the attributes are available, or configured manually. You will need to set PROJECT, PROJECT_BIN and PROJECT_DIR if these can't be sourced from CHAIN_JSON.
| Variable | Description | Default | Examples |
|---|---|---|---|
BINARY_URL |
URL to the binary (or zip, tar, tar.gz) |
||
BINARY_ZIP_PATH |
Path to the binary in the archive. Can be left blank if correctly named in root | ||
PROJECT |
Name of the project, informs other variables | ||
PROJECT_BIN |
Binary name | $PROJECT |
osmosisd |
PROJECT_DIR |
Name of project directory | .$PROJECT_BIN |
.osmosisd |
Polkachu validator provide various Cosmos chain services that can be automatically enabled using environment variables.
| Variable | Description | Default | Examples |
|---|---|---|---|
POLKACHU_CHAIN_ID |
Polkachu API chain-id if it differs from Chain Registry naming convention. | cryptocom |
|
P2P_POLKACHU |
Import Polkachu's seed node if available | 1 |
|
STATESYNC_POLKACHU |
Import Polkachu's statesync addresses if available | 1 |
Cosmovisor can be downloaded at runtime to automatically manage chain upgrades. You should be familiar with how Cosmovisor works before using this feature.
| Variable | Description | Default | Examples |
|---|---|---|---|
COSMOVISOR_ENABLED |
Enable Cosmovisor binary download and support | 1 |
|
COSMOVISOR_VERSION |
Version of Cosmovisor to download | 1.5.0 |
|
COSMOVISOR_URL |
Alternative full URL to Cosmovisor binary tar.gz |
See Cosmos docs for more information
| Variable | Description | Default | Examples |
|---|---|---|---|
FASTSYNC_VERSION |
The fastsync version | v0 |
|
MINIMUM_GAS_PRICES |
Minimum gas prices | 0.025uakt |
|
PRUNING |
How much of the chain to prune | nothing |
|
DEBUG |
Set to 1 to output all environment variables on boot. Set to 2 to debug shell scripts. |
1, 2 |
Adding a new chain is easy:
- Ideally source or setup a
chain.jsonto provide a single source of truth for chain info - Add a project directory based on the existing projects
- Update the github workflow to create an image for your chain
Submit a PR or an issue if you want to see any specific chains.