APIs

apiVersion
required

The versioned schema of the ManagedCluster.

string

kind
required

String value that represents the REST resource.

string

metadata
required

The metadata of the ManagedCluster.

object

spec
required

The specification of the ManagedCluster.

spec

hubAcceptsClient
required

Specifies whether the hub can establish a connection with the klusterlet agent on the managed cluster. The default value is false, and can only be changed to true when you have an RBAC rule configured on the hub cluster that allows you to make updates to the virtual subresource of managedclusters/accept.

bool

managedClusterClientConfigs
optional

Lists the apiserver addresses of the managed cluster.

managedClusterClientConfigs array

leaseDurationSeconds
optional

Specifies the lease update time interval of the klusterlet agents on the managed cluster. By default, the klusterlet agent updates its lease every 60 seconds.

integer (int32)

taints
optional

Prevents a managed cluster from being assigned to one or more managed cluster sets during scheduling.

taint array

URL
required

string

CABundle
optional

Pattern :

"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"

string (byte)

key
required

The taint key that is applied to a cluster.

string

value
optional

The taint value that corresponds to the taint key.

string

effect
optional

Effect of the taint on placements that do not tolerate the taint. Valid values are NoSelect, PreferNoSelect, and NoSelectIfNew.

string

apiVersion
required

The versioned schema of the ClusterInstance.

string

kind
required

String value that represents the REST resource.

string

metadata
required

The metadata of the ClusterInstance.

object

spec
required

The specification of the ClusterInstance.

spec

status
required

The status of the ClusterInstance.

status object

additionalNTPSources
optional

Specify the NTP sources that needs to be added to all cluster hosts. They are added to any NTP sources that were configured through other means.

array

baseDomain
required

Specify the base domain used for the deployed cluster.

string

caBundleRef
optional

Reference the ConfigMap object that contains the new bundle of trusted certificates for the host. The tls-ca-bundle.pem entry in the ConfigMap object is written to /etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem.

string

clusterName
required

Specify the name of the cluster.

string

clusterNetwork
optional

Specify the list of the IP address pools for pods.

array

clusterType
optional

Specify the cluster type. The following values are supported:

string

cpuPartitioningMode
optional

Determine clusters to be set up for CPU workload partitioning at install time. Configure workload partitioning by setting the value for cpuPartitioningMode to AllNodes. To complete the configuration, specify the isolated and reserved CPUs in the PerformanceProfile CR. The default value is None.

string

diskEncryption
optional

Enable or disable disk encryption for the cluster.

object

extraAnnotations
optional

Specify additional cluster-level annotations to be applied to the rendered templates by using the following format:

extraAnnotations:
  ClusterDeployment:
    myClusterAnnotation: success

object

extraLabels
optional

Specify additional cluster-level labels to be applied to the rendered templates by using the following format:

extraLabels:
  ManagedCluster:
    common: "true"
    label-a : "value-a"

object

extraManifestsRefs
optional

Specify the list of the ConfigMap object references that contain additional manifests to be applied to the cluster.

array

holdInstallation
optional

Set to true to prevent installation when using the Assisted Installer. You can complete the inspection and validation steps, but after the RequirementsMet condition becomes true, the installation does not begin until the holdInstallation field is set to false.

bool

ignitionConfigOverride
optional

Specify the user overrides for the initial Ignition configuration.

string

installConfigOverrides
optional

Define install configuration parameters.

string

machineNetwork
optional

Specify the list of the IP address pools for machines.

array

networkType
optional

Specify the Container Network Interface (CNI) plugin to install. The default value is OpenShiftSDN for IPv4, and OVNKubernetes for IPv6 or single-node OpenShift clusters.

string

platformType
optional

Define the name of the specific platform on which you want to install. The following values are supported:

string

proxy
optional

Define the proxy settings used for the install configuration of the cluster.

object

pruneManifests
optional

Define a list of cluster-level manifests to remove by specifying their apiVersion and Kind values.

array

pullSecretRef
required

Configure the pull-secret file for pulling images. When creating the pull-secret file, use the same namespace as the ClusterInstance CR that provisions the host.

object

serviceNetwork
optional

Specify the list of the IP address pools for services.

array

sshPublicKey
optional

Specify the public Secure Shell (SSH) key to provide access to instances. This key is added to the host to allow SSH access.

string

nodes
required

Specify the configuration parameters for each node.

nodes array

templateRefs
required

Specify the list of the references to cluster-level templates. A cluster-level template consists of a ConfigMap object, in which the keys of the data field represent the kind of the installation manifests. Cluster-level templates are instantiated once per cluster in the ClusterInstance CR.

array

automatedCleaningMode
optional

Set the value to metadata to enable the removal of the disk’s partitioning table only, without fully wiping the disk. The default value is disabled.

string

bmcAddress
required

BMC address that you use to access the host. Applies to all cluster types. For more information about BMC addressing, see BMC addressing in Additional resources. Note: In far edge Telco use cases, only virtual media is supported for use with GitOps ZTP.

string

bmcCredentialsName
required

Configure the bmh-secret CR that you separately create with the host BMC credentials. When creating the bmh-secret CR, use the same namespace as the ClusterInstance CR that provisions the host.

string

bootMACAddress
required

Specify the MAC address that PXE boots. It is required for libvirt VMs driven by virtual BMC.

string

bootMode
optional

Set the boot mode for the host to UEFI. The default value is UEFI. Use UEFISecureBoot to enable secure boot on the host. The following values are supported:

string

extraAnnotations
optional

Specify additional node-level annotations to be applied to the rendered templates by using the following format:

extraAnnotations:
  BareMetalHost:
    myNodeAnnotation: success

object

extraLabels
optional

Specify additional node-level labels to be applied to the rendered templates.

extraLabels:
  ManagedCluster:
    common: "true"
    label-a : "value-a"

object

hostName
required

Define the host name.

string

installerArgs
optional

Specify the user overrides for the host’s :op-system-first: installer arguments.

string

ignitionConfigOverride
optional

Specify the user overrides for the initial Ignition configuration. Use this field to assign partitions for persistent storage. Adjust disk ID and size to the specific hardware.

string

ironicInspect
optional

Specify if automatic introspection runs during registration of the bare metal host.

string

nodeLabels
optional

Specify custom node labels for your nodes in your managed clusters. These are additional labels that are not used by any Red Hat Advanced Cluster Management components, only by the user. When you add a custom node label, it can be associated with a custom machine config pool that references a specific configuration for that label. Adding custom node labels during installation makes the deployment process more effective and prevents the need for additional reboots after the installation is complete.

Note: When used in the BareMetalHost template, the custom labels are appended to the BareMetalHost annotations with the bmac.agent-install.openshift.io prefix.

object

nodeNetwork
optional

Configure the network settings for nodes that have static networks.

object

pruneManifests
optional

Define a list of node-level manifests to remove by specifying their apiVersion and Kind values.

array

role
optional

Configure the role of the node, such as master or worker.

string

rootDeviceHints
optional

Specify the device for deployment. Identifiers that are stable across reboots are recommended. For example, wwn: <disk_wwn> or deviceName: /dev/disk/by-path/<device_path>. <by-path> values are preferred. For a detailed list of stable identifiers, see "About root device hints". You can also specify the name, model, size, or vendor of the device.

object

templateRefs
required

Specify the list of the references to node-level templates. A node-level template consists of a ConfigMap object, in which the keys of the data field represent the kind of the installation manifests. Node-level templates are instantiated once for each node in the ClusterInstance CR.

array

conditions
optional

Lists the conditions that pertain to actions performed on the ClusterInstance resource.

conditions array

deploymentConditions
optional

Lists the hive status conditions that are associated with the ClusterDeployment resource.

deploymentConditions array

manifestsRendered
optional

Lists the manifests that have been rendered and their statuses.

array

observedGeneration
optional

Tracks the observed generation of the ClusterInstance object.

integer

ClusterInstanceValidated

Indicates that the SiteConfig operator validated the ClusterInstance spec fields and verified that the required artifacts, such as secrets and extra manifest ConfigMaps objects are present.

RenderedTemplates

Indicates that SiteConfig operator successfully validated the referenced Golang cluster templates.

RenderedTemplatesValidated

Indicates that the SiteConfig operator rendered the installation manifests and the dry run was successful.

RenderedTemplatesApplied

Indicates that the SiteConfig operator created the installation manifests and the underlying Operators consumed them.

Provisioned

Indicates that the underlying Operators are provisioning the clusters.

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.

apiVersion
required

string

kind
required

string

metadata
required

object

apiVersion
required

Versioned schema of the ManagedClusterSetBinding.

string

kind
required

String value that represents the REST resource.

string

metadata
required

Metadata of the ManagedClusterSetBinding.

object

spec
required

Specification of the ManagedClusterSetBinding.

spec

clusterSet
required

Name of the ManagedClusterSet to bind. It must match the instance name of the ManagedClusterSetBinding and cannot change after it is created.

string

apiVersion
required

string

kind
required

string

metadata
required

object

spec
required

spec

configMapRef
optional

ObjectReference contains enough information to let you inspect or modify the referred object.

configMapRef

gates
optional

ChannelGate defines criteria for promote to channel

gates

pathname
required

string

secretRef
optional

ObjectReference contains enough information to let you inspect or modify the referred object.

secretRef

sourceNamespaces
optional

enum (Namespace, HelmRepo, ObjectBucket, Git, namespace, helmrepo, objectbucket, github) array

apiVersion
optional

API version of the referent.

string

fieldPath
optional

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.

string

kind
optional

Kind of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/

name
optional

Name of the referent. More info: Names

string

namespace
optional

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

string

resourceVersion
optional

Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

string

uid
optional

annotations
optional

typical annotations of k8s

annotations

labelSelector
optional

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

labelSelector

name
optional

string

key
optional

string

value
optional

string

matchExpressions
optional

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions array

matchLabels
optional

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

string, string map

key
required

key is the label key that the selector applies to.

string

operator
required

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

string

values
optional

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

string array

apiVersion
optional

API version of the referent.

string

fieldPath
optional

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.

string

kind
optional

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

string

name
optional

Name of the referent. More info: Names

string

namespace
optional

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

string

resourceVersion
optional

Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

string

uid
optional

UID of the referent. More info: UIIDs

string

apiVersion
required

string

kind
required

string

metadata
required

metadata

spec
required

spec

status
optional

status

annotations
optional

object

labels
optional

object

name
optional

string

namespace
optional

string

channel
required

string

name
optional

string

overrides
optional

overrides array

packageFilter
optional

packageFilter

packageOverrides
optional

packageOverrides array

placement
optional

placement

timewindow
optional

timewindow

clusterName
required

string

clusterOverrides
required

object array

annotations
optional

string, string map

filterRef
optional

filterRef

labelSelector
optional

labelSelector

version
optional

Pattern : "()((\\.[0-9])(\\.)|(\\.[0-9])?(\\.[xX]))$"

string

name
optional

string

matchExpressions
optional

matchExpressions array

matchLabels
optional

string, string map

key
required

string

operator
required

string

values
optional

string array

packageAlias
optional

string

packageName
required

string

packageOverrides
optional

object array

clusterSelector
optional

clusterSelector

clusters
optional

clusters array

local
optional

boolean

placementRef
optional

placementRef

matchExpressions
optional

matchExpressions array

matchLabels
optional

string, string map

key
required

string

operator
required

string

values
optional

string array

name
required

string

apiVersion
optional

string

fieldPath
optional

string

kind
optional

string

name
optional

string

namespace
optional

string

resourceVersion
optional

string

uid
optional

string

daysofweek
optional

string array

hours
optional

hours array

location
optional

string

windowtype
optional

enum (active, blocked, Active, Blocked)

end
optional

string

start
optional

string

lastUpdateTime
optional

string (date-time)

message
optional

string

phase
optional

string

reason
optional

string

statuses
optional

object

apiVersion
required

string

kind
required

string

metadata
required

object

spec
required

spec

clusterConditions
optional

clusterConditions array

clusterReplicas
optional

integer

clusterSelector
optional

clusterSelector

clusters
optional

clusters array

policies
optional