cluster.x-k8s.io / v1alpha4 / ClusterClass

• string

  .apiVersion

  APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

• string

  .kind

  Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

• object

  .metadata

• object

  .spec

  spec is the desired state of ClusterClass.

• object

  .spec .controlPlane

  controlPlane is a reference to a local struct that holds the details for provisioning the Control Plane for the Cluster.

• object

  .spec .controlPlane .machineInfrastructure

  machineInfrastructure defines the metadata and infrastructure information for control plane machines.

  This field is supported if and only if the control plane provider template referenced above is Machine based and supports setting replicas.

• object required

  .spec .controlPlane .machineInfrastructure .ref

  ref is a required reference to a custom resource offered by a provider.

• string

  .spec .controlPlane .machineInfrastructure .ref .apiVersion

  API version of the referent.

• string

  .spec .controlPlane .machineInfrastructure .ref .fieldPath

  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.

• string

  .spec .controlPlane .machineInfrastructure .ref .kind

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

• string

  .spec .controlPlane .machineInfrastructure .ref .name

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

• string

  .spec .controlPlane .machineInfrastructure .ref .namespace

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

• string

  .spec .controlPlane .machineInfrastructure .ref .resourceVersion

  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

  .spec .controlPlane .machineInfrastructure .ref .uid

  UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

• object

  .spec .controlPlane .metadata

  metadata is the metadata applied to the machines of the ControlPlane. At runtime this metadata is merged with the corresponding metadata from the topology.

  This field is supported if and only if the control plane provider template referenced is Machine based.

• object

  .spec .controlPlane .metadata .annotations

  annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

• object

  .spec .controlPlane .metadata .labels

  labels is a map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

• object required

  .spec .controlPlane .ref

  ref is a required reference to a custom resource offered by a provider.

• string

  .spec .controlPlane .ref .apiVersion

  API version of the referent.

• string

  .spec .controlPlane .ref .fieldPath

  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.

• string

  .spec .controlPlane .ref .kind

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

• string

  .spec .controlPlane .ref .name

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

• string

  .spec .controlPlane .ref .namespace

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

• string

  .spec .controlPlane .ref .resourceVersion

  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

  .spec .controlPlane .ref .uid

  UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

• object

  .spec .infrastructure

  infrastructure is a reference to a provider-specific template that holds the details for provisioning infrastructure specific cluster for the underlying provider. The underlying provider is responsible for the implementation of the template to an infrastructure cluster.

• object required

  .spec .infrastructure .ref

  ref is a required reference to a custom resource offered by a provider.

• string

  .spec .infrastructure .ref .apiVersion

  API version of the referent.

• string

  .spec .infrastructure .ref .fieldPath

  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.

• string

  .spec .infrastructure .ref .kind

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

• string

  .spec .infrastructure .ref .name

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

• string

  .spec .infrastructure .ref .namespace

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

• string

  .spec .infrastructure .ref .resourceVersion

  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

  .spec .infrastructure .ref .uid

  UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

• object

  .spec .workers

  workers describes the worker nodes for the cluster. It is a collection of node types which can be used to create the worker nodes of the cluster.

• array

  .spec .workers .machineDeployments

  machineDeployments is a list of machine deployment classes that can be used to create a set of worker nodes.

• string required

  .spec .workers .machineDeployments[] .class

  class denotes a type of worker node present in the cluster, this name MUST be unique within a ClusterClass and can be referenced in the Cluster to create a managed MachineDeployment.

• object required

  .spec .workers .machineDeployments[] .template

  template is a local struct containing a collection of templates for creation of MachineDeployment objects representing a set of worker nodes.

• object required

  .spec .workers .machineDeployments[] .template .bootstrap

  bootstrap contains the bootstrap template reference to be used for the creation of worker Machines.

• object required

  .spec .workers .machineDeployments[] .template .bootstrap .ref

  ref is a required reference to a custom resource offered by a provider.

• string

  .spec .workers .machineDeployments[] .template .bootstrap .ref .apiVersion

  API version of the referent.

• string

  .spec .workers .machineDeployments[] .template .bootstrap .ref .fieldPath

  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.

• string

  .spec .workers .machineDeployments[] .template .bootstrap .ref .kind

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

• string

  .spec .workers .machineDeployments[] .template .bootstrap .ref .name

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

• string

  .spec .workers .machineDeployments[] .template .bootstrap .ref .namespace

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

• string

  .spec .workers .machineDeployments[] .template .bootstrap .ref .resourceVersion

  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

  .spec .workers .machineDeployments[] .template .bootstrap .ref .uid

  UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

• object required

  .spec .workers .machineDeployments[] .template .infrastructure

  infrastructure contains the infrastructure template reference to be used for the creation of worker Machines.

• object required

  .spec .workers .machineDeployments[] .template .infrastructure .ref

  ref is a required reference to a custom resource offered by a provider.

• string

  .spec .workers .machineDeployments[] .template .infrastructure .ref .apiVersion

  API version of the referent.

• string

  .spec .workers .machineDeployments[] .template .infrastructure .ref .fieldPath

  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.

• string

  .spec .workers .machineDeployments[] .template .infrastructure .ref .kind

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

• string

  .spec .workers .machineDeployments[] .template .infrastructure .ref .name

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

• string

  .spec .workers .machineDeployments[] .template .infrastructure .ref .namespace

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

• string

  .spec .workers .machineDeployments[] .template .infrastructure .ref .resourceVersion

  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

  .spec .workers .machineDeployments[] .template .infrastructure .ref .uid

  UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

• object

  .spec .workers .machineDeployments[] .template .metadata

  metadata is the metadata applied to the machines of the MachineDeployment. At runtime this metadata is merged with the corresponding metadata from the topology.

• object

  .spec .workers .machineDeployments[] .template .metadata .annotations

  annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

• object

  .spec .workers .machineDeployments[] .template .metadata .labels

  labels is a map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels