Akash v0.24.0 Network Upgrade

Documentation related to Akash Network upgrade to version 0.24.0:

Upgrade Details

Akash v0.24.0 Node Upgrade Guide

Network Upgrade Schedule

Countdown to network upgrade is listed below.

Upgrade Details

Akash Network v0.24.0

Akash Mainnet

Upgrade Guidelines

Update Go

Go toolchain 1.21.0is required. For more information, see Go.

Common Steps for All Upgrade Options

In the sections that follow both Cosmovisor and non-Cosmovisor upgrade paths are provided. Prior to detailing specifics steps for these upgrade paths, in this section we cover steps required regardless of upgrade path chosen.

NOTE - The following steps are not required if the auto-download option is enabled for Cosmovisor.

Either download the Akash binary (v0.24.0) or build it from source. We highly recommend using a pre-complied binary but provide instructions to build from source here in the rare event it would be necessary.

Option 1: Upgrade Using Cosmovisor

The following instructions assume the akash and cosmovisor binaries are already installed and cosmovisor is set up as a systemd service.

The section that follows will detail the install/configuration of Cosmovisor. If additional details are necessary, visit Start a node with Cosmovisor for instructions on how to install and set up the binaries.

NOTE - Cosmovisor 1.0 is required

Configure Cosmovisor

Note: The following steps are not required if Cosmovisor v1.0 is already installed and configured to your preferred settings.

To install cosmovisor by running the following command:

go install cosmossdk.io/tools/cosmovisor/cmd/cosmovisor@v1.5.0

Check to ensure the installation was successful:

DAEMON_NAME=akash DAEMON_HOME=~/.akash cosmovisor version

Update cosmovisor systemd service file and make sure the environment variables are set to the appropriate values (the following example includes the recommended settings).

  • NOTE - It is preferable if you start your service under a dedicated non-system user other than root.
  • NOTE - DAEMON_SHUTDOWN_GRACE (optional, default none), if set, send interrupt to binary and wait the specified time to allow for cleanup/cache flush to disk before sending the kill signal. The value must be a duration (e.g. 1s).
[Unit]
Description=Akash with cosmovisor
Requires=network-online.target
After=network-online.target


[Service]
User=root
Group=root
ExecStart=/root/go/bin/cosmovisor run start


Restart=always
RestartSec=10
LimitNOFILE=4096
Environment="DAEMON_NAME=akash"
Environment="DAEMON_HOME=/root/.akash"
Environment="DAEMON_RESTART_AFTER_UPGRADE=true"
Environment="DAEMON_ALLOW_DOWNLOAD_BINARIES=false"
Environment="DAEMON_LOG_BUFFER_SIZE=512"
Environment="UNSAFE_SKIP_BACKUP=true"
Environment="DAEMON_SHUTDOWN_GRACE=15s"


[Install]
WantedBy=multi-user.target

Cosmovisor can be configured to automatically download upgrade binaries. It is recommended that validators do not use the auto-download option and that the upgrade binary is compiled and placed manually.

If you would like to enable the auto-download option, update the following environment variable in the systemd configuration file:

Environment="DAEMON_ALLOW_DOWNLOAD_BINARIES=true"

Cosmovisor will automatically create a backup of the data directory at the time of the upgrade and before the migration.

If you would like to disable the auto-backup, update the following environment variable in the systemd configuration file:

Environment="UNSAFE_SKIP_BACKUP=true"

Move the file to the systemd directory:

sudo mv cosmovisor.service /etc/systemd/system/akash.service

Restart cosmovisor to ensure the environment variables have been updated:

systemctl daemon-reload
systemctl start akash
systemctl enable akash

Check the status of the cosmovisor service:

sudo systemctl status cosmovisor

Enable cosmovisor to start automatically when the machine reboots:

sudo systemctl enable cosmovisor.service

Prepare Upgrade Binary

Skip this section if you have enabled DAEMON_ALLOW_DOWNLOAD_BINARIES cosmovisor parameter. It will automatically create the correct path and download the binary based on the plan info from the govt proposal.

Create the folder for the upgrade binary (v0.24.0) - cloned in this step - and copy the akash binary into the folder.

This next step assumes that the akash binary was built from source and stored in the current (i.e., akash) directory:

mkdir -p $HOME/.akash/cosmovisor/upgrades/v0.24.0/bin


cp ./.cache/bin $HOME/.akash/cosmovisor/upgrades/v0.24.0/bin

At the proposed block height, cosmovisor will automatically stop the current binary (v0.20.X), set the upgrade binary as the new current binary (v0.24.0), and then restart the node.\

Option 2: Upgrade Without Cosmovisor

Using Cosmovisor to perform the upgrade is not mandatory.

Node operators also have the option to manually update the akash binary at the time of the upgrade. Doing it before the upgrade height will stop the node.

When the chain halts at the proposed upgrade height, stop the current process running akash.

Either download the Akash upgrade binary (v0.24.0) or build from source - completed in this step - and ensure the akash binary has been updated:

akash version

Update configuration with

akash init

Restart the process running akash.

Appendix

Build Binary From Source

NOTE - we highly recommend downloading a complied Akash binary over building the binary from source 

git clone https://github.com/akash-network/node
cd node
git fetch --all
git checkout v0.24.0
make release

Akash v0.26.1 Node Upgrade Guide

Network Upgrade Schedule

Countdown to network upgrade is listed below.

Upgrade Details

Akash Network v0.26.1

Akash Mainnet

Upgrade Guidelines

Update Go

Go toolchain 1.21.0is required. For more information, see Go.

Common Steps for All Upgrade Options

In the sections that follow both Cosmovisor and non-Cosmovisor upgrade paths are provided. Prior to detailing specifics steps for these upgrade paths, in this section we cover steps required regardless of upgrade path chosen.

NOTE - The following steps are not required if the auto-download option is enabled for Cosmovisor.

Either download the Akash binary (v0.26.1) or build it from source. We highly recommend using a pre-complied binary but provide instructions to build from source here in the rare event it would be necessary.

Option 1: Upgrade Using Cosmovisor

The following instructions assume the akash and cosmovisor binaries are already installed and cosmovisor is set up as a systemd service.

The section that follows will detail the install/configuration of Cosmovisor. If additional details are necessary, visit Start a node with Cosmovisor for instructions on how to install and set up the binaries.

NOTE - Cosmovisor 1.0 is required

Configure Cosmovisor

Note: The following steps are not required if Cosmovisor v1.0 is already installed and configured to your preferred settings.

To install cosmovisor by running the following command:

go install cosmossdk.io/tools/cosmovisor/cmd/cosmovisor@v1.5.0

Check to ensure the installation was successful:

DAEMON_NAME=akash DAEMON_HOME=~/.akash cosmovisor version

Update cosmovisor systemd service file and make sure the environment variables are set to the appropriate values (the following example includes the recommended settings).

  • NOTE - It is preferable if you start your service under a dedicated non-system user other than root.
  • NOTE - DAEMON_SHUTDOWN_GRACE (optional, default none), if set, send interrupt to binary and wait the specified time to allow for cleanup/cache flush to disk before sending the kill signal. The value must be a duration (e.g. 1s).
[Unit]
Description=Akash with cosmovisor
Requires=network-online.target
After=network-online.target


[Service]
User=root
Group=root
ExecStart=/root/go/bin/cosmovisor run start


Restart=always
RestartSec=10
LimitNOFILE=4096
Environment="DAEMON_NAME=akash"
Environment="DAEMON_HOME=/root/.akash"
Environment="DAEMON_RESTART_AFTER_UPGRADE=true"
Environment="DAEMON_ALLOW_DOWNLOAD_BINARIES=false"
Environment="DAEMON_LOG_BUFFER_SIZE=512"
Environment="UNSAFE_SKIP_BACKUP=true"
Environment="DAEMON_SHUTDOWN_GRACE=15s"


[Install]
WantedBy=multi-user.target

Cosmovisor can be configured to automatically download upgrade binaries. It is recommended that validators do not use the auto-download option and that the upgrade binary is compiled and placed manually.

If you would like to enable the auto-download option, update the following environment variable in the systemd configuration file:

Environment="DAEMON_ALLOW_DOWNLOAD_BINARIES=true"

Cosmovisor will automatically create a backup of the data directory at the time of the upgrade and before the migration.

If you would like to disable the auto-backup, update the following environment variable in the systemd configuration file:

Environment="UNSAFE_SKIP_BACKUP=true"

Move the file to the systemd directory:

sudo mv cosmovisor.service /etc/systemd/system/akash.service

Restart cosmovisor to ensure the environment variables have been updated:

systemctl daemon-reload
systemctl start akash
systemctl enable akash

Check the status of the cosmovisor service:

sudo systemctl status cosmovisor

Enable cosmovisor to start automatically when the machine reboots:

sudo systemctl enable cosmovisor.service

Prepare Upgrade Binary

Skip this section if you have enabled DAEMON_ALLOW_DOWNLOAD_BINARIES cosmovisor parameter. It will automatically create the correct path and download the binary based on the plan info from the govt proposal.

Create the folder for the upgrade binary (v0.26.1) - cloned in this step - and copy the akash binary into the folder.

This next step assumes that the akash binary was built from source and stored in the current (i.e., akash) directory:

mkdir -p $HOME/.akash/cosmovisor/upgrades/v0.26.1/bin


cp ./.cache/bin $HOME/.akash/cosmovisor/upgrades/v0.26.1/bin

At the proposed block height, cosmovisor will automatically stop the current binary (v0.24.X), set the upgrade binary as the new current binary (v0.26.1), and then restart the node.\

Option 2: Upgrade Without Cosmovisor

Using Cosmovisor to perform the upgrade is not mandatory.

Node operators also have the option to manually update the akash binary at the time of the upgrade. Doing it before the upgrade height will stop the node.

When the chain halts at the proposed upgrade height, stop the current process running akash.

Either download the Akash upgrade binary (v0.26.1) or build from source - completed in this step - and ensure the akash binary has been updated:

akash version

Update configuration with

akash init

Restart the process running akash.

Appendix

Build Binary From Source

NOTE - we highly recommend downloading a complied Akash binary over building the binary from source 

git clone https://github.com/akash-network/node
cd node
git fetch --all
git checkout v0.26.1
make release

Mainnet6 Provider Upgrade Procedure

Overview

This is a comprehensive guide that covers the steps necessary to upgrade from Mainnet5 to Mainnet6 of Akash Network and Akash Provider components in a Kubernetes cluster.

Provider Components to be Upgraded

  • provider-services is the main binary of the akash-provider, akash-hostname-operator, akash-inventory-operator, and akash-ip-operator helm charts
  • akash is the main binary of the akash-node helm chart

Mainnet5 Versions

  • provider-services: 0.2.1
  • node: 0.20.0/0.22.0 (akash network 0.20.0)

Mainnet6 Versions

  • provider-services: 0.4.6
  • node: 0.24.0 (akash network 0.24.0)

Prerequisites

  • ENSURE TO EXAMINE ENTIRE GUIDE PRIOR DOING ANYTHING
  • Ensure Helm installed and configured
  • Ensure kubectl is installed
  • Ensure kubectl is configured to access your provider(s) cluster(s)
  • Provider key imported on your local machine
  • Environment is configured:
    • AKASH_NODE is set to your preferable RPC node
    • AKASH_CHAIN_ID=akashnet-2
  • Install provider-services v0.4.6 on your local machine

Upgrade Procedure

IMPORTANT! Seek help if you encounter an issue at any step or have doubts! Please seek the support in the #providers Akash Network Devs Discord room here.

STEP 1 - Scale down to 0 replicas the akash-provider

This step is crucial to prevent unexpected behavior during the upgrade.

NOTE: The Akash Deployments will continue to run as usual while akash-provider service is stopped. The only impact is that users won’t be able to perform lease-<shell|events|logs> against their deployments nor deploy/update or terminate them.

kubectl -n akash-services scale statefulsets akash-provider --replicas=0

STEP 2 - Akash Provider Migration

NOTE - the migration procedure covered in this step is only necessary if your provider has active leases which need to be migrated for Mainnet6 provider use. If you provider has no active leases - proeed directly to Step 3.

NOTE - when the dry run migration step (2.1) is run the command should output text stating “loaded CRDs” and “loaded active leases for provider”. If blank output is received instead this indicates that no active leases were found for your provider. If the provider does in fact have active leases - please check the RPC node used for possible issue.

2.1. Get the new provider-services binary file, which supports the migration

The link to the binary files in case if you have other than x86_64 (amd64) architecture https://github.com/akash-network/provider/releases/tag/v0.4.6

To install provider-services v0.4.6 follow this doc

Verify you have installed the provider-services properly:

provider-services version

Expected output:

# provider-services version
v0.4.6
2.2. Dry-run Provider Migration

IMPORTANT: If the following commands returns any error, please seek the support in the #providers Akash Network Devs Discord room here!

NOTE: --crd-dry-run=true by default

NOTE - for the from switch used in the command sets, issue provider-services keys list if unsure what the key name should be

NOTE - in the command syntax we include the --kubeconfig switch. The default location checked for kubeconfig is /<home-directory>/.kube/config The explicit switch can be removed if kubeconfig exists in the default directory.

provider-services migrate v2beta2 \
--crd-v2beta1=https://raw.githubusercontent.com/akash-network/provider/v0.2.1/pkg/apis/akash.network/crd.yaml \
--crd-v2beta2=https://raw.githubusercontent.com/akash-network/provider/v0.4.6/pkg/apis/akash.network/crd.yaml \
--crd-backup-path=./crd \
--from=<KEY NAME> \
--kubeconfig=<full-path-to-kubeconfig>
2.3. If Previous Step Succeeded - Run Actual Migration

NOTE - Dry-run step above make backup of existing CRDs, you’ll be prompted to replace it, press y and hit Enter

provider-services migrate v2beta2 \
--crd-dry-run=false \
--crd-v2beta1=https://raw.githubusercontent.com/akash-network/provider/v0.2.1/pkg/apis/akash.network/crd.yaml \
--crd-v2beta2=https://raw.githubusercontent.com/akash-network/provider/v0.4.6/pkg/apis/akash.network/crd.yaml \
--crd-backup-path=./crd \
--from=<KEY NAME> \
--kubeconfig=<full-path-to-kubeconfig>

STEP 3 - Upgrade the Helm Charts

Follow these steps to upgrade various Helm charts. Make sure you’ve backed up your existing Helm chart configurations.

Helm charts to be upgraded are: akash-node (aka RPC node), akash-provider, akash-hostname-operator, akash-inventory-operator, and akash-ip-operator.

Do not upgrade the chart if you did not have it installed previously!

In this step you’ll be saving the current akash-node, akash-provider, akash-ip-operator chart configs as files named akash-node-values.yml, akash-provider-values.yml, akash-ip-operator-values.yml respectively.

We recommend switcingh into a new directory called mainnet6-chart-configs where you will be saving them.

You can later move the chart config files to the directory of your choice (typically the one you originally configured & kept them at)

cd ~
mkdir mainnet6-chart-configs
cd mainnet6-chart-configs
3.1. Upgrade the Repo
helm repo update akash

Verify you can see the correct chart/app versions:

# helm search repo akash
NAME                            CHART VERSION  APP VERSION  DESCRIPTION
akash/akash-hostname-operator   6.0.4          0.4.6        An operator to map Ingress objects to Akash dep...
akash/akash-inventory-operator  6.0.4          0.4.6        An operator required for persistent storage (op...
akash/akash-ip-operator         6.0.4          0.4.6        An operator required for ip marketplace (optional)
akash/akash-node                6.0.0          0.24.0       Installs an Akash RPC node (required)
akash/provider                  6.0.4          0.4.6        Installs an Akash provider (required)
3.2. akash-node Chart

Take the current akash-node chart values:

helm -n akash-services get values akash-node | grep -v '^USER-SUPPLIED VALUES' > akash-node-values.yml

Upgrade your akash-node chart:

Prior to executing the Helm Upgrade command - inspect akash-node-values.yml for image tag and remove it if present.

helm upgrade akash-node akash/akash-node -n akash-services -f akash-node-values.yml
3.3 akash-provider Chart

Take the current akash-provider chart values:

helm -n akash-services get values akash-provider | grep -v '^USER-SUPPLIED VALUES' > akash-provider-values.yml

Prior to executing the Helm Upgrade command - inspect akash-provider-values.yml for image tag and remove it if present.

helm upgrade akash-provider akash/provider -n akash-services -f akash-provider-values.yml

IMPORTANT: Make sure your provider is using the latest bid price script! Here is the guide that tells you how you can set it for your akash-provider chart.

3.4 akash-hostname-operator Chart
helm upgrade akash-hostname-operator akash/akash-hostname-operator -n akash-services
3.5 akash-inventory-operator Chart

Skip this section if your provider does not provide persistent storage.

Note: This is not a typo, we are installing the inventory-operator without the akash- prefix.

helm upgrade inventory-operator akash/akash-inventory-operator -n akash-services
3.6 akash-ip-operator Chart

Skip this section if your provider does not provide IP leasing.

Take the current akash-ip-operator chart values:

helm -n akash-services get values akash-ip-operator | grep -v '^USER-SUPPLIED VALUES' > akash-ip-operator-values.yml

Prior to executing the Helm Upgrade command - inspect akash-ip-operator-values.yml for image tag and remove it if present.

helm upgrade akash-ip-operator akash/akash-ip-operator -n akash-services -f akash-ip-operator-values.yml

STEP 4 - Verify the Charts Have Been Upgraded

Perform these checks to ensure the upgrade was successful.


Run this command to check the pods and their versions within the akash-services namespace:

kubectl -n akash-services get pods -o custom-columns='NAME:.metadata.name,IMAGE:.spec.containers[*].image'

The charts upgrade went well, if you are seeing these images and versions:

  • provider and operator image is: ghcr.io/akash-network/provider:0.4.6
  • node image is: ghcr.io/akash-network/node:0.24.0

Example Result:

# kubectl -n akash-services get pods -o custom-columns='NAME:.metadata.name,IMAGE:.spec.containers[*].image'
NAME                                        IMAGE
akash-hostname-operator-86d4596d6c-pwbt8    ghcr.io/akash-network/provider:0.4.6
akash-inventory-operator-69464fbdff-dxkk5   ghcr.io/akash-network/provider:0.4.6
akash-ip-operator-6f6ddc47f8-498kj          ghcr.io/akash-network/provider:0.4.6
akash-node-1-0                              ghcr.io/akash-network/node:0.24.0
akash-provider-0                            ghcr.io/akash-network/provider:0.4.6
Edit page on github
Akash Mainnet8 Upgrade Akash Provider Feature Discovery Upgrade/Enablement
footer-logo-dark

© Akash Network 2024 The Akash Network Authors Documentation Distributed under CC BY 4.0

Open-source Apache 2.0 Licensed.

GitHub v0.20.0

Privacy