Skip to content

Commit 2c6a33b

Browse files
committed
Add documentation on /run/cloud-init-failed
1 parent dd2ba0e commit 2c6a33b

1 file changed

Lines changed: 17 additions & 6 deletions

File tree

docs/README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -621,7 +621,7 @@ available models per region
621621
622622
##### Incus
623623
624-
- `target`: name of the [specific cluster member](https://linuxcontainers.org/incus/docs/main/howto/cluster_manage_instance/#launch-an-instance-on-a-specific-cluster-member) to deploy the instance. **Only use with Incus cluster.**
624+
- `target`: name of the [specific cluster member](https://linuxcontainers.org/incus/docs/main/howto/cluster_manage_instance/#launch-an-instance-on-a-specific-cluster-member) to deploy the instance. **Only use with Incus cluster.**
625625
626626
#### 4.7.3 Post build modification effect
627627
@@ -1409,13 +1409,24 @@ first phase of the cluster-building process. The configuration: the
14091409
creation of the user accounts, installation of FreeIPA, Slurm, configuration
14101410
of JupyterHub, etc.; takes around 15 minutes after the instances are created.
14111411
1412-
Once it is booted, you can follow an instance configuration process by looking at:
1412+
Once booted, instances follow a two stage configuration process:
14131413
1414-
* `/var/log/cloud-init-output.log`
1415-
* `journalctl -u puppet`
1414+
1. Using cloud-init, upgrade operating system packages and install puppet.
1415+
2. Using puppet, install and configure software specific to the instance roles as defined by tags (i.e.: `node`).
14161416
1417-
If unexpected problems occur during configuration, you can provide these
1418-
logs to the authors of Magic Castle to help you debug.
1417+
The log for each are available under :
1418+
1419+
1. cloud-init: `/var/log/cloud-init-output.log`
1420+
2. puppet: `journalctl -u puppet`
1421+
1422+
When an issue happen during an instance first stage, a warning is logged in its `/etc/motd`.
1423+
The configuration commands that had issue are logged `/run/cloud-init-failed`. Because the
1424+
first stage completion is essential to the second stage, the configuration process is halted
1425+
when issues arise during the first stage. You may relaunch the configuration
1426+
process by running manually the commands that have failed and that are listed in
1427+
`/run/cloud-init-failed`. Issues during the first stage are rare events and most often the
1428+
result of issue with external dependencies i.e.: github is unavailable,
1429+
rpm repo is not responsive.
14191430
14201431
### 8.1 Deployment Customization
14211432

0 commit comments

Comments
 (0)