Skip to content

TELCODOCS-2675: Fixes for cnf-image-based-upgrade-generate-seed #106477

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rohennes wants to merge 1 commit into
base: main
Choose a base branch
from
Open

TELCODOCS-2675: Fixes for cnf-image-based-upgrade-generate-seed #106477

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 21 additions & 12 deletions modules/cnf-image-based-upgrade-generate-seed-image.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
[id="cnf-image-based-upgrade-generate-seed-image_{context}"]
= Generating a seed image with the {lcao}

[role="_abstract"]
Use the {lcao} to generate a seed image from a managed cluster. The Operator checks for required system configurations, performs any necessary system cleanup before generating the seed image, and launches the image generation. The seed image generation includes the following tasks:

* Stopping cluster Operators
Expand Down Expand Up @@ -102,10 +103,13 @@ metadata:
namespace: openshift-lifecycle-agent
type: Opaque
data:
seedAuth: <encoded_AUTHFILE> <2>
seedAuth: <encoded_AUTHFILE>
----
<1> The `Secret` resource must have the `name: seedgen` and `namespace: openshift-lifecycle-agent` fields.
<2> Specifies a base64-encoded authfile for write-access to the registry for pushing the generated seed images.
+
Where:
+
* `name: seedgen` and `namespace: openshift-lifecycle-agent`: The `Secret` resource must have these fields.
* `seedAuth`: Specifies a base64-encoded authfile for write-access to the registry for pushing the generated seed images.
+
.. Apply the `Secret` by running the following command:
+
Expand All @@ -123,10 +127,13 @@ kind: SeedGenerator
metadata:
name: seedimage <1>
spec:
seedImage: <seed_container_image> <2>
seedImage: <seed_container_image>
----
<1> The `SeedGenerator` CR must be named `seedimage`.
<2> Specify the container image URL, for example, `quay.io/example/seed-container-image:<tag>`. It is recommended to use the `<seed_cluster_name>:<ocp_version>` format.
+
Where:
+
* `name: seedimage`: The `SeedGenerator` CR must be named `seedimage`.
* `seedImage`: Specify the container image URL, for example, `quay.io/example/seed-container-image:<tag>`. It is recommended to use the `<seed_cluster_name>:<ocp_version>` format.

. Generate the seed image by running the following command:
+
Expand All @@ -141,8 +148,6 @@ The cluster reboots and loses API capabilities while the {lcao} generates the se
Applying the `SeedGenerator` CR stops the `kubelet` and the CRI-O operations, then it starts the image generation.
====

If you want to generate more seed images, you must provision a new seed cluster with the version that you want to generate a seed image from.

.Verification

* After the cluster recovers and it is available, you can check the status of the `SeedGenerator` CR by running the following command:
Expand All @@ -151,8 +156,9 @@ If you want to generate more seed images, you must provision a new seed cluster
----
$ oc get seedgenerator -o yaml
----

.Example output
+
Example output:
+
[source,yaml]
----
status:
Expand All @@ -168,7 +174,10 @@ status:
observedGeneration: 1
reason: Completed
status: "True"
type: SeedGenCompleted <1>
type: SeedGenCompleted
observedGeneration: 1
----
<1> The seed image generation is complete.
+
The `SeedGenCompleted` type indicates that the seed image generation is complete.
+
If you want to generate more seed images, you must provision a new seed cluster with the version that you want to generate a seed image from.
4 changes: 3 additions & 1 deletion modules/cnf-image-based-upgrade-seed-image-config.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,19 @@ ifeval::["{context}" == "generate-seed"]
:ibu:
endif::[]

:_mod-docs-content-type: PROCEDURE
:_mod-docs-content-type: REFERENCE
[id="cnf-image-based-upgrade-seed-image-config_{context}"]
= Seed image configuration

ifdef::ibu[]
[role="_abstract"]
The seed image targets a set of {sno} clusters with the same hardware and similar configuration.
This means that the seed image must have all of the components and configuration that the seed cluster shares with the target clusters.
Therefore, the seed image generated from the seed cluster cannot contain any cluster-specific configuration.
endif::[]

ifdef::ibi[]
[role="_abstract"]
You can create a seed image from a {sno} cluster with the same hardware as your bare-metal host, and with a similar target cluster configuration. However, the seed image generated from the seed cluster cannot contain any cluster-specific configuration.
endif::[]

Expand Down