Skip to content

Commit de54dba

Browse files
Merge pull request #10052 from zaneb/agent-systemd-diagrams
NO-ISSUE: Generate the agent systemd diagrams from the unit files
2 parents 5b23c2f + ce73de0 commit de54dba

14 files changed

+2200
-4
lines changed

data/data/agent/systemd/CLAUDE.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Agent Installer Systemd Unit Files
2+
3+
When you modify systemd unit files in the `data/data/agent/systemd/units/` directory, and your changes affect the `[Unit]` section (which contains directives like `After`, `Before`, `PartOf`, etc. that define the relationships between systemd services), you must regenerate the agent installer service diagrams by running:
4+
5+
```bash
6+
make -C docs/user/agent/diagrams/
7+
```

docs/user/agent/agent-services.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Install workflow
44

5-
![Install workflow](./agent_installer_services-install_workflow.png)
5+
![Install workflow](./agent_installer_services-install_workflow.svg)
66

77
In the install workflow, all information needed to configure a cluster is included in the agent ISO.
88
When the agent ISO is booted, agent-tui and nmstate libraries are copied to the host from initrd. This copy
@@ -27,7 +27,7 @@ step is required because the agent-tui and nmstate libraries are too big to fit
2727

2828
## Add-nodes workflow
2929

30-
![Add-nodes workflow](./agent_installer_services-add_nodes_workflow.png)
30+
![Add-nodes workflow](./agent_installer_services-add_nodes_workflow.svg)
3131

3232
The add-nodes workflow is used to generate an ISO image for adding one or more nodes to a target cluster. It is very similar to the install workflow, with
3333
the following exceptions (highlighted in green in the previous picture):
@@ -41,7 +41,7 @@ the following exceptions (highlighted in green in the previous picture):
4141

4242
## Appliance workflow (unconfigured ignition and config image)
4343

44-
![Appliance workflow](./agent_installer_services-unconfigured_ignition_and_config_image_flow.png)
44+
![Appliance workflow](./agent_installer_services-unconfigured_ignition_and_config_image_flow.svg)
4545

4646
In the appliance workflow, most of the cluster deployment information is included in a config image that is mounted
4747
onto the host running the unconfigured-ignition. The appliance flow does not include the agent-tui or the
@@ -55,7 +55,7 @@ so no connectivity checks to the release image is needed.
5555

5656
## Interactive workflow (unconfigured ignition --interactive)
5757

58-
![Interactive workflow](./agent_installer_services-interactive.png)
58+
![Interactive workflow](./agent_installer_services-interactive.svg)
5959

6060
The interactive workflow allows the user to install a cluster by using the assisted UI running on the rendezvous node. In this workflow
6161
the agent-tui is also used interactively to configure which node will be the rendezvous host, and to configure accordingly the other nodes.
-62.2 KB
Binary file not shown.

docs/user/agent/agent_installer_services-add_nodes_workflow.svg

Lines changed: 349 additions & 0 deletions
Loading
-59.4 KB
Binary file not shown.

docs/user/agent/agent_installer_services-install_workflow.svg

Lines changed: 337 additions & 0 deletions
Loading
-41.9 KB
Binary file not shown.

docs/user/agent/agent_installer_services-interactive.svg

Lines changed: 304 additions & 0 deletions
Loading
Binary file not shown.

docs/user/agent/agent_installer_services-unconfigured_ignition_and_config_image_flow.svg

Lines changed: 277 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)