Updates after review

dlachaume · dlachaume · commit ba3083d343e2 · 2024-04-15T15:58:25.000+02:00
diff --git a/docs/runbook/README.md b/docs/runbook/README.md
@@ -6,19 +6,20 @@ This page gathers the available guides to operate a Mithril network.
 
 # Guides
 
-| Operation                                 | Location                                                               | Description                                                               |
-| ----------------------------------------- | ---------------------------------------------------------------------- | ------------------------------------------------------------------------- |
-| **Genesis manually**                      | [manual-genesis](./genesis-manually/README.md)                         | Proceed to manual (re)genesis of the aggregator certificate chain.        |
-| **Era markers**                           | [era-markers](./era-markers/README.md)                                 | Create and update era markers on the Cardano chain.                       |
-| **Downloads statistics**                  | [downloads statistics](./statistics/README.md)                         | Display the number of downloads per day.                                  |
-| **Signer registrations monitoring**       | [registrations-monitoring](./registrations-monitoring/README.md)       | Gather aggregated data about signer registrations (versions, stake, ...). |
-| **Update protocol parameters**            | [protocol-parameters](./protocol-parameters/README.md)                 | Update the protocol parameters of a Mithril network.                      |
-| **Recompute certificates hash**           | [recompute-certificates-hash](./recompute-certificates-hash/README.md) | Recompute the certificates hash of an aggregator.                         |
-| **Fix terraform lock**                    | [terraform-lock](./terraform-lock/README.md)                           | Fix a terraform lock in CD workflows.                                     |
-| **Manage SSH access to infrastructure**   | [ssh-access](./ssh-access/README.md)                                   | Manage SSH access on the VM of the infrastructure for a user.             |
-| **Upgrade VM of infrastructure**          | [upgrade-vm](./upgrade-vm/README.md)                                   | Upgrade the VM of the infrastructure of a Mithril network.                |
-| **Create test Docker distribution**       | [test-docker-distribution](./test-docker-distribution/README.md)       | Create a custom test Docker distribution.                                 |
-| **Deploy a test network manually**        | [test-deploy-network](./test-deploy-network/README.md)                 | Manually deploy a test distribution to a test Mithril network.            |
-| **Publish crates to crates.io manually**  | [manual-publish-crates](./manual-publish-crates/README.md)             | Manually publish Rust crates to crates.io.                                |
-| **Publish packages to npm manually**      | [manual-publish-npm](./manual-publish-npm/README.md)                   | Manually publish packages to npm registry.                                |
-| **Client multi-platform test**            | [test-client-multiplatform](./test-client-multiplatform/README.md)     | Run multi-platform client CLI binaries, docker and WASM package tests.    |
+| Operation                                  | Location                                                                             | Description                                                                 |
+| -----------------------------------------  | ------------------------------------------------------------------------------------ | --------------------------------------------------------------------------- |
+| **Genesis manually**                       | [manual-genesis](./genesis-manually/README.md)                                       | Proceed to manual (re)genesis of the aggregator certificate chain.          |
+| **Era markers**                            | [era-markers](./era-markers/README.md)                                               | Create and update era markers on the Cardano chain.                         |
+| **Downloads statistics**                   | [downloads statistics](./statistics/README.md)                                       | Display the number of downloads per day.                                    |
+| **Signer registrations monitoring**        | [registrations-monitoring](./registrations-monitoring/README.md)                     | Gather aggregated data about signer registrations (versions, stake, ...).   |
+| **Update protocol parameters**             | [protocol-parameters](./protocol-parameters/README.md)                               | Update the protocol parameters of a Mithril network.                        |
+| **Recompute certificates hash**            | [recompute-certificates-hash](./recompute-certificates-hash/README.md)               | Recompute the certificates hash of an aggregator.                           |
+| **Fix terraform lock**                     | [terraform-lock](./terraform-lock/README.md)                                         | Fix a terraform lock in CD workflows.                                       |
+| **Manage SSH access to infrastructure**    | [ssh-access](./ssh-access/README.md)                                                 | Manage SSH access on the VM of the infrastructure for a user.               |
+| **Upgrade VM of infrastructure**           | [upgrade-vm](./upgrade-vm/README.md)                                                 | Upgrade the VM of the infrastructure of a Mithril network.                  |
+| **Create test Docker distribution**        | [test-docker-distribution](./test-docker-distribution/README.md)                     | Create a custom test Docker distribution.                                   |
+| **Deploy a test network manually**         | [test-deploy-network](./test-deploy-network/README.md)                               | Manually deploy a test distribution to a test Mithril network.              |
+| **Publish crates to crates.io manually**   | [manual-publish-crates](./manual-publish-crates/README.md)                           | Manually publish Rust crates to crates.io.                                  |
+| **Publish packages to npm manually**       | [manual-publish-npm](./manual-publish-npm/README.md)                                 | Manually publish packages to npm registry.                                  |
+| **Client multi-platform test**             | [test-client-multiplatform](./test-client-multiplatform/README.md)                   | Run multi-platform client CLI binaries, docker and WASM package tests.      |
+| **Maintain Cardano minimum versions file** | [maintain-cardano-min-versions-file](./maintain-cardano-min-versions-file/README.md) | Maintain the `cardano-min-versions.json` file                               |
diff --git a/docs/runbook/maintain-cardano-min-versions-file/README.md b/docs/runbook/maintain-cardano-min-versions-file/README.md
@@ -1,14 +1,24 @@
-#  Cardano minimum versions for Signers
+#  Cardano node minimum versions for Signers
 
 ## Introduction
 
-The [cardano-min-versions.json](../../../cardano-min-versions.json) file, which specifies the minimum supported versions of the Cardano node for Mithril signers
-This ensures compatibility and functionality across different networks.
+The [cardano-min-versions.json](../../../cardano-min-versions.json) file, which specifies the minimum supported versions of the Cardano node for Mithril signers and facilitates the verification of compatibility for the Cardano networks.
 
 ## Maintaining the file
 
-When a new a new Cardano node version is released:
-- Verify the Cardano node compatibility with Mithril nodes, especially through the CI process.
-- Depending on the network:
-    - For the stable networks `preview`, `preprod`, and `mainnet`: the minimum supported `cardano-node` version must be updated to be two stable releases behind the current release version.
-    - For the unstable network `sanchonet`: given its current evolving nature, the minimum supported `cardano-node` version may vary from the stable one.
+### Assessment of compatibility:
+- Update the `e2e` job in the [ci.yml](../../../.github/workflows/ci.yml) file by adding the new Cardano node version in the `cardano_node_version` variables of the matrix.
+- Create a pull request to test the new Cardano node version in the devnet using CI end-to-end tests
+- Assess the compatibility:
+    - **Compatible without modification**: in that case Mithril nodes are compatible without modification and versions can be bumped immediately.
+    - **Modifications are required by the Mithril team**: in that case the versions can be bumped after the necessary modifications are implemented and a new distribution is released.
+
+### Update policy by network:
+
+Here are the recommended update policies by Cardano network:
+| Network | Status | Policy
+|------------|------------|------------
+`preview` | **stable** | the minimum supported Cardano node version should be updated to be two stable releases behind the current release version.
+`preprod` | **stable** | the minimum supported Cardano node version should be updated to be two stable releases behind the current release version.
+`mainnet` | **stable** | the minimum supported Cardano node version should be updated to be two stable releases behind the current release version.
+`sanchonet` | **unstable** | given the unstable status of the network, the minimum supported Cardano node version may vary from the stable one.
diff --git a/docs/website/root/manual/getting-started/run-signer-node.md b/docs/website/root/manual/getting-started/run-signer-node.md
@@ -93,7 +93,7 @@ Note that this guide works on a Linux machine only.
   * Read rights on the `Database` folder (specified by the `--database-path` setting of the **Cardano node**)
   * Read and write rights on the `Inter Process Communication` file (typically defined by the `CARDANO_NODE_SOCKET_PATH` environment variable used to launch the **Cardano node**)
 
-* Install a recent version of [`cardano-cli`](https://github.com/input-output-hk/cardano-node/releases/tag/8.7.3) (version 8.7.3+).
+* Install a recent version of [`cardano-cli`](https://github.com/IntersectMBO/cardano-node/releases/tag/8.9.1) (version 8.9.1+).
 
 * Install a correctly configured Rust toolchain (latest stable version). You can follow the instructions provided [here](https://www.rust-lang.org/learn/get-started).
 
@@ -115,15 +115,15 @@ Note that this guide works on a Linux machine only.
 
 :::info
 
-To verify that your node version is supported, compare the version of your Cardano node with the minimum supported versions listed in the `cardano-min-versions.json` file located at the root of the repository.
+Compare the version of your Cardano node with the minimum supported versions listed in the [`cardano-min-versions.json`](https://github.com/input-output-hk/mithril/blob/main/cardano-min-versions.json) to verify its compatibility with the Mithril signer.
 
 First, check the version of your Cardano node by running the following command:
 
 ```bash
 cardano-node --version
 ```
 
-Then, refer to the minimum supported versions listed in the `cardano-min-versions.json` file, which can be found [here](https://github.com/input-output-hk/mithril/blob/main/cardano-min-versions.json).
+Then, refer to the minimum supported versions listed in the the [`cardano-min-versions.json`](https://github.com/input-output-hk/mithril/blob/main/cardano-min-versions.json) file.
 
 You can also fetch the minimum supported version for your network using the command below:
 ```bash
@@ -135,8 +135,6 @@ Here is an example for `preprod`:
 wget -q -O - https://raw.githubusercontent.com/input-output-hk/mithril/main/cardano-min-versions.json | jq -r '.network.preprod'
 ```
 
-Compare the Cardano node versions, if your node version is equal to or higher than the minimum supported version listed for your network, your Cardano node is supported.
-
 :::
 
 ### Building your own executable
