Skip to content

Commit 60d89d6

Browse files
committed
minor docs tweaks
1 parent 5c8de5a commit 60d89d6

File tree

2 files changed

+13
-11
lines changed

2 files changed

+13
-11
lines changed

docs/image-build.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The Packer configuration here can be used to build two types of images:
1616
available from [GitHub releases](https://github.com/stackhpc/ansible-slurm-appliance/releases).
1717
However site-specific fat images can also be built from a different source
1818
image e.g. if a different partition layout is required.
19-
2. "Extra-build" images which extend a StackHPC fat image to create a site-specific
19+
2. "Extra-build" images which extend a fat image to create a site-specific
2020
image with with additional packages or functionality. For example the NVIDIA
2121
`cuda` packages cannot be redistributed hence require an "extra" build.
2222

@@ -39,8 +39,8 @@ For either a site-specific fat-image build or an extra-build:
3939
# environments/site/inventory/group_vars/all/dnf_repos.yml:
4040
dnf_repos_password: 'your-ark-password'
4141
```
42-
> [!IMPORTANT]
43-
> The latter file should be vault-encrypted.
42+
> [!IMPORTANT]
43+
> The latter file should be vault-encrypted.
4444
4545
Alternatively, configure a [local Pulp mirror](experimental/pulp.md).
4646
@@ -72,10 +72,12 @@ For either a site-specific fat-image build or an extra-build:
7272
- The source image should be either:
7373
- For a site-specific fatimage build: A RockyLinux GenericCloud or
7474
compatible image.
75-
- For an extra-build image: The appropriate StackHPC fat image, as defined
76-
in `environments/.stackhpc/tofu/cluster_image.auto.tfvars.json`. See the
77-
[GitHub release page](https://github.com/stackhpc/ansible-slurm-appliance/releases)
78-
for download links.
75+
- For an extra-build image: Usually the appropriate StackHPC fat image,
76+
as defined in `environments/.stackhpc/tofu/cluster_image.auto.tfvars.json` at the
77+
checkout's current commit. See the [GitHub release page](https://github.com/stackhpc/ansible-slurm-appliance/releases)
78+
for download links. In some cases extra builds may be chained, e.g.
79+
one extra build adds a Lustre client, and the resulting image is used
80+
as the source image for an extra build adding GPU support.
7981
- The `inventory_groups` variable takes a comma-separated list of Ansible
8082
inventory groups to add the build VM to (in addition to the `builder`
8183
group which is it always in). This controls which Ansible roles and

docs/operations.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ By default, the following utility packages are installed during the StackHPC ima
9696

9797
Additional packages can be added during image builds by:
9898

99-
1. Configuring an [docs/image-build.md](./image-build.md) to enable the
99+
1. Configuring an [image build](./image-build.md) to enable the
100100
`extra_packages` group:
101101

102102

@@ -126,9 +126,9 @@ the OpenHPC installation guide (linked from the
126126
corresponding `lmod` modules.
127127
128128
Packages *may* also be installed during the site.yml, by adding the `cluster`
129-
group into the `extra_packages` group. An error will occur if Ark credentials
130-
are defined in this case, as they are readable by unprivileged users in the
131-
`.repo` files and a local Pulp mirror must be used instead.
129+
group as a child of the `extra_packages` group. An error will occur if Ark
130+
credential are defined in this case, as they are readable by unprivileged users
131+
in the `.repo` files and a local Pulp mirror must be used instead.
132132
133133
If additional repositories are required, these could be added/enabled as necessary in a play added to `environments/$SITE_ENV/hooks/{pre,post}.yml` as appropriate. Note such a play should NOT exclude the builder group, so that the repositories are also added to built images. There are various Ansible modules which might be useful for this:
134134
- `ansible.builtin.yum_repository`: Add a repo from an URL providing a 'repodata' directory.

0 commit comments

Comments
 (0)