Skip to content

Commit df07273

Browse files
committed
Add runbook for creating test Docker distribution
1 parent 48ff787 commit df07273

File tree

5 files changed

+33
-0
lines changed

5 files changed

+33
-0
lines changed

docs/runbook/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,5 @@ This page gathers the available guides to operate a Mithril network.
1717
| **Fix terraform lock** | [terraform-lock](./terraform-lock/README.md) | Fix a terraform lock in CD workflows. |
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. |
20+
| **Create test Docker distribution** | [test-docker-distribution](./test-docker-distribution/README.md) | Create a custom test Docker distribution. |
21+
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Create a custom test Docker distribution.
2+
3+
## Introduction
4+
5+
From time to time, we may need to create a test Docker distribution with custom arguments (notably the version of the Cardano CLi that is used).
6+
This is a convenient way for testing early releases of the Cardano node. This is also commonly used to create a Docker distribution from an unmerged PR.
7+
8+
## Run the associated 'Docker images test' GitHub Actions workflow
9+
10+
Go to the page of the workflow with your browser: [Docker image test](https://github.com/input-output-hk/mithril/actions/workflows/test-docker.yml)
11+
12+
Then, click on the **Run workflow** button:
13+
14+
![Run workflow button](./img/run-workflow-button.png)
15+
16+
Then fill the form to manually run the workflow:
17+
18+
![Run workflow form](./img/run-workflow-form.png)
19+
20+
> [!WARNING]
21+
> - The SHA of the commit must have been run successfully in the CI workflow beforehand
22+
23+
> [!CAUTION]
24+
> It is highly recommended to run with the **Dry run** option checked at first and make sure that the process works as expected
25+
26+
27+
The result should look like this in the GitHub Actions:
28+
29+
![Run workflow result](./img/run-workflow-result.png)
30+
31+
You should also be able to see the newly created Docker images in the [package registry](https://github.com/orgs/input-output-hk/packages?repo_name=mithril)
37 KB
Loading
58.3 KB
Loading
59.9 KB
Loading

0 commit comments

Comments
 (0)