Skip to content

Commit da8c326

Browse files
committed
Add runbook for deploying a test distribution
1 parent df07273 commit da8c326

File tree

5 files changed

+30
-1
lines changed

5 files changed

+30
-1
lines changed

docs/runbook/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ This page gathers the available guides to operate a Mithril network.
1818
| **Manage SSH access to infrastructure** | [ssh-access](./ssh-access/README.md) | Manage SSH access on the VM of the infrastructure for a user. |
1919
| **Upgrade VM of infrastructure** | [upgrade-vm](./upgrade-vm/README.md) | Upgrade the VM of the infrastructure of a Mithril network. |
2020
| **Create test Docker distribution** | [test-docker-distribution](./test-docker-distribution/README.md) | Create a custom test Docker distribution. |
21-
21+
| **Deploy a test network** | [test-docker-distribution](./test-deploy-network/README.md) | Manually deploy a test distribution to a test Mithril network. |
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Manually deploy a test distribution to a test Mithril network.
2+
3+
## Introduction
4+
5+
From time to time, we may need to deploy manually on a test Mithril network a test distribution in order to test unreleased features independently from the regular [release process](https://mithril.network/doc/adr/3). In that case, we have the opportunity to manually deploy to a pre-configured network a specific distribution.
6+
7+
## Run the associated 'Test network deploy' GitHub Actions workflow
8+
9+
Go to the page of the workflow with your browser: [Docker image test](https://github.com/input-output-hk/mithril/actions/workflows/test-deploy.yml)
10+
11+
Then, click on the **Run workflow** button:
12+
13+
![Run workflow button](./img/run-workflow-button.png)
14+
15+
Then fill the form to manually run the workflow:
16+
17+
![Run workflow form](./img/run-workflow-form.png)
18+
19+
> [!WARNING]
20+
> - The **Mithril image id** of the of the distribution to deploy must be published on the [package registry](https://github.com/orgs/input-output-hk/packages?repo_name=mithril)
21+
22+
> [!CAUTION]
23+
> It is highly recommended to run with the **Dry run** option checked at first and make sure that the process works as expected
24+
> The deployment of a distribution can lead to irreversible damages or loss for the network
25+
26+
27+
The result should look like this in the GitHub Actions:
28+
29+
![Run workflow result](./img/run-workflow-result.png)
36.4 KB
Loading
30.8 KB
Loading
45.1 KB
Loading

0 commit comments

Comments
 (0)