TELCODOCS-2484: Replacing SiteConfig with ClusterInstance #103872

rohennes · 2025-12-12T17:10:20Z

TELCODOCS-2484: Replacing SiteConfig with ClusterInstance

Version(s):
4.20+

Issue:
https://issues.redhat.com/browse/TELCODOCS-2484

Link to docs preview:
https://103872--ocpdocs-pr.netlify.app/openshift-enterprise/latest/edge_computing/ztp-deploying-far-edge-sites.html

QE review:

QE has approved this change.

Additional information:

openshift-ci-robot · 2025-12-12T17:10:25Z

@rohennes: This pull request references TELCODOCS-2484 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.22.0" version, but no target version was set.

Details

In response to this:

TELCODOCS-2484: Replacing SiteConfig with ClusterInstance

Version(s):
4.20+

Issue:
https://issues.redhat.com/browse/TELCODOCS-2484

Link to docs preview:

QE review:

QE has approved this change.

Additional information:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

openshift-ci-robot · 2025-12-12T17:10:32Z

@rohennes: This pull request references TELCODOCS-2484 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.22.0" version, but no target version was set.

Details

In response to this:

TELCODOCS-2484: Replacing SiteConfig with ClusterInstance

Version(s):
4.20+

Issue:
https://issues.redhat.com/browse/TELCODOCS-2484

Link to docs preview:

QE review:

QE has approved this change.

Additional information:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

ocpdocs-previewbot · 2025-12-12T17:19:06Z

🤖 Thu Dec 18 17:37:57 - Prow CI generated the docs preview:

https://103872--ocpdocs-pr.netlify.app/openshift-enterprise/latest/edge_computing/ztp-deploying-far-edge-clusters-at-scale.html
https://103872--ocpdocs-pr.netlify.app/openshift-enterprise/latest/edge_computing/ztp-deploying-far-edge-sites.html
https://103872--ocpdocs-pr.netlify.app/openshift-enterprise/latest/edge_computing/ztp-manual-install.html
https://103872--ocpdocs-pr.netlify.app/openshift-enterprise/latest/edge_computing/ztp-preparing-the-hub-cluster.html
https://103872--ocpdocs-pr.netlify.app/openshift-enterprise/latest/edge_computing/ztp-updating-gitops.html

openshift-ci-robot · 2025-12-17T16:45:57Z

@rohennes: This pull request references TELCODOCS-2484 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.22.0" version, but no target version was set.

Details

In response to this:

TELCODOCS-2484: Replacing SiteConfig with ClusterInstance

Version(s):
4.20+

Issue:
https://issues.redhat.com/browse/TELCODOCS-2484

Link to docs preview:
https://103872--ocpdocs-pr.netlify.app/openshift-enterprise/latest/edge_computing/ztp-deploying-far-edge-sites.html

QE review:

QE has approved this change.

Additional information:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

ocpdocs-vale-bot · 2025-12-18T11:43:32Z

edge_computing/ztp-deploying-far-edge-sites.adoc

@@ -1,6 +1,6 @@
 :_mod-docs-content-type: ASSEMBLY


🤖 [error] AsciiDocDITA.ShortDescription: Assign [role="_abstract"] to a paragraph to use it as in DITA.

ocpdocs-vale-bot · 2025-12-18T11:43:34Z

edge_computing/ztp-deploying-far-edge-sites.adoc

 .Additional resources

-* For information about removing a cluster, see link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.9/html/clusters/cluster_mce_overview#remove-managed-cluster[Removing a cluster from management].
+* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.9/html/clusters/cluster_mce_overview#remove-managed-cluster[Removing a cluster from management].


🤖 [error] AsciiDocDITA.RelatedLinks: Content other than links cannot be mapped to DITA related-links.

ocpdocs-vale-bot · 2025-12-18T11:43:40Z

modules/ztp-clusterinstance-config-reference.adoc

@@ -0,0 +1,203 @@
+// Module included in the following assemblies:


🤖 [error] AsciiDocDITA.ShortDescription: Assign [role="_abstract"] to a paragraph to use it as in DITA.

ocpdocs-vale-bot · 2025-12-18T11:43:48Z

modules/ztp-configuring-ipsec-using-ztp-and-siteconfig-for-mno.adoc

+generatorOptions:
+  disableNameSuffixHash: true <2>
+----
+<1> The namespace must match the `ClusterInstance` namespace.


🤖 [error] AsciiDocDITA.CalloutList: Callouts are not supported in DITA.

ocpdocs-vale-bot · 2025-12-18T11:43:49Z

modules/ztp-configuring-ipsec-using-ztp-and-siteconfig-for-mno.adoc

+    - name: ipsec-manifests-cm <1>
+# ...
 ----
+<1> Reference to the `ConfigMap` containing the IPsec certificate import manifests.


🤖 [error] AsciiDocDITA.CalloutList: Callouts are not supported in DITA.

ocpdocs-vale-bot · 2025-12-18T11:43:56Z

modules/ztp-configuring-ipsec-using-ztp-and-siteconfig.adoc

+generatorOptions:
+  disableNameSuffixHash: true <2>
+----
+<1> The namespace must match the `ClusterInstance` namespace.


🤖 [error] AsciiDocDITA.CalloutList: Callouts are not supported in DITA.

ocpdocs-vale-bot · 2025-12-18T11:43:57Z

modules/ztp-configuring-ipsec-using-ztp-and-siteconfig.adoc

+    - name: ipsec-manifests-cm <1>
+# ...
 ----
+<1> Reference to the `ConfigMap` containing the IPsec manifests.


🤖 [error] AsciiDocDITA.CalloutList: Callouts are not supported in DITA.

ocpdocs-vale-bot · 2025-12-18T11:44:02Z

modules/ztp-configuring-kernel-arguments-for-discovery-iso.adoc

+generatorOptions:
+  disableNameSuffixHash: true
 ----
+<1> The name of the `ClusterInstance` CR.


🤖 [error] AsciiDocDITA.CalloutList: Callouts are not supported in DITA.

ocpdocs-vale-bot · 2025-12-18T11:44:04Z

modules/ztp-configuring-kernel-arguments-for-discovery-iso.adoc

+      namespace: example-cluster
+# ...
+----
+<1> Reference to the `ConfigMap` CR that contains the custom `InfraEnv` CR template.


🤖 [error] AsciiDocDITA.CalloutList: Callouts are not supported in DITA.

ocpdocs-vale-bot · 2025-12-18T11:44:08Z

modules/ztp-creating-the-site-secrets.adoc

 type: kubernetes.io/dockerconfigjson
 ----
-<1> Must match the namespace configured in the related `SiteConfig` CR
+<1> Must match the namespace configured in the related `ClusterInstance` CR


🤖 [error] AsciiDocDITA.CalloutList: Callouts are not supported in DITA.

ocpdocs-vale-bot · 2025-12-18T11:44:19Z

modules/ztp-deploying-user-defined-firmware-configuration-with-gitops-ztp.adoc

-====
-Where possible, use a single `SiteConfig` CR per cluster.
-====
+<1> The namespace must match the `ClusterInstance` namespace.


🤖 [error] AsciiDocDITA.CalloutList: Callouts are not supported in DITA.

ocpdocs-vale-bot · 2025-12-18T11:44:21Z

modules/ztp-deploying-user-defined-firmware-configuration-with-gitops-ztp.adoc

+      # ...
 ----
-<1> Applies to all hosts in the `cluster-1` cluster
+<1> Applies the firmware profile to all hosts in the cluster.


🤖 [error] AsciiDocDITA.CalloutList: Callouts are not supported in DITA.

ocpdocs-vale-bot · 2025-12-18T11:44:23Z

modules/ztp-deploying-user-defined-firmware-configuration-with-gitops-ztp.adoc

+      # ...
 ----
-<1> Applies the firmware profile to the `compute-1.example.com` host in the cluster
+<1> Applies the firmware profile only to the `node1.example.com` host.


🤖 [error] AsciiDocDITA.CalloutList: Callouts are not supported in DITA.

ocpdocs-vale-bot · 2025-12-18T11:44:33Z

modules/ztp-preparing-the-ztp-git-repository-ver-ind.adoc

+. Create ConfigMaps from the manifest directories and reference them in the `ClusterInstance` CR using the `extraManifestsRefs` field.
 +
-.Example SiteConfig CR
+.Example kustomization.yaml with configMapGenerator


🤖 [error] AsciiDocDITA.BlockTitle: Block titles can only be assigned to examples, figures, and tables in DITA.

ocpdocs-vale-bot · 2025-12-18T11:44:35Z

modules/ztp-preparing-the-ztp-git-repository-ver-ind.adoc

+generatorOptions:
+  disableNameSuffixHash: true
+----
+<1> Extra manifest files from the `ztp-site-generate` container.


🤖 [error] AsciiDocDITA.CalloutList: Callouts are not supported in DITA.

ocpdocs-vale-bot · 2025-12-18T11:44:36Z

modules/ztp-preparing-the-ztp-git-repository-ver-ind.adoc

+
+. Edit the `ClusterInstance` CR to reference the `ConfigMap` CR:
+
+.Example ClusterInstance CR


🤖 [error] AsciiDocDITA.BlockTitle: Block titles can only be assigned to examples, figures, and tables in DITA.

ocpdocs-vale-bot · 2025-12-18T11:44:38Z

modules/ztp-preparing-the-ztp-git-repository-ver-ind.adoc

 ----
-<1>  The directory containing the reference manifests must be listed first under `extraManifests.searchPaths`.
-<2>  If you are using user-provided CRs, the last directory listed under `extraManifests.searchPaths` in the `SiteConfig` CR must be the directory containing those user-provided CRs.
+<1> Reference the ConfigMap containing the extra manifests.


🤖 [error] AsciiDocDITA.CalloutList: Callouts are not supported in DITA.

openshift-ci · 2025-12-18T17:39:41Z

@rohennes: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Dec 12, 2025

openshift-ci bot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Dec 12, 2025

rohennes force-pushed the TELCODOCS-2484 branch 3 times, most recently from 335ebb9 to 8199473 Compare December 17, 2025 16:29

rohennes force-pushed the TELCODOCS-2484 branch from 8199473 to c88cfd2 Compare December 18, 2025 11:33

openshift-ci bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Dec 18, 2025

ocpdocs-vale-bot reviewed Dec 18, 2025

View reviewed changes

TELCODOCS-2484: Replacing SiteConfig with ClusterInstance

5752f6e

rohennes force-pushed the TELCODOCS-2484 branch from c88cfd2 to 5752f6e Compare December 18, 2025 17:29

		@@ -0,0 +1,203 @@
		// Module included in the following assemblies:

TELCODOCS-2484: Replacing SiteConfig with ClusterInstance #103872

Are you sure you want to change the base?

TELCODOCS-2484: Replacing SiteConfig with ClusterInstance #103872

Uh oh!

Conversation

rohennes commented Dec 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-ci-robot commented Dec 12, 2025 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-ci-robot commented Dec 12, 2025 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ocpdocs-previewbot commented Dec 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-ci-robot commented Dec 17, 2025 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

openshift-ci bot commented Dec 18, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

rohennes commented Dec 12, 2025 •

edited

Loading

openshift-ci-robot commented Dec 12, 2025 •

edited by openshift-ci bot

Loading

openshift-ci-robot commented Dec 12, 2025 •

edited by openshift-ci bot

Loading

ocpdocs-previewbot commented Dec 12, 2025 •

edited

Loading

openshift-ci-robot commented Dec 17, 2025 •

edited by openshift-ci bot

Loading