Skip to content

Commit

Permalink
docs: add docs versioning (#3092)
Browse files Browse the repository at this point in the history
* docs: add versioning for current docs

* docs: mv archived migrations; mv modules

* docs: update docusaurus configs

* docs: update docusaurus configs

* rm unneded file; update docs docs

* update docusaurus

* Update DOCS_README.md
  • Loading branch information
MSalopek authored May 14, 2024
1 parent 0a16a03 commit c9a3831
Show file tree
Hide file tree
Showing 30 changed files with 344 additions and 162 deletions.
15 changes: 9 additions & 6 deletions docs/DOCS_README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,6 @@ parent:

If you want to open a PR on Gaia to update the documentation, please follow the guidelines in the [`CONTRIBUTING.md`](https://github.com/cosmos/gaia/tree/main/CONTRIBUTING.md)

## Internationalization

- Translations for documentation live in a `docs/translations/<locale>/` folder, where `<locale>` is the language code for a specific language. For example, `zh` for Chinese, `ko` for Korean, `es` for Spanish, etc.
- Each `docs/translations/<locale>/` folder must follow the same folder structure within `docs/`, but only content in the following folders needs to be translated and included in the respective `docs/translations/<locale>/` folder
- Each `docs/translations/<locale>/` folder must also have a `README.md` that includes a translated version of both the layout and content within the root-level [`README.md`](https://github.com/cosmos/cosmos-sdk/tree/master/docs/README.md). The layout defined in the `README.md` is used to build the homepage.

## Docs Build Workflow

The documentation for Gaia is hosted at:
Expand Down Expand Up @@ -79,6 +73,15 @@ Install project dependencies
npm install
```

Pull the versions referenced in `versions.json` and `docusaurus.config.js`:

```shell
cd ../ # back to project root
make build-docs
git checkout <your_working_branch>
cd docs
```

Serve the app

```bash
Expand Down
40 changes: 0 additions & 40 deletions docs/README copy.md

This file was deleted.

6 changes: 3 additions & 3 deletions docs/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ import { currentParams } from '@site/docs/governance/current-parameters.js';
import { PlainVar } from '@site/src/js/Var';

:::tip
### **v15.1 Upgrade**
Cosmos Hub will be upgraded to [v15.1](https://github.com/cosmos/gaia/releases/tag/v15.1.0) at block height: **[19,639,600](https://www.mintscan.io/cosmos/blocks/19639600)**
### **v16 Upgrade**
Cosmos Hub will be upgraded to [v16](https://github.com/cosmos/gaia/releases/tag/v16.0.0) at block height: **[20,440,500](https://www.mintscan.io/cosmos/blocks/20440500)**

To upgrade from v14 check the [**upgrade guide**](/migration/cosmoshub-4-v15-upgrade.md)
To upgrade from v15.2.0 check the [**upgrade guide**](./migration/latest.md)
:::

![Welcome to the Cosmos Hub](images/cosmos-hub-image.jpg)
Expand Down
4 changes: 1 addition & 3 deletions docs/docs/interchain-security/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: Interchain Security
order: false
parent:
order: 2
order: 3
---

The Interchain Security feature, brings to the Cosmos Hub a shared security model, where the Cosmos Hub validators, also validate on consumer chains. This is valuable for consumer chains, as consumer chains can focus on product-market fit, rather than business and operational agreements in bringing together a validator set. As part of this agreement, consumer chains pay for the security by distributing a portion of the consumer chain revenue to Hub token holders.
Expand Down
5 changes: 0 additions & 5 deletions docs/docs/metaprotocols/_category_.json

This file was deleted.

18 changes: 8 additions & 10 deletions docs/docs/migration/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
---
order: false
parent:
title: Migration Instructions
order: 9
title: Upgrade Instructions
---
<!--
markdown-link-check-disable
-->

# Migration Instructions

This directory houses Cosmos Hub major upgrade migration instructions.
# Upgrading

- [Upgrading from `cosmoshub-2` to `cosmoshub-3`](./cosmoshub-2/cosmoshub-2.md)
- [Upgrading from `cosmoshub-3` to `cosmoshub-4`](./cosmoshub-3/cosmoshub-3.md)
<!-- markdown-link-check-enable -->
To upgrade to the latest `cosmoshub-4` version check:
- [latest upgrade](./latest.md)

To check archived migrations and historic `cosmoshub` versions check:
- [Upgrading from `cosmoshub-2` to `cosmoshub-3`](./archive/cosmoshub-2/cosmoshub-2.md)
- [Upgrading from `cosmoshub-3` to `cosmoshub-4`](./archive/cosmoshub-3/cosmoshub-3.md)
2 changes: 1 addition & 1 deletion docs/docs/migration/_category_.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "Migration Instructions",
"label": "Upgrade Instructions",
"position": 9,
"link": { "type": "doc", "id": "migration/README" }
}
16 changes: 16 additions & 0 deletions docs/docs/migration/archive/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
order: false
parent:
title: Archived Instructions
---


# Archive

This directory houses archived Cosmos Hub major upgrade migration instructions.

The migrations are not relevant for mainnet, but you may find them useful in case you are providing infrastructure for historic versions of the Cosmos Hub.

To view archived migrations for old versions check:
- [Upgrading from `cosmoshub-2` to `cosmoshub-3`](./cosmoshub-2/cosmoshub-2.md)
- [Upgrading from `cosmoshub-3` to `cosmoshub-4`](./cosmoshub-3/cosmoshub-3.md)
5 changes: 5 additions & 0 deletions docs/docs/migration/archive/cosmoshub-4/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"label": "CosmosHub-4",
"position": 3,
"link": null
}
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ The chain-id of the network will remain the same, `cosmoshub-4`. This is because

## Preparing for the upgrade

System requirements for validator nodes can be found [here](../getting-started/system-requirements.md).
System requirements for validator nodes can be found [here](../../../getting-started/system-requirements.md).

### Backups

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Optimal CPU performance:  2.50GHz, 8 cores (eg Intel Xeon Gold 6248 or equivale

It is paramount that the operators set enough SWAP to cover all cases. SWAP partitions can be used to supplement the RAM requirement but they will increase the upgrade time.

After the upgrade you can revert your hardware setting to the recommended system requirements for normal [day-to-day operations](../getting-started/system-requirements.md).
After the upgrade you can revert your hardware setting to the recommended system requirements for normal [day-to-day operations](../../../getting-started/system-requirements.md).

### Backups

Expand Down
200 changes: 200 additions & 0 deletions docs/docs/migration/latest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,200 @@
---
title: v16.0.0 Upgrade
---

# Upgrading Gaia

This guide provides instructions for upgrading Gaia from v15.2.x to v16.0.0.

This document describes the steps for validators, full node operators and relayer operators, to upgrade successfully for the Gaia v16 release.

For more details on the release, please see the [release notes](https://github.com/cosmos/gaia/releases/tag/v16.0.0)

**Relayer Operators** for the Cosmos Hub and consumer chains, will also need to update to use [Hermes v1.8.0](https://github.com/informalsystems/hermes/releases/tag/v1.8.0) or higher. You may need to restart your relayer software after a major chain upgrade.

## Release Binary

Please use the correct release binary: `v16.0.0`.

## Instructions

- [Upgrading Gaia](#upgrading-gaia)
- [Release Binary](#release-binary)
- [Instructions](#instructions)
- [On-chain governance proposal attains consensus](#on-chain-governance-proposal-attains-consensus)
- [Upgrade date](#upgrade-date)
- [Preparing for the upgrade](#preparing-for-the-upgrade)
- [System requirements](#system-requirements)
- [An Important Note for Node Operators](#an-important-note-for-node-operators)
- [Backups](#backups)
- [Testing](#testing)
- [Current runtime](#current-runtime)
- [Target runtime](#target-runtime)
- [Upgrade steps](#upgrade-steps)
- [Method I: Manual Upgrade](#method-i-manual-upgrade)
- [Method II: Upgrade using Cosmovisor](#method-ii-upgrade-using-cosmovisor)
- [Manually preparing the binary](#manually-preparing-the-binary)
- [Preparation](#preparation)
- [Expected upgrade result](#expected-upgrade-result)
- [Auto-Downloading the Gaia binary](#auto-downloading-the-gaia-binary)
- [Upgrade duration](#upgrade-duration)
- [Rollback plan](#rollback-plan)
- [Communications](#communications)
- [Risks](#risks)
- [Reference](#reference)

## On-chain governance proposal attains consensus

Once a software upgrade governance proposal is submitted to the Cosmos Hub, both a reference to this proposal and an `UPGRADE_HEIGHT` are added to the [release notes](https://github.com/cosmos/gaia/releases/tag/v16.0.0).
If and when this proposal reaches consensus, the upgrade height will be used to halt the "old" chain binaries. You can check the proposal on one of the block explorers or using the `gaiad` CLI tool.

## Upgrade date

The date/time of the upgrade is subject to change as blocks are not generated at a constant interval. You can stay up-to-date by checking the estimated estimated time until the block is produced one of the block explorers (e.g. https://www.mintscan.io/cosmos/blocks/`UPGRADE_HEIGHT`).

## Preparing for the upgrade

### Backups

Prior to the upgrade, validators are encouraged to take a full data snapshot. Snapshotting depends heavily on infrastructure, but generally this can be done by backing up the `.gaia` directory.
If you use Cosmovisor to upgrade, by default, Cosmovisor will backup your data upon upgrade. See below [upgrade using cosmovisor](#method-ii-upgrade-using-cosmovisor) section.

It is critically important for validator operators to back-up the `.gaia/data/priv_validator_state.json` file after stopping the gaiad process. This file is updated every block as your validator participates in consensus rounds. It is a critical file needed to prevent double-signing, in case the upgrade fails and the previous chain needs to be restarted.

### Testing

For those validator and full node operators that are interested in ensuring preparedness for the impending upgrade, you can run a [v16 Local Testnet](https://github.com/cosmos/testnets/tree/master/local) or join in our [Cosmos Hub Public Testnet](https://github.com/cosmos/testnets/tree/master/public).

### Current runtime

The Cosmos Hub mainnet network, `cosmoshub-4`, is currently running [Gaia v15.2.0](https://github.com/cosmos/gaia/releases/v15.2.0). We anticipate that operators who are running on v15.2.0, will be able to upgrade successfully. Validators are expected to ensure that their systems are up to date and capable of performing the upgrade. This includes running the correct binary and if building from source, building with the appropriate `go` version.

### Target runtime

The Cosmos Hub mainnet network, `cosmoshub-4`, will run **[Gaia v16.0.0](https://github.com/cosmos/gaia/releases/tag/v16.0.0)**. Operators _**MUST**_ use this version post-upgrade to remain connected to the network. The new version requires `go v1.21` to build successfully.

## Upgrade steps

There are 2 ways to upgrade a node:

- Manual upgrade
- Upgrade using [Cosmovisor](https://pkg.go.dev/cosmossdk.io/tools/cosmovisor)
- Either by manually preparing the new binary
- Or by using the auto-download functionality (this is not yet recommended)

If you prefer to use Cosmovisor to upgrade, some preparation work is needed before upgrade.

### Method I: Manual Upgrade

Make sure **Gaia v15.2.0** is installed by either downloading a [compatible binary](https://github.com/cosmos/gaia/releases/tag/v15.2.0), or building from source. Check the required version to build this binary in the `Makefile`.

Run Gaia v15.2.0 till upgrade height, the node will panic:

```shell
ERR UPGRADE "v16" NEEDED at height: <UPGRADE_HEIGHT>: upgrade to v16 and applying upgrade "v16" at height:<UPGRADE_HEIGHT>
```

Stop the node, and switch the binary to **Gaia v16.0.0** and re-start by `gaiad start`.

It may take several minutes to a few hours until validators with a total sum voting power > 2/3 to complete their node upgrades. After that, the chain can continue to produce blocks.

### Method II: Upgrade using Cosmovisor

#### Manually preparing the binary

##### Preparation

- Install the latest version of Cosmovisor (`1.5.0`):

```shell
go install cosmossdk.io/tools/cosmovisor/cmd/cosmovisor@latest
cosmovisor version
# cosmovisor version: v1.5.0
```

- Create a `cosmovisor` folder inside `$GAIA_HOME` and move Gaia `v15.2.0` into `$GAIA_HOME/cosmovisor/genesis/bin`:

```shell
mkdir -p $GAIA_HOME/cosmovisor/genesis/bin
cp $(which gaiad) $GAIA_HOME/cosmovisor/genesis/bin
```

- Build Gaia `v16.0.0`, and move gaiad `v16.0.0` to `$GAIA_HOME/cosmovisor/upgrades/v16/bin`

```shell
mkdir -p $GAIA_HOME/cosmovisor/upgrades/v16/bin
cp $(which gaiad) $GAIA_HOME/cosmovisor/upgrades/v16/bin
```

At this moment, you should have the following structure:

```shell
.
├── current -> genesis or upgrades/<name>
├── genesis
│ └── bin
│ └── gaiad # old: v15.2.0
└── upgrades
└── v16
└── bin
└── gaiad # new: v16.0.0
```

- Export the environmental variables:

```shell
export DAEMON_NAME=gaiad
# please change to your own gaia home dir
# please note `DAEMON_HOME` has to be absolute path
export DAEMON_HOME=$GAIA_HOME
export DAEMON_RESTART_AFTER_UPGRADE=true
```

- Start the node:

```shell
cosmovisor run start --x-crisis-skip-assert-invariants --home $DAEMON_HOME
```

Skipping the invariant checks is strongly encouraged since it decreases the upgrade time significantly and since there are some other improvements coming to the crisis module in the next release of the Cosmos SDK.

##### Expected upgrade result

When the upgrade block height is reached, Gaia will panic and stop:

This may take a few minutes.
After upgrade, the chain will continue to produce blocks when validators with a total sum voting power > 2/3 complete their node upgrades.

#### Auto-Downloading the Gaia binary

## Upgrade duration

The upgrade may take a few minutes to complete because cosmoshub-4 participants operate globally with differing operating hours and it may take some time for operators to upgrade their binaries and connect to the network.

## Rollback plan

During the network upgrade, core Cosmos teams will be keeping an ever vigilant eye and communicating with operators on the status of their upgrades. During this time, the core teams will listen to operator needs to determine if the upgrade is experiencing unintended challenges. In the event of unexpected challenges, the core teams, after conferring with operators and attaining social consensus, may choose to declare that the upgrade will be skipped.

Steps to skip this upgrade proposal are simply to resume the cosmoshub-4 network with the (downgraded) v15.2.0 binary using the following command:

```shell
gaiad start --unsafe-skip-upgrade <UPGRADE_HEIGHT>
```

Note: There is no particular need to restore a state snapshot prior to the upgrade height, unless specifically directed by core Cosmos teams.

Important: A social consensus decision to skip the upgrade will be based solely on technical merits, thereby respecting and maintaining the decentralized governance process of the upgrade proposal's successful YES vote.

## Communications

Operators are encouraged to join the `#cosmos-hub-validators-verified` channel of the Cosmos Hub Community Discord. This channel is the primary communication tool for operators to ask questions, report upgrade status, report technical issues, and to build social consensus should the need arise. This channel is restricted to known operators and requires verification beforehand. Requests to join the `#cosmos-hub-validators-verified` channel can be sent to the `#general-support` channel.

## Risks

As a validator performing the upgrade procedure on your consensus nodes carries a heightened risk of double-signing and being slashed. The most important piece of this procedure is verifying your software version and genesis file hash before starting your validator and signing.

The riskiest thing a validator can do is discover that they made a mistake and repeat the upgrade procedure again during the network startup. If you discover a mistake in the process, the best thing to do is wait for the network to start before correcting it.

## Reference

[Join Cosmos Hub Mainnet](https://github.com/cosmos/mainnet)
3 changes: 2 additions & 1 deletion docs/docs/modules/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@ links for each one.

## Module List

- [Global Fee](./globalfee.md) introduced in [v8 Rho](../migration/cosmoshub-4-v8-Rho-upgrade.md)
- [Global Fee](./globalfee.md)
- [Metaprotocols](./metaprotocols.md)
4 changes: 2 additions & 2 deletions docs/docs/modules/globalfee.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Gaia Fee and Fees Checks
order: 2
title: Globalfee
order: 1
---

## Fee Parameters
Expand Down
Loading

0 comments on commit c9a3831

Please sign in to comment.