Skip to content

Commit 775d6fc

Browse files
committed
docs: Bring example versions up to date, swap skydive example for magnum
1 parent ebf2770 commit 775d6fc

File tree

3 files changed

+24
-23
lines changed

3 files changed

+24
-23
lines changed

docs/architecture/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ Overcloud images are built using a manually triggered [GitHub Actions workflow](
132132
They are pushed to a [Pulp file repository](https://pulpproject.org/pulp_file/) in Ark, and uploaded to the SMS lab Glance image service for all-in-one and multi-node testing.
133133

134134
Overcloud images are versioned based on the OpenStack release name, and the date/time stamp at the beginning of the build workflow, e.g. `2024.1-20240922T102435`.
135-
This version string is included in the Pulp distribution `base_path` of the image, e.g. https://ark.stackhpc.com/pulp/content/kayobe-images/2023.1/rocky/9/2023.1-20240325T130221/overcloud-rocky-9.qcow2
135+
This version string is included in the Pulp distribution `base_path` of the image, e.g. https://ark.stackhpc.com/pulp/content/kayobe-images/2024.1/rocky/9/2024.1-20240922T102435/overcloud-rocky-9.qcow2
136136

137137
## Testing
138138

docs/usage/content-howto.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ If using Zed release onwards:
8181

8282
The list of services supported by StackHPC Kayobe configuration is defined via
8383
the feature flags in the
84-
[ci-builder](https://github.com/stackhpc/stackhpc-kayobe-config/blob/stackhpc/wallaby/etc/kayobe/environments/ci-builder/stackhpc-ci.yml)
84+
[ci-builder](https://github.com/stackhpc/stackhpc-kayobe-config/blob/stackhpc/2024.1/etc/kayobe/environments/ci-builder/stackhpc-ci.yml)
8585
environment. To add a new service, add the relevant feature flag (see
8686
`etc/kayobe/kolla.yml` for supported flags). For example:
8787

@@ -115,7 +115,7 @@ above](#update-kolla-container-images) to build and consume the new images.
115115

116116
### Set up client Pulp syncing for the image
117117

118-
Finally, the new images must be added to the `stackhpc_pulp_images` list in [etc/kayobe/pulp.yml](https://github.com/stackhpc/stackhpc-kayobe-config/blob/stackhpc/wallaby/etc/kayobe/pulp.yml).
118+
Finally, the new images must be added to the `stackhpc_pulp_images` list in [etc/kayobe/pulp.yml](https://github.com/stackhpc/stackhpc-kayobe-config/blob/stackhpc/2024.1/etc/kayobe/pulp.yml).
119119
This updates the list of images that are synced from Ark to clients' local Pulp service.
120120
This step should be performed last, once the images have been pushed to Ark and promoted, otherwise client container syncs would fail.
121121

docs/usage/content-workflows.md

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ ansible/test-kayobe-repo-version-generate.yml \
139139
-e kayobe_config_repo_path=./stackhpc-kayobe-config/
140140
```
141141

142-
Package repository versions are stored in StackHPC Kayobe configuration in [etc/kayobe/pulp-repo-versions.yml](https://github.com/stackhpc/stackhpc-kayobe-config/blob/stackhpc/wallaby/etc/kayobe/pulp-repo-versions.yml).
142+
Package repository versions are stored in StackHPC Kayobe configuration in [etc/kayobe/pulp-repo-versions.yml](https://github.com/stackhpc/stackhpc-kayobe-config/blob/stackhpc/2024.1/etc/kayobe/pulp-repo-versions.yml).
143143
Note that the updated versions are not necessarily released.
144144
The generated file may be amended as necessary (in case not all updates are required), then copied to the StackHPC Kayobe configuration.
145145

@@ -172,19 +172,20 @@ An `Overcloud container images` artifact will be visible on the summary page of
172172
This artifact contains a list of the built images.
173173
After a successful container image build workflow, another workflow is triggered to [sync the images](#syncing-container-images) to the test Pulp.
174174

175-
In the following example, the user specified a regular expression of `^skydive`, matching all of the Skydive images, and the `base` image that they depend on.
175+
In the following example, the user specified a regular expression of `^magnum`, matching all of the Magnum images, and the `base` image that they depend on.
176176

177177
```
178178
REPOSITORY TAG IMAGE ID CREATED SIZE
179-
ark.stackhpc.com/stackhpc-dev/skydive-agent 2023.1-rocky-9-20240811T091848 32f2b9299194 6 minutes ago 1.29GB
180-
ark.stackhpc.com/stackhpc-dev/skydive-analyzer 2023.1-rocky-9-20240811T091848 35e4c1cda1a8 7 minutes ago 1.14GB
181-
ark.stackhpc.com/stackhpc-dev/skydive-base 2023.1-rocky-9-20240811T091848 3bd5f3e50aa3 7 minutes ago 1.14GB
182-
ark.stackhpc.com/stackhpc-dev/base 2023.1-rocky-9-20240811T091848 bd02fa0ec1d6 7 minutes ago 991MB
179+
ark.stackhpc.com/stackhpc-dev/magnum-api 2024.1-rocky-9-20240811T091848 32f2b9299194 6 minutes ago 1.29GB
180+
ark.stackhpc.com/stackhpc-dev/magnum-conductor 2024.1-rocky-9-20240811T091848 35e4c1cda1a8 7 minutes ago 1.14GB
181+
ark.stackhpc.com/stackhpc-dev/magnum-base 2024.1-rocky-9-20240811T091848 3bd5f3e50aa3 7 minutes ago 1.14GB
182+
ark.stackhpc.com/stackhpc-dev/openstack-base 2024.1-rocky-9-20240811T091848 bd02fa0ec1d6 7 minutes ago 991MB
183+
ark.stackhpc.com/stackhpc-dev/base 2024.1-rocky-9-20240811T091848 bd02fa0ec1d6 7 minutes ago 991MB
183184
```
184185

185-
In this example, the base and Skydive images have been tagged `2023.1-rocky-9-20240811T091848`.
186+
In this example, the `base`, `openstack-base` and Magnum images have been tagged `2024.1-rocky-9-20240811T091848`.
186187

187-
Instructions for building Kolla container images manually are provided in the [StackHPC kayobe config documentation](https://stackhpc-kayobe-config.readthedocs.io/en/stackhpc-2023.1/contributor/environments/ci-builder.html).
188+
Instructions for building Kolla container images manually are provided in the [StackHPC kayobe config documentation](https://stackhpc-kayobe-config.readthedocs.io/en/stackhpc-2024.1/contributor/environments/ci-builder.html).
188189

189190
## Publishing container images
190191

@@ -227,7 +228,7 @@ ansible/test-pulp-container-publish.yml
227228

228229
## Updating container image tags in Kayobe configuration (Yoga release and earlier)
229230

230-
The image tag used deploy containers may be updated for all images in [etc/kayobe/kolla.yml](https://github.com/stackhpc/stackhpc-kayobe-config/blob/stackhpc/wallaby/etc/kayobe/kolla.yml), or for specific images in [etc/kayobe/kolla/globals.yml](https://github.com/stackhpc/stackhpc-kayobe-config/blob/stackhpc/wallaby/etc/kayobe/kolla/globals.yml).
231+
The image tag used deploy containers may be updated for all images in [etc/kayobe/kolla.yml](https://github.com/stackhpc/stackhpc-kayobe-config/blob/stackhpc/2024.1/etc/kayobe/kolla.yml), or for specific images in [etc/kayobe/kolla/globals.yml](https://github.com/stackhpc/stackhpc-kayobe-config/blob/stackhpc/2024.1/etc/kayobe/kolla/globals.yml).
231232
Currently this is a manual process.
232233

233234
Use the new tag from the [container image build](#building-container-images).
@@ -256,7 +257,7 @@ skydive_analyzer_tag: wallaby-20220811T091848
256257

257258
## Updating container image tags in Kayobe configuration (Zed release onwards)
258259

259-
The image tags used deploy containers are defined in [etc/kayobe/kolla-image-tags.yml](https://github.com/stackhpc/stackhpc-kayobe-config/blob/stackhpc/zed/etc/kayobe/kolla-image-tags.yml).
260+
The image tags used deploy containers are defined in [etc/kayobe/kolla-image-tags.yml](https://github.com/stackhpc/stackhpc-kayobe-config/blob/stackhpc/2024.1/etc/kayobe/kolla-image-tags.yml).
260261
Currently updating these is a manual process.
261262

262263
Use the new tag from the [container image build](#building-container-images).
@@ -269,8 +270,8 @@ For example, to update the default tag for all images (used where no service-spe
269270
# where the key is the OS distro and the value is the tag to deploy.
270271
kolla_image_tags:
271272
openstack:
272-
rocky-9: zed-rocky-9-20230101T000000
273-
ubuntu-jammy: zed-ubuntu-jammy-20230101T000000
273+
rocky-9: 2024.1-rocky-9-20240101T000000
274+
ubuntu-jammy: 2024.1-ubuntu-jammy-20240101T000000
274275
```
275276

276277
Alternatively, update the tag for all containers in a service, e.g. for all `nova` containers:
@@ -281,11 +282,11 @@ Alternatively, update the tag for all containers in a service, e.g. for all `nov
281282
# where the key is the OS distro and the value is the tag to deploy.
282283
kolla_image_tags:
283284
openstack:
284-
rocky-9: zed-rocky-9-20230101T000000
285-
ubuntu-jammy: zed-ubuntu-jammy-20230101T000000
285+
rocky-9: 2024.1-rocky-9-20240101T000000
286+
ubuntu-jammy: 2024.1-ubuntu-jammy-20240101T000000
286287
nova:
287-
rocky-9: zed-rocky-9-20230102T000000
288-
ubuntu-jammy: zed-ubuntu-jammy-20230102T000000
288+
rocky-9: 2024.1-rocky-9-20240102T000000
289+
ubuntu-jammy: 2024.1-ubuntu-jammy-20240102T000000
289290
```
290291

291292
Alternatively, update the tag for a specific container, e.g. for the `nova_compute` container:
@@ -296,11 +297,11 @@ Alternatively, update the tag for a specific container, e.g. for the `nova_compu
296297
# where the key is the OS distro and the value is the tag to deploy.
297298
kolla_image_tags:
298299
openstack:
299-
rocky-9: zed-rocky-9-20230101T000000
300-
ubuntu-jammy: zed-ubuntu-jammy-20230101T000000
300+
rocky-9: 2024.1-rocky-9-20240101T000000
301+
ubuntu-jammy: 2024.1-ubuntu-jammy-20240101T000000
301302
nova_compute:
302-
rocky-9: zed-rocky-9-20230103T000000
303-
ubuntu-jammy: zed-ubuntu-jammy-20230103T000000
303+
rocky-9: 2024.1-rocky-9-20240103T000000
304+
ubuntu-jammy: 2024.1-ubuntu-jammy-20240103T000000
304305
```
305306

306307
## Promoting container images (Zed release onwards)

0 commit comments

Comments
 (0)