Merge pull request #87629 from sr1kar99/2136-deprecation-of-siteconfig-v1

TELCODOCS#2136: Deprecation of SiteConfig v1

Author: xenolinux

edge_computing/ztp-advanced-install-ztp.adoc

@@ -8,6 +8,8 @@ toc::[]
 
 You can use `SiteConfig` custom resources (CRs) to deploy custom functionality and configurations in your managed clusters at installation time.
 
+include::snippets/siteconfig-deprecation-notice.adoc[]
+
 include::modules/ztp-customizing-the-install-extra-manifests.adoc[leveloffset=+1]
 
 include::modules/ztp-filtering-ai-crs-using-siteconfig.adoc[leveloffset=+1]

modules/ztp-creating-ztp-crs-for-multiple-managed-clusters.adoc

@@ -15,3 +15,5 @@ You can provision single clusters manually or in batches with {ztp}:
 Provisioning a single cluster:: Create a single `SiteConfig` CR and related installation and configuration CRs for the cluster, and apply them in the hub cluster to begin cluster provisioning. This is a good way to test your CRs before deploying on a larger scale.
 
 Provisioning many clusters:: Install managed clusters in batches of up to 400 by defining `SiteConfig` and related CRs in a Git repository. ArgoCD uses the `SiteConfig` CRs to deploy the sites. The {rh-rhacm} policy generator creates the manifests and applies them to the hub cluster. This starts the cluster provisioning process.
+
+include::snippets/siteconfig-deprecation-notice.adoc[]

modules/ztp-deploying-a-site.adoc

@@ -8,6 +8,8 @@
 
 Use the following procedure to create a `SiteConfig` custom resource (CR) and related files and initiate the {ztp-first} cluster deployment.
 
+include::snippets/siteconfig-deprecation-notice.adoc[]
+
 .Prerequisites
 
 * You have installed the OpenShift CLI (`oc`).

modules/ztp-generating-install-and-config-crs-manually.adoc

@@ -8,6 +8,8 @@
 
 Use the `generator` entrypoint for the `ztp-site-generate` container to generate the site installation and configuration custom resource (CRs) for a cluster based on `SiteConfig` and `{policy-gen-cr}` CRs.
 
+include::snippets/siteconfig-deprecation-notice.adoc[]
+
 .Prerequisites
 
 * You have installed the OpenShift CLI (`oc`).

modules/ztp-precaching-ztp-config.adoc

@@ -13,6 +13,8 @@ In the {ztp-first} provisioning workflow, the {factory-prestaging-tool} requires
 * `nodes.installerArgs`
 * `nodes.ignitionConfigOverride`
 
+include::snippets/siteconfig-deprecation-notice.adoc[]
+
 .Example SiteConfig with additional fields
 [source,yaml]
 ----

snippets/siteconfig-deprecation-notice.adoc

@@ -0,0 +1,7 @@
+:_mod-docs-content-type: SNIPPET
+[IMPORTANT]
+====
+SiteConfig v1 is deprecated starting with {product-title} version 4.18. Equivalent and improved functionality is now available through the SiteConfig Operator using the `ClusterInstance` custom resource. For more information, see link:https://access.redhat.com/articles/7105238[Procedure to transition from SiteConfig CRs to the ClusterInstance API].
+
+For more information about the SiteConfig Operator, see link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.12/html-single/multicluster_engine_operator_with_red_hat_advanced_cluster_management/index#siteconfig-intro[SiteConfig].
+====