TELCODOCS-2484: Replacing SiteConfig with ClusterInstance #103872
+695
−340
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,203 @@ | ||
| // Module included in the following assemblies: | ||
|
Collaborator
There was a problem hiding this comment. 🤖 [error] AsciiDocDITA.ShortDescription: Assign [role="_abstract"] to a paragraph to use it as in DITA. |
||
| // | ||
| // * scalability_and_performance/ztp_far_edge/ztp-deploying-far-edge-sites.adoc | ||
|
|
||
| :_mod-docs-content-type: REFERENCE | ||
| [id="ztp-clusterinstance-config-reference_{context}"] | ||
| = ClusterInstance CR installation reference | ||
|
|
||
| The following tables describe the cluster-level and node-level `ClusterInstance` custom resource (CR) fields used for cluster installation. | ||
|
|
||
| == Cluster-level ClusterInstance CR fields | ||
|
|
||
| .ClusterInstance CR cluster-level fields | ||
| [cols="1,3", options="header"] | ||
| |==== | ||
| |ClusterInstance CR field | ||
| |Description | ||
|
|
||
| |`spec.clusterName` | ||
| | The name of the cluster. | ||
|
|
||
| |`spec.baseDomain` | ||
| |The base domain to use for the deployed cluster. | ||
|
|
||
| |`spec.pullSecretRef.name` | ||
| |The name of the secret containing the pull secret to use when pulling images. The secret must exist in the same namespace as the `ClusterInstance` CR. | ||
|
|
||
| |`spec.clusterImageSetNameRef` | ||
| |The name of the `ClusterImageSet` resource indicating which {product-title} version to deploy. | ||
|
|
||
| |`spec.sshPublicKey` | ||
| |Optional. The public SSH key to authenticate SSH access to the cluster nodes. | ||
|
|
||
| |`spec.templateRefs` | ||
| a|A list of references to cluster-level templates. A cluster-level template consists of a `ConfigMap` in which the keys of the data field represent the kind of the installation manifest(s). Cluster-level templates are instantiated once per cluster. | ||
|
|
||
| |`spec.extraLabels` | ||
| a|Optional. Additional cluster-wide labels to be applied to the rendered templates. This is a nested map structure where the outer key is the resource type (for example, `ManagedCluster`) and the inner map contains the label key-value pairs. | ||
|
|
||
| |`spec.extraAnnotations` | ||
| |Optional. Additional cluster-wide annotations to be applied to the rendered templates. Uses the same nested map structure as `extraLabels`. | ||
|
|
||
| |`spec.extraManifestsRefs` | ||
| a|Optional. A list of `ConfigMap` references containing additional manifests to be applied to the cluster at install time. Manifests must be bundled in `ConfigMap` resources. | ||
|
|
||
| |`spec.suppressedManifests` | ||
| |Optional. A list of manifest names to be excluded from the template rendering process by the SiteConfig Operator. | ||
|
|
||
| |`spec.pruneManifests` | ||
| a|Optional. A list of manifests to remove. Each entry requires `apiVersion` and `kind`. | ||
|
|
||
| |`spec.installConfigOverrides` | ||
| a|Optional. A JSON formatted string that provides a generic way of passing `install-config` parameters. | ||
|
|
||
| [IMPORTANT] | ||
| ==== | ||
| Use the reference configuration as specified in the example `ClusterInstance` CR. Adding additional components back into the system might require additional reserved CPU capacity. | ||
| ==== | ||
| // TODO: Is this note still relevant? | ||
|
|
||
| |`spec.cpuPartitioningMode` | ||
| |Optional. Configure workload partitioning by setting the value to `AllNodes`. The default is `None`. To complete the configuration, specify the `isolated` and `reserved` CPUs in the `PerformanceProfile` CR. | ||
|
|
||
| |`spec.networkType` | ||
| |Optional. The Container Network Interface (CNI) plug-in to install. Valid values are `OpenShiftSDN` or `OVNKubernetes`. The default is `OVNKubernetes`. | ||
|
|
||
| |`spec.clusterNetwork` | ||
| a|Optional. The list of IP address pools for pods. | ||
|
|
||
| |`spec.machineNetwork` | ||
| a|Optional. The list of IP address pools for machines. | ||
|
|
||
| |`spec.serviceNetwork` | ||
| a|Optional. The list of IP address pools for services. | ||
|
|
||
| |`spec.apiVIPs` | ||
| |Optional. The virtual IPs used to reach the OpenShift cluster API. Enter one IP address for single-stack clusters, or up to two for dual-stack clusters. | ||
|
|
||
| |`spec.ingressVIPs` | ||
| |Optional. The virtual IPs used for cluster ingress traffic. Enter one IP address for single-stack clusters, or up to two for dual-stack clusters. | ||
|
|
||
| |`spec.additionalNTPSources` | ||
| |Optional. A list of NTP sources (hostname or IP) to be added to all cluster hosts. | ||
|
|
||
| |`spec.diskEncryption` | ||
| a|Optional. Configure this field to enable disk encryption for cluster nodes | ||
|
|
||
| |`spec.diskEncryption.type` | ||
| |Set the disk encryption type. | ||
|
|
||
| |`spec.diskEncryption.tang` | ||
| |Optional. Configure Tang server settings for disk encryption. | ||
|
|
||
| |`spec.proxy` | ||
| |Optional. Configure proxy settings that you want to use for the install config. | ||
|
|
||
| |`spec.caBundleRef` | ||
| |Optional. Reference to a `ConfigMap` containing the bundle of trusted certificates for the host. This field is referenced by image-based installations only. | ||
| // TODO: Is this correct? I got it from a matrix in the slidedeck. | ||
|
|
||
| |`spec.platformType` | ||
| |Optional. The name for the platform for the installation. Valid values are `BareMetal`, `None`, `VSphere`, `Nutanix`, or `External`. | ||
|
|
||
| |`spec.cpuArchitecture` | ||
| |Optional. The software architecture used for nodes that do not have an architecture defined. Valid values are `x86_64`, `aarch64`, or `multi`. The default is `x86_64`. | ||
|
|
||
| |`spec.clusterType` | ||
| |Optional. The type of cluster. Valid values are `SNO`, `HighlyAvailable`, `HostedControlPlane`, or `HighlyAvailableArbiter`. | ||
|
|
||
| |`spec.holdInstallation` | ||
| |Optional. When set to `true`, prevents installation from happening. Inspection and validation proceed as usual, but installation does not begin until this field is set to `false`. The default is `false`. | ||
|
|
||
| |`spec.ignitionConfigOverride` | ||
| |Optional. A JSON formatted string containing the user overrides for the ignition config. | ||
|
|
||
| |`spec.reinstall` | ||
| |Optional. Configuration for reinstallation of the cluster. Includes `generation` and `preservationMode` fields. | ||
| |==== | ||
|
|
||
| == Node-level ClusterInstance CR fields | ||
|
|
||
| .ClusterInstance CR node-level fields | ||
| [cols="1,3", options="header"] | ||
| |==== | ||
| |ClusterInstance CR field | ||
| |Description | ||
|
|
||
| |`spec.nodes` | ||
| |A list of node objects defining the hosts in the cluster. | ||
|
|
||
| |`spec.nodes[].hostName` | ||
| |The desired hostname for the host. For single-node deployments, define a single host. For three-node deployments, define three hosts. For standard deployments, define three hosts with `role: master` and two or more hosts with `role: worker`. | ||
| // TODO: Is the additional naming guidance still valid? It was in the SiteConfig resource reference for this field previously. | ||
|
|
||
| |`spec.nodes[].role` | ||
| |Optional. The role of the node. Valid values are `master`, `worker`, or `arbiter`. The default is `master`. | ||
|
|
||
| |`spec.nodes[].bmcAddress` | ||
| a|The BMC address used to access the host. {ztp} supports iPXE and virtual media booting by using Redfish or IPMI protocols. For more information about BMC addressing, see the "Additional resources" section. | ||
|
|
||
| [NOTE] | ||
| ==== | ||
| In far edge Telco use cases, only virtual media is supported for use with {ztp}. | ||
| ==== | ||
|
|
||
| |`spec.nodes[].bmcCredentialsName.name` | ||
| |The name of the `Secret` CR containing the BMC credentials. When creating the secret, use the same namespace as the `ClusterInstance` CR. | ||
|
|
||
| |`spec.nodes[].bootMACAddress` | ||
| |The MAC address used for PXE boot. | ||
|
|
||
| |`spec.nodes[].bootMode` | ||
| |Optional. The boot mode for the host. The default value is `UEFI`. Use `UEFISecureBoot` to enable secure boot on the host. | ||
|
|
||
| |`spec.nodes[].rootDeviceHints` | ||
| |Optional. Specifies the device for deployment. Use disk identifiers that are stable across reboots. For example, `wwn: <disk_wwn>` or `deviceName: /dev/disk/by-path/<device_path>`. For a detailed list of stable identifiers, see the "About root device hints" section. | ||
|
|
||
| |`spec.nodes[].automatedCleaningMode` | ||
| |Optional. When set to `disabled`, the provisioning service does not automatically clean the disk during provisioning and deprovisioning. Set the value to `metadata` to remove the disk's partitioning table only, without fully wiping the disk. The default value is `disabled`. | ||
|
|
||
| |`spec.nodes[].nodeNetwork` | ||
| |Optional. Configure the network settings for the node. | ||
|
|
||
| |`spec.nodes[].nodeNetwork.interfaces` | ||
| |Optional. Configure the network interfaces for the node. | ||
|
|
||
| |`spec.nodes[].nodeNetwork.config` | ||
| |Optional. Configure the NMState network configuration for the node, including interfaces, DNS, and routes. | ||
|
|
||
| |`spec.nodes[].nodeLabels` | ||
| |Optional. Specify custom roles for your nodes in your managed clusters. These are additional roles not used by any {product-title} components. When you add a custom role, it can be associated with a custom machine config pool that references a specific configuration for that role. Adding custom labels or roles during installation makes the deployment process more effective and prevents the need for additional reboots after the installation is complete. | ||
|
|
||
| |`spec.nodes[].ignitionConfigOverride` | ||
| |Optional. A JSON formatted string containing the overrides for the host's ignition config. Use this field to assign partitions for persistent storage. Adjust the disk ID and size to the specific hardware. | ||
|
|
||
| |`spec.nodes[].installerArgs` | ||
| |Optional. A JSON formatted string containing the user overrides for the host's CoreOS installer args. | ||
|
|
||
| |`spec.nodes[].templateRefs` | ||
| a|A list of references to node-level templates. A node-level template consists of a `ConfigMap` in which the keys of the data field represent the kind of the installation manifests. Node-level templates are instantiated once for each node. | ||
|
|
||
| |`spec.nodes[].extraLabels` | ||
| |Optional. Additional node-level labels to be applied to the rendered templates. Uses the same nested map structure as the cluster-level `extraLabels`. | ||
|
|
||
| |`spec.nodes[].extraAnnotations` | ||
| |Optional. Additional node-level annotations to be applied to the rendered templates. | ||
|
|
||
| |`spec.nodes[].suppressedManifests` | ||
| |Optional. A list of node-level manifest names to be excluded from the template rendering process. | ||
|
|
||
| |`spec.nodes[].pruneManifests` | ||
| |Optional. A list of mode-level manifests to remove. Each entry requires `apiVersion` and `kind`. | ||
|
|
||
| |`spec.nodes[].cpuArchitecture` | ||
| |Optional. The software architecture of the node. If you do not define a value, the value is inherited from `spec.cpuArchitecture`. Valid values are `x86_64` or `aarch64`. | ||
|
|
||
| |`spec.nodes[].ironicInspect` | ||
| |Optional. Disable automatic introspection during registration of the BMH by specifying `disabled` for this field. Automatic introspection by the provisioning service is enabled by default. | ||
|
|
||
| |`spec.nodes[].hostRef` | ||
| |Optional. Reference to an existing `BareMetalHost` resource located in another namespace. Includes `name` and `namespace` fields. | ||
| |==== | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🤖 [error] AsciiDocDITA.ShortDescription: Assign [role="_abstract"] to a paragraph to use it as in DITA.