Skip to content

Commit f688512

Browse files
authored
Merge pull request #575 from input-output-hk/jpraynaud/500-new-environments
New environments documentation
2 parents 3893d07 + 85e1b38 commit f688512

File tree

2 files changed

+50
-11
lines changed

2 files changed

+50
-11
lines changed
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: Mithril environments are updated
3+
authors:
4+
- name: Mithril Team
5+
tags: [release-process, re-spin, preview, preprod, environments]
6+
---
7+
8+
### The Mithril environments are updated
9+
10+
**PR**: `New hosted environments` [#561](https://github.com/input-output-hk/mithril/pull/561)
11+
12+
**Issue**: `Setup new hosted environments for testing-preview, pre-release-preview and release-preprod) with their terraform and GitHub environments` [#542](https://github.com/input-output-hk/mithril/issues/542)
13+
14+
On Tuesday, November 1st, 2022 the `preview` Cardano network will be re-spun and will be unavailable for 48h.
15+
16+
In the mean time, the Mitril team is also implementing a new Release Process that will make use of several new environments.
17+
18+
The Mithril testing environments are thus evolving in this context:
19+
20+
- The current testing environment that runs on `preview` network and that most of the Pioneer SPOs are running is **deprecated** and will be decommissioned just after the `preview` network re-spin.
21+
22+
- This environment will then be replaced by a new `pre-release-preview` environment open to SPOs that are eager to test pre releases of the Mithril nodes.
23+
24+
- A new `release-preprod` environment has been launched on the `preprod` Cardano nework and will become the `stable` environment on which SPOs are encouraged to run their nodes.
25+
26+
- :warning: The new `release-preprod` environment is in `unstable` status, therefore it is subject to re-genesis. We expect it to be in `stable` status within 1-2 weeks.
27+
28+
In the future, when Mithril reaches `mainnet`, we assume that the `release-preprod` will be replaced by a `release-mainnet` environment. This means that we will have the following environments at this time: `testing-preview`, `pre-release-preprod` and `release-mainnet`.
29+
30+
More information about:
31+
32+
- The `Mithril Networks` and their availability [here](https://mithril.network/doc/manual/developer-docs/references#mithril-networks).
33+
34+
- The `Release Process` is available in this [ADR](https://mithril.network/doc/adr/3).
35+
36+
37+
Feel free to reach out to us on the [Discord channel](https://discord.gg/5kaErDKDRq) for questions and/or help.

docs/root/manual/developer-docs/references.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,19 @@ For more information about the **Mithril Protocol**, please refer to the [About
1818

1919
:::
2020

21+
## Mithril Networks
22+
23+
Here is an up ot date list of all the Mithril Networks and their status
24+
> Last update: 10/28/2022
25+
26+
| Mithril Network | Cardano Network | Magic Id | Supported | Aggregator Endpoint | Genesis Verification Key | Note
27+
|------------|------------|:-----------:|:------------:|:-----------------:|:------------------:|:------------|
28+
| `release-mainnet` | `mainnet` | - | :x: | - | - | Not supported yet
29+
| `release-preprod` | `preprod` | `1` | :warning: | [:arrow_upper_right:](https://aggregator.release-preprod.api.mithril.network/aggregator) | [:arrow_upper_right:](https://raw.githubusercontent.com/input-output-hk/mithril/main/TEST_ONLY_genesis.vkey) | Supported but subject to re-genesis shortly
30+
| `testing-preview` | `preview` | `2` | :warning: | [:arrow_upper_right:](https://aggregator.api.mithril.network/aggregator) | [:arrow_upper_right:](https://raw.githubusercontent.com/input-output-hk/mithril/main/TEST_ONLY_genesis.vkey) | Supported but it will be re-spun after the `preview` network re-spin, and endpoint location will be updated
31+
| `dev-devnet` | `devnet` | `42` | :heavy_check_mark: | [:arrow_upper_right:](http://localhost:8080/aggregator) | - | Supported on the `devnet` only
32+
| `-` | `testnet` | `1097911063` | :x: | - | - | Decommissioned, not supported anymore
33+
2134
## Dependencies List
2235

2336
| Dependency | Description | Source Repository | Rust Documentation | REST API
@@ -32,14 +45,3 @@ For more information about the **Mithril Protocol**, please refer to the [About
3245
| **Mithril Explorer** | The explorer website that connects to a **Mithril Aggregator** and displays its **Certificate Chain**. | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/blob/main/mithril-test-lab/mithril-end-to-end) | - | -
3346
| **Protocol Simulation** | A simple cli that helps understand how the **Mithril Protocol** works and the role of its protocol parameters. | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/blob/main/demo/protocol-demo) | - | -
3447

35-
## Mithril Networks
36-
37-
The Mithril Networks are aligned with the Cardano Networks and have the same name
38-
39-
| Network Code | Magic Id | Supported | Aggregator Endpoint | Genesis Verification Key | Note
40-
|------------|:-----------:|:------------:|:-----------------:|:------------------:|:------------|
41-
| `mainnet` | - | :x: | - | - | Not supported yet
42-
| `testnet` | `1097911063` | :x: | - | - | Deprecated, not supported anymore
43-
| `preprod` | `1` | :x: | - | - | Not implemented yet
44-
| `preview` | `2` | :heavy_check_mark: | [:arrow_upper_right:](https://aggregator.api.mithril.network/aggregator) | [:arrow_upper_right:](https://raw.githubusercontent.com/input-output-hk/mithril/main/TEST_ONLY_genesis.vkey) | Supported
45-
| `devnet` | `42` | :heavy_check_mark: | [:arrow_upper_right:](http://localhost:8080/aggregator) | - | Supported on the `devnet` only

0 commit comments

Comments
 (0)