Setting up Cosmovisor
Utilize cosmovisor for the ease in upgrades
Setting up Cosmovisor
Setting up Cosmovisor is relatively straightforward. However, it does expect certain environment variables and folder structure to be set.
Cosmovisor allows you to download binaries ahead of time for chain upgrades, meaning that you can do zero (or close to zero) downtime chain upgrades. It's also useful if your local timezone means that a chain upgrade will fall at a bad time.
Rather than having to do stressful ops tasks late at night, it's always better if you can automate them away, and that's what Cosmovisor tries to do.
Install
First, go and get Cosmovisor (recommended approach):
Your installation can be confirmed with:
This will return something like:
You can also build from source; cosmovisor is in the main cosmos-sdk repo on Github, so you can use Git tags to target a specific version. This example uses a tag, v0.42.7 that refers to the Cosmos SDK, as Cosmovisor-specific tags did not exist before August 2021. The first of these was cosmovisor/v0.1.0, and the second is the current release, cosmovisor/v1.0.0.
Add environment variables to your shell
In the .profile file, usually located at ~/.profile, add:
Then source your profile to have access to these variables:
You can confirm success like so:
It should return starsd.
Set up folder structure
Cosmovisor expects a certain folder structure as shown below. You can install the linux utility tree to produce a similar output to check on your own server.
Don't worry about current - that is simply a symlink used by Cosmovisor. The other folders will need setting up, but this is easy:
Set up genesis binary
Cosmovisor needs to know which binary to use at genesis. We put this in $DAEMON_HOME/cosmovisor/genesis/bin.
First, find the location of the binary you want to use:
Then use the path returned to copy it to the directory Cosmovisor expects. Let's assume the previous command returned /home/your-user/go/bin/starsd:
Once you're done, check the folder structure looks correct using a tool like tree.
Set up systemd service
Commands sent to Cosmovisor are sent to the underlying binary. For example, cosmovisor version is the same as typing starsd version.
Nevertheless, just as we would manage starsd using a process manager, we would like to make sure Cosmovisor is automatically restarted if something happens, for example an error or reboot.
First, create the service file:
Change the contents of the below to match your setup - cosmovisor is likely at ~/go/bin/cosmovisor regardless of which installation path you took above, but it's worth checking.
Start Cosmovisor
Finally, enable the service and start it.
Check it is running using:
If you need to monitor the service after launch, you can view the logs using:
Last updated