MachinePool

Scope: Namespaced
Version: v1beta1

MachinePool is the Schema for the machinepools API.

  • apiVersion
    string

    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

  • kind
    string

    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

  • metadata
    object
  • spec
    object

    MachinePoolSpec defines the desired state of MachinePool.

    • spec.clusterName
      string

      Required value

      ClusterName is the name of the Cluster this object belongs to.

    • spec.failureDomains
      array of strings

      FailureDomains is the list of failure domains this MachinePool should be attached to.

    • spec.minReadySeconds
      integer

      Minimum number of seconds for which a newly created machine instances should be ready. Defaults to 0 (machine instance will be considered available as soon as it is ready)

    • spec.providerIDList
      array of strings

      ProviderIDList are the identification IDs of machine instances provided by the provider. This field must match the provider IDs as seen on the node objects corresponding to a machine pool’s machine instances.

    • spec.replicas
      integer

      Number of desired machines. Defaults to 1. This is a pointer to distinguish between explicit zero and not specified.

    • spec.template
      object

      Required value

      Template describes the machines that will be created.

      • spec.template.metadata
        object

        Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

        • spec.template.metadata.annotations
          object

          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

        • spec.template.metadata.labels
          object

          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

      • spec.template.spec
        object

        Specification of the desired behavior of the machine. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

        • spec.template.spec.bootstrap
          object

          Required value

          Bootstrap is a reference to a local struct which encapsulates fields to configure the Machine’s bootstrapping mechanism.

          • spec.template.spec.bootstrap.configRef
            object

            ConfigRef is a reference to a bootstrap provider-specific resource that holds configuration details. The reference is optional to allow users/operators to specify Bootstrap.DataSecretName without the need of a controller.

            • spec.template.spec.bootstrap.configRef.apiVersion
              string

              API version of the referent.

            • spec.template.spec.bootstrap.configRef.fieldPath
              string

              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.

            • spec.template.spec.bootstrap.configRef.kind
              string

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

            • spec.template.spec.bootstrap.configRef.name
              string

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

            • spec.template.spec.bootstrap.configRef.namespace
              string

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

            • spec.template.spec.bootstrap.configRef.resourceVersion
              string

              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

            • spec.template.spec.bootstrap.configRef.uid
              string

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

          • spec.template.spec.bootstrap.dataSecretName
            string

            DataSecretName is the name of the secret that stores the bootstrap data script. If nil, the Machine should remain in the Pending state.

        • spec.template.spec.clusterName
          string

          Required value

          ClusterName is the name of the Cluster this object belongs to.

        • spec.template.spec.failureDomain
          string

          FailureDomain is the failure domain the machine will be created in. Must match a key in the FailureDomains map stored on the cluster object.

        • spec.template.spec.infrastructureRef
          object

          Required value

          InfrastructureRef is a required reference to a custom resource offered by an infrastructure provider.

          • spec.template.spec.infrastructureRef.apiVersion
            string

            API version of the referent.

          • spec.template.spec.infrastructureRef.fieldPath
            string

            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.

          • spec.template.spec.infrastructureRef.kind
            string

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

          • spec.template.spec.infrastructureRef.name
            string

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

          • spec.template.spec.infrastructureRef.namespace
            string

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

          • spec.template.spec.infrastructureRef.resourceVersion
            string

            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

          • spec.template.spec.infrastructureRef.uid
            string

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

        • spec.template.spec.nodeDeletionTimeout
          string

          NodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely. Defaults to 10 seconds.

        • spec.template.spec.nodeDrainTimeout
          string

          NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from kubectl drain --timeout

        • spec.template.spec.nodeVolumeDetachTimeout
          string

          NodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations.

        • spec.template.spec.providerID
          string

          ProviderID is the identification ID of the machine provided by the provider. This field must match the provider ID as seen on the node object corresponding to this machine. This field is required by higher level consumers of cluster-api. Example use case is cluster autoscaler with cluster-api as provider. Clean-up logic in the autoscaler compares machines to nodes to find out machines at provider which could not get registered as Kubernetes nodes. With cluster-api as a generic out-of-tree provider for autoscaler, this field is required by autoscaler to be able to have a provider view of the list of machines. Another list of nodes is queried from the k8s apiserver and then a comparison is done to find out unregistered machines and are marked for delete. This field will be set by the actuators and consumed by higher level entities like autoscaler that will be interfacing with cluster-api as generic provider.

        • spec.template.spec.version
          string

          Version defines the desired Kubernetes version. This field is meant to be optionally used by bootstrap providers.