[WIP] TELCODOCS-1540: Installing SNO clusters with the SiteConfig Operator

_attributes/common-attributes.adoc

@@ -236,6 +236,8 @@ endif::[]
 :rh-dev-hub: Red Hat Developer Hub
 //IBU
 :lcao: Lifecycle Agent
+//SiteConfig Operator
+:sco: SiteConfig Operator
 
 
 

_topic_maps/_topic_map.yml

@@ -3194,6 +3194,43 @@ Topics:
 #     File: telco-core-ref-design-components
 #   - Name: Core reference design configuration CRs
 #     File: telco-core-ref-crs
+- Name: Installing single-node OpenShift clusters with the SiteConfig Operator
+  Dir: installing_with_siteconfig_operator
+  Distros: openshift-origin,openshift-enterprise
+  Topics:
+  - Name: Understanding the SiteConfig Operator
+    File: cnf-understanding-siteconfig-operator
+---
+Name: Reference design specifications
+Dir: telco_ref_design_specs
+Distros: openshift-telco
+Topics:
+- Name: Telco reference design specifications
+  File: telco-ref-design-specs-overview
+- Name: Telco RAN DU reference design specification
+  Dir: ran
+  Topics:
+  - Name: Telco RAN DU reference design overview
+    File: telco-ran-ref-design-spec
+  - Name: Telco RAN DU use model overview
+    File: telco-ran-du-overview
+  - Name: RAN DU reference design components
+    File: telco-ran-ref-du-components
+  - Name: RAN DU reference design configuration CRs
+    File: telco-ran-ref-du-crs
+  - Name: Telco RAN DU software specifications
+    File: telco-ran-ref-software-artifacts
+- Name: Telco core reference design specification
+  Dir: core
+  Topics:
+  - Name: Telco core reference design overview
+    File: telco-core-rds-overview
+  - Name: Telco core use model overview
+    File: telco-core-rds-use-cases
+  - Name: Core reference design components
+    File: telco-core-ref-design-components
+  - Name: Core reference design configuration CRs
+    File: telco-core-ref-crs
 ---
 Name: Specialized hardware and driver enablement
 Dir: hardware_enablement

edge_computing/installing_with_siteconfig_operator/_attributes

@@ -0,0 +1 @@
+../../_attributes/

edge_computing/installing_with_siteconfig_operator/cnf-understanding-siteconfig-operator.adoc

@@ -0,0 +1,62 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="cnf-understanding-siteconfig-operator"]
+= Understanding the {sco}
+include::_attributes/common-attributes.adoc[]
+:context: siteconfig-operator
+
+toc::[]
+
+With the {sco}, you can deploy clusters with all available installation methods.
+The {sco} introduces a unified `ClusterInstance` API, which is derived from the `SiteConfig` API from the SiteConfig Generator kustomize plugin.
+For example, the `ClusterInstance` API decouples parameters that define a cluster from the manner in which the cluster is deployed.
+This separation removes certain limitations that are presented by the `SiteConfig` kustomize plugin in the current xref:../../edge_computing/ztp-deploying-far-edge-sites.adoc#ztp-deploying-far-edge-sites[{ztp-first} flow], such as agent cluster installations and scalability constraints posed by ArgoCD.
+Using the unified `ClusterInstance` API, the {sco} offers the following improvements:
+
+Isolation:: Separates cluster definition from the installation method. The `ClusterInstance` CR captures the cluster definition, while cluster templates capture the cluster architecture and installation methods.
+Unification:: The {sco} unifies both Git and non-Git workflows. Users can apply the `ClusterInstance` CR directly on the hub cluster or synchronize them through a GitOps solution, like ArgoCD.
+Consistency:: Maintains a consistent API across all installation methods, whether using the Assisted Installer, the Image Based Install Operator, or any other custom template-based approach.
+Scalability:: Achieves greater scalability per cluster than the `SiteConfig` kustomize plugin.
+Flexibility:: Provides users with more power to deploy and install clusters by using custom cluster templates.
+Troubleshooting:: Offers insightful information regarding cluster deployment status and rendered manifests, significantly enhancing the troubleshooting experience.
+
+[role="_additional-resources"]
+.Additional resources
+
+* https://access.redhat.com/articles/7075493[Image-based installations for {sno}]
+
+* xref:../../installing/installing_on_prem_assisted/installing-on-prem-assisted.adoc#installing-on-prem-assisted[Installing an on-premise cluster using the {ai-full}]
+
+include::modules/cnf-understanding-siteconfig-operator-flow.adoc[leveloffset=+1]
+
+include::modules/cnf-clusterinstance-cr-reference.adoc[leveloffset=+1]
+
+include::modules/cnf-clusterinstance-cr-spec-config-parameters.adoc[leveloffset=+2]
+
+[role="_additional-resources"]
+.Additional resources
+
+* xref:../../installing/installing_bare_metal_ipi/ipi-install-installation-workflow.adoc#bmc-addressing_ipi-install-installation-workflow[BMC addressing]
+
+include::modules/cnf-cluster-instance-cr-conditions-reference.adoc[leveloffset=+2]
+
+include::modules/cnf-understanding-cluster-templates.adoc[leveloffset=+1]
+
+include::modules/cnf-creating-custom-cluster-templates.adoc[leveloffset=+2]
+
+include::modules/cnf-deploying-siteconfig-operator.adoc[leveloffset=+1]
+
+include::modules/cnf-installing-clusters.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+
+[role="_additional-resources"]
+.Additional resources
+
+* https://access.redhat.com/articles/7075493[Image-based installations for {sno}]
+
+* xref:../../installing/installing_on_prem_assisted/installing-on-prem-assisted.adoc#installing-on-prem-assisted[Installing an on-premise cluster using the {ai-full}]
+
+* xref::../../edge_computing/installing_with_siteconfig_operator/cnf-understanding-siteconfig-operator#cnf-clusterinstance-conditions-reference_siteconfig-operator[ClusterInstance CR conditions]
+
+include::modules/cnf-deprovisioning-clusters.adoc[leveloffset=+1]

edge_computing/installing_with_siteconfig_operator/images

@@ -0,0 +1 @@
+../../images/

edge_computing/installing_with_siteconfig_operator/modules

@@ -0,0 +1 @@
+../../modules/

edge_computing/installing_with_siteconfig_operator/snippets

@@ -0,0 +1 @@
+../../snippets/

modules/cnf-cluster-instance-cr-conditions-reference.adoc

@@ -0,0 +1,57 @@
+// Module included in the following assemblies:
+//
+// * edge_computing/installing_with_siteconfig_operator/cnf-understanding-siteconfig-operator.adoc
+
+:_mod-docs-content-type: REFERENCE
+[id="cnf-clusterinstance-conditions-reference_{context}"]
+= ClusterInstance CR conditions
+
+The {sco} sets the status conditions in the `ClusterInstance` CR that you can use for monitoring and troubleshooting throughout the process.
+While creating and validating the resources that are required for provisioning, you can encounter the following status conditions:
+
+.ClusterInstance CR status conditions
+[cols="2", options="header"]
+|====
+
+|Condition
+|Description
+
+|`ClusterInstanceValidated`
+|Indicates that the {sco} validated the `ClusterInstance` `spec` fields and verified that the required artifacts, such as secrets and extra manifest `ConfigMaps` objects are present.
+
+|`RenderedTemplates`
+|Indicates that {sco} successfully validated the referenced Golang cluster templates.
+
+|`RenderedTemplatesValidated`
+|Indicates that the {sco} rendered the installation manifests and the dry run was successful.
+
+|`RenderedTemplatesApplied`
+|Indicates that the {sco} created the installation manifests and the underlying Operators consumed them.
+
+|`Provisioned`
+|Indicates that the underlying Operators are provisioning the clusters.
+
+|====
+
+After starting the provisioning of a cluster, you can encounter the following deployment status conditions:
+
+.Cluster deployment status conditions
+[cols="2", options="header"]
+|====
+
+|Condition
+|Description
+
+|`ClusterInstallRequirementsMet`
+|Indicates that the installation can start.
+
+|`ClusterInstallCompleted`
+|Indicates that the cluster installation was successful.
+
+|`ClusterInstallFailed`
+|Indicates that the cluster installation failed.
+
+|`ClusterInstallStopped`
+|Indicates that the cluster installation stopped.
+
+|====

modules/cnf-clusterinstance-cr-reference.adoc

@@ -0,0 +1,13 @@
+
+// Module included in the following assemblies:
+//
+// * edge_computing/installing_with_siteconfig_operator/cnf-understanding-siteconfig-operator.adoc
+
+:_mod-docs-content-type: REFERENCE
+[id="cnf-clusterinstance-CR-reference_{context}"]
+= Reference ClusterInstance CR
+
+The following example shows a `ClusterInstance` CR using the default Assisted Installer templates:
+
+include::snippets/cnf-clusterinstance-cr.adoc[]
+