NodeGroup

Scope: Cluster

Describes the runtime parameters of the node group.

  • specobject

    Required value

    • chaosobject

      Chaos monkey settings.

      Example:

      mode: DrainAndDelete
      period: 24h
      
      • modestring

        The chaos monkey mode:

        • DrainAndDelete — drains and deletes a node when triggered;
        • Disabled — leaves this NodeGroup intact.

        Default: "Disabled"

        Allowed values: Disabled, DrainAndDelete

      • periodstring

        The time interval to use for the chaos monkey (can be specified in the Go format).

        Default: "6h"

        Pattern: ^[0-9]+[mh]{1}$

    • cloudInstancesobject

      Parameter for provisioning the cloud-based VMs.

      Caution! Can only be used together with nodeType: CloudEphemeral.

      • classReferenceobject

        Required value

        The reference to the InstanceClass object. It is unique for each cloud-provider-* module.

        • kindstring

          The object type (e.g., OpenStackInstanceClass). The object type is specified in the documentation of the corresponding cloud-provider- module.

          Allowed values: OpenStackInstanceClass, GCPInstanceClass, VsphereInstanceClass, AWSInstanceClass, YandexInstanceClass, AzureInstanceClass

        • namestring

          The name of the required InstanceClass object (e.g., finland-medium).

      • maxPerZoneinteger

        Required value

        The maximum number of instances for the group in each zone.

        This value is used as the upper bound in cluster-autoscaler.

        Allowed values: 0 <= X

      • maxSurgePerZoneinteger

        The maximum number of instances to rollout simultaneously in the group in each zone.

        Default: 1

        Allowed values: 0 <= X

      • maxUnavailablePerZoneinteger

        The maximum number of unavailable instances (during rollout) in the group in each zone.

        Default: 0

        Allowed values: 0 <= X

      • minPerZoneinteger

        Required value

        The minimum number of instances for the group in each zone.

        This value is used in the MachineDeployment object and as a lower bound in cluster-autoscaler.

        Allowed values: 0 <= X

      • priorityinteger

        Priority of the node group.

        When scaling a cluster, the autoscaler will first select node groups with a higher priority set. If several node groups have the same priority, the autoscaler randomly selects a group of them.

        Using priorities can be convenient to prefer ordering cheaper nodes (for example, spot instances) over more expensive ones.

      • standbyinteger or string

        The summary number of overprovisioned Nodes for this NodeGroup in all zones.

        The value can be an absolute number (for example, 2) or a percentage of desired Nodes (for example, 10%). The absolute number is calculated from percentage of maximum Nodes amount by rounding down.

        Pattern: ^[0-9]+%?$

      • standbyHolderobject

        Parameters of the “idle” process (resource consumer) for the prepared instances.

        • notHeldResourcesobject

          Describes the resources that will not be held (consumed) by the standby holder.

          • cpuinteger or string

            Describes the amount of CPU that will not be held by standby holder on Nodes from this NodeGroup.

            The value can be an absolute number of cpus (for example, 2) as well as a milli representation (for example, 1500m).

            Pattern: ^[0-9]+m?$

          • memoryinteger or string

            Describes the amount of memory that will not be held by standby holder on Nodes from this NodeGroup.

            The value can be an absolute number of bytes (for example, 128974848) as well as a fixed-point number using one of memory suffixes: G, Gi, M, Mi.

            Pattern: ^[0-9]+(\.[0-9]+)?(E|P|T|G|M|K|Ei|Pi|Ti|Gi|Mi|Ki)?$

      • zonesarray of strings

        List of availability zones to create instances in.

        The default value depends on the cloud provider selected and usually corresponds to all zones of the region being used.

        Example:

        zones:
        - Helsinki
        - Espoo
        - Tampere
        
    • criobject

      Container runtime parameters.

      • containerdobject

        Containerd runtime parameters.

        If used, cri.type must be set to Containerd.

        • maxConcurrentDownloadsinteger

          Set the max concurrent downloads for each pull.

          Default: 3

      • dockerobject

        Docker settings for nodes.

        • manageboolean

          Enable Docker maintenance from bashible.

          Default: true

        • maxConcurrentDownloadsinteger

          Set the max concurrent downloads for each pull.

          Default: 3

      • notManagedobject

        Settings for not managed CRI for nodes.

        • criSocketPathstring

          Path to CRI socket.

      • typestring

        Container runtime type.

        Value defaultCRI from the initial cluster configration (cluster-configuration.yaml parameter from the d8-cluster-configuration secret in the kube-system namespace) is used if not specified.

        Allowed values: Docker, Containerd, NotManaged

    • disruptionsobject

      Disruptions settings for nodes.

      Example:

      disruptions:
        approvalMode: Automatic
        automatic:
          drainBeforeApproval: false
          windows:
          - from: '06:00'
            to: '08:00'
            days:
            - Tue
            - Sun
      
      • approvalModestring

        The approval mode for disruptive updates:

        • Manual — disable automatic disruption approval; the alert will be displayed if disruption is needed. Caution! The master node group update mode must be Manual to avoid issues with draining.
        • Automatic — automatically approve disruption-involving updates.
        • RollingUpdate — in this mode, a new node with new settings will be created; then, the old node will be deleted. Available only for cloud nodes.

        Default: "Automatic"

        Allowed values: Manual, Automatic, RollingUpdate

      • automaticobject

        Additional parameters for the Automatic mode.

        • drainBeforeApprovalboolean

          Drain Pods from the nodes before approving disruption.

          Caution! This setting ignores (nodes will be approved without draining Pods):

          • for the nodeGroup master with a single node;
          • for a single ready node in a nodeGroup picked out for Deckhouse placement.

          Default: true

        • windowsarray of objects

          Time windows for node disruptive updates.

          • daysarray of strings

            Days of the week when node could be updated.

            Example:

            days:
            - Mon
            - Wed
            
            • Element of the arraystring

              Day of the week.

              Allowed values: Mon, Tue, Wed, Thu, Fri, Sat, Sun

          • fromstring

            Required value

            Start time of disruptive update window (UTC timezone).

            Pattern: ^(?:\d|[01]\d|2[0-3]):[0-5]\d$

            Example:

            from: '13:00'
            
          • tostring

            Required value

            End time of disruptive update window (UTC timezone).

            Pattern: ^(?:\d|[01]\d|2[0-3]):[0-5]\d$

            Example:

            to: '18:30'
            
      • rollingUpdateobject

        Additional parameters for the RollingUpdate mode.

        • windowsarray of objects

          Time windows for node disruptive updates.

          • daysarray of strings

            Days of the week when node could be updated.

            Example:

            days:
            - Mon
            - Wed
            
            • Element of the arraystring

              Day of the week.

              Allowed values: Mon, Tue, Wed, Thu, Fri, Sat, Sun

          • fromstring

            Required value

            Start time of disruptive update window (UTC timezone).

            Pattern: ^(?:\d|[01]\d|2[0-3]):[0-5]\d$

            Example:

            from: '13:00'
            
          • tostring

            Required value

            End time of disruptive update window (UTC timezone).

            Pattern: ^(?:\d|[01]\d|2[0-3]):[0-5]\d$

            Example:

            to: '18:30'
            
    • kubeletobject

      Kubelet settings for nodes.

      • containerLogMaxFilesinteger

        How many rotated log files to store before deleting them.

        WARNING! This parameter does nothing if CRI type is Docker.

        Default: 4

        Allowed values: 1 <= X <= 20

      • containerLogMaxSizestring

        Maximum log file size before it is rotated.

        WARNING! This parameter does nothing if CRI type is Docker.

        Default: "50Mi"

        Pattern: \d+[Ei|Pi|Ti|Gi|Mi|Ki|E|P|T|G|M|k|m]

      • maxPodsinteger

        Set the max count of pods per node.

        Default: 110

      • rootDirstring

        Directory path for managing kubelet files (volume mounts,etc).

        Default: "/var/lib/kubelet"

    • nodeTemplateobject

      Specification of some of the fields that will be maintained in all nodes of the group.

      Example:

      labels:
        environment: production
        app: warp-drive-ai
      annotations:
        ai.fleet.com/discombobulate: "true"
      taints:
      - effect: NoExecute
        key: ship-class
        value: frigate
      
      • annotationsobject

        Similar to the standard metadata.annotations field.

        Example:

        annotations:
          ai.fleet.com/discombobulate: "true"
        
      • labelsobject

        Similar to the standard metadata.labels field.

        Example:

        labels:
          environment: production
          app: warp-drive-ai
        
      • taintsarray of objects

        Similar to the .spec.taints field of the Node object.

        Caution! Only effect, key, value fields are available.

        Example:

        taints:
        - effect: NoExecute
          key: ship-class
          value: frigate
        
        • effectstring

          Allowed values: NoSchedule, PreferNoSchedule, NoExecute

        • keystring
        • valuestring
    • nodeTypestring

      Required value

      The type of nodes this group provides:

      • CloudEphemeral — nodes for this group will be automatically created (and deleted) in the cloud of the specified cloud provider;
      • CloudPermanent — nodes from ProviderClusterConfiguration will be created via dhctl;
      • CloudStatic — a static node (created manually or using any external tools) hosted in the cloud integrated with one of the cloud providers. This node has the CSI running, and it is managed by the cloud-controller-manager: the Node object automatically gets the information about the zone and region based on the cloud data; if a node gets deleted from the cloud, its corresponding Node object will be deleted in Kubernetes;
      • Static — a static node hosted on a bare metal or virtual machine. The cloud-controller-manager does not manage the node even if one of the cloud providers is enabled.

      Allowed values: CloudEphemeral, CloudPermanent, CloudStatic, Static

    • operatingSystemobject

      Operating System settings for nodes.

      • manageKernelboolean

        Enable kernel maintenance from bashible.

        Default: true

    • updateobject
      • maxConcurrentinteger or string

        Maximum number of concurrently updating nodes. Can be set as absolute count or as a percent of total nodes.

        Default: 1

        Pattern: ^[1-9][0-9]*%?$

Describes the runtime parameters of the node group.

  • specobject

    Required value

    • chaosobject

      Chaos monkey settings.

      Example:

      mode: DrainAndDelete
      period: 24h
      
      • modestring

        The chaos monkey mode:

        • DrainAndDelete — drains and deletes a node when triggered;
        • Disabled — leaves this NodeGroup intact.

        Default: "Disabled"

        Allowed values: Disabled, DrainAndDelete

      • periodstring

        The time interval to use for the chaos monkey (can be specified in the Go format).

        Default: "6h"

        Pattern: ^[0-9]+[mh]{1}$

    • cloudInstancesobject

      Parameter for provisioning the cloud-based VMs.

      Caution! Can only be used together with nodeType: CloudEphemeral.

      • classReferenceobject

        Required value

        The reference to the InstanceClass object. It is unique for each cloud-provider-* module.

        • kindstring

          The object type (e.g., OpenStackInstanceClass). The object type is specified in the documentation of the corresponding cloud-provider- module.

          Allowed values: OpenStackInstanceClass, GCPInstanceClass, VsphereInstanceClass, AWSInstanceClass, YandexInstanceClass, AzureInstanceClass

        • namestring

          The name of the required InstanceClass object (e.g., finland-medium).

      • maxPerZoneinteger

        Required value

        The maximum number of instances for the group in each zone.

        This value is used as the upper bound in cluster-autoscaler.

        Allowed values: 0 <= X

      • maxSurgePerZoneinteger

        The maximum number of instances to rollout simultaneously in the group in each zone.

        Default: 1

        Allowed values: 0 <= X

      • maxUnavailablePerZoneinteger

        The maximum number of unavailable instances (during rollout) in the group in each zone.

        Default: 0

        Allowed values: 0 <= X

      • minPerZoneinteger

        Required value

        The minimum number of instances for the group in each zone.

        This value is used in the MachineDeployment object and as a lower bound in cluster-autoscaler.

        Allowed values: 0 <= X

      • standbyinteger or string

        The summary number of overprovisioned Nodes for this NodeGroup in all zones.

        The value can be an absolute number (for example, 2) or a percentage of desired Nodes (for example, 10%). The absolute number is calculated from percentage of maximum Nodes amount by rounding down.

        Pattern: ^[0-9]+%?$

      • standbyHolderobject

        Parameters of the “idle” process (resource consumer) for the prepared instances.

        • notHeldResourcesobject

          Describes the resources that will not be held (consumed) by the standby holder.

          • cpuinteger or string

            Describes the amount of CPU that will not be held by standby holder on Nodes from this NodeGroup.

            The value can be an absolute number of cpus (for example, 2) as well as a milli representation (for example, 1500m).

            Pattern: ^[0-9]+m?$

          • memoryinteger or string

            Describes the amount of memory that will not be held by standby holder on Nodes from this NodeGroup.

            The value can be an absolute number of bytes (for example, 128974848) as well as a fixed-point number using one of memory suffixes: G, Gi, M, Mi.

            Pattern: ^[0-9]+(\.[0-9]+)?(E|P|T|G|M|K|Ei|Pi|Ti|Gi|Mi|Ki)?$

      • zonesarray of strings

        List of availability zones to create instances in.

        The default value depends on the cloud provider selected and usually corresponds to all zones of the region being used.

        Example:

        zones:
        - Helsinki
        - Espoo
        - Tampere
        
    • criobject

      Container runtime parameters.

      • containerdobject

        Containerd runtime parameters.

        If used, cri.type must be set to Containerd.

        • maxConcurrentDownloadsinteger

          Set the max concurrent downloads for each pull.

          Default: 3

      • dockerobject

        Docker settings for nodes.

        • manageboolean

          Enable Docker maintenance from bashible.

          Default: true

        • maxConcurrentDownloadsinteger

          Set the max concurrent downloads for each pull.

          Default: 3

      • notManagedobject

        Settings for not managed CRI for nodes.

        • criSocketPathstring

          Path to CRI socket.

      • typestring

        Container runtime type.

        Value defaultCRI from the initial cluster configration (cluster-configuration.yaml parameter from the d8-cluster-configuration secret in the kube-system namespace) is used if not specified.

        Allowed values: Docker, Containerd, NotManaged

    • disruptionsobject

      Disruptions settings for nodes.

      Example:

      disruptions:
        approvalMode: Automatic
        automatic:
          drainBeforeApproval: false
          windows:
          - from: '06:00'
            to: '08:00'
            days:
            - Tue
            - Sun
      
      • approvalModestring

        The approval mode for disruptive updates:

        • Manual — disable automatic disruption approval; the alert will be displayed if disruption is needed. Caution! The master node group update mode must be Manual to avoid issues with draining.
        • Automatic — automatically approve disruption-involving updates.
        • RollingUpdate — in this mode, a new node with new settings will be created; then, the old node will be deleted. Available only for cloud nodes.

        Default: "Automatic"

        Allowed values: Manual, Automatic, RollingUpdate

      • automaticobject

        Additional parameters for the Automatic mode.

        • drainBeforeApprovalboolean

          Drain Pods from the nodes before approving disruption.

          Caution! This setting ignores (nodes will be approved without draining Pods):

          • for the nodeGroup master with a single node;
          • for a single ready node in a nodeGroup picked out for Deckhouse placement.

          Default: true

        • windowsarray of objects

          Time windows for node disruptive updates.

          • daysarray of strings

            Days of the week when node could be updated.

            Example:

            days:
            - Mon
            - Wed
            
            • Element of the arraystring

              Day of the week.

              Allowed values: Mon, Tue, Wed, Thu, Fri, Sat, Sun

          • fromstring

            Required value

            Start time of disruptive update window (UTC timezone).

            Pattern: ^(?:\d|[01]\d|2[0-3]):[0-5]\d$

            Example:

            from: '13:00'
            
          • tostring

            Required value

            End time of disruptive update window (UTC timezone).

            Pattern: ^(?:\d|[01]\d|2[0-3]):[0-5]\d$

            Example:

            to: '18:30'
            
      • rollingUpdateobject

        Additional parameters for the RollingUpdate mode.

        • windowsarray of objects

          Time windows for node disruptive updates.

          • daysarray of strings

            Days of the week when node could be updated.

            Example:

            days:
            - Mon
            - Wed
            
            • Element of the arraystring

              Day of the week.

              Allowed values: Mon, Tue, Wed, Thu, Fri, Sat, Sun

          • fromstring

            Required value

            Start time of disruptive update window (UTC timezone).

            Pattern: ^(?:\d|[01]\d|2[0-3]):[0-5]\d$

            Example:

            from: '13:00'
            
          • tostring

            Required value

            End time of disruptive update window (UTC timezone).

            Pattern: ^(?:\d|[01]\d|2[0-3]):[0-5]\d$

            Example:

            to: '18:30'
            
    • kubeletobject

      Kubelet settings for nodes.

      • containerLogMaxFilesinteger

        How many rotated log files to store before deleting them.

        WARNING! This parameter does nothing if CRI type is Docker.

        Default: 4

        Allowed values: 1 <= X <= 20

      • containerLogMaxSizestring

        Maximum log file size before it is rotated.

        WARNING! This parameter does nothing if CRI type is Docker.

        Default: "50Mi"

        Pattern: \d+[Ei|Pi|Ti|Gi|Mi|Ki|E|P|T|G|M|k|m]

      • maxPodsinteger

        Set the max count of pods per node.

        Default: 110

      • rootDirstring

        Directory path for managing kubelet files (volume mounts,etc).

        Default: "/var/lib/kubelet"

    • nodeTemplateobject

      Specification of some of the fields that will be maintained in all nodes of the group.

      Example:

      labels:
        environment: production
        app: warp-drive-ai
      annotations:
        ai.fleet.com/discombobulate: "true"
      taints:
      - effect: NoExecute
        key: ship-class
        value: frigate
      
      • annotationsobject

        Similar to the standard metadata.annotations field.

        Example:

        annotations:
          ai.fleet.com/discombobulate: "true"
        
      • labelsobject

        Similar to the standard metadata.labels field.

        Example:

        labels:
          environment: production
          app: warp-drive-ai
        
      • taintsarray of objects

        Similar to the .spec.taints field of the Node object.

        Caution! Only effect, key, value fields are available.

        Example:

        taints:
        - effect: NoExecute
          key: ship-class
          value: frigate
        
        • effectstring

          Allowed values: NoSchedule, PreferNoSchedule, NoExecute

        • keystring
        • valuestring
    • nodeTypestring

      Required value

      The type of nodes this group provides.

      • Cloud — nodes for this group will be automatically created (and deleted) in the cloud of the specified cloud provider;
      • Static — a static node hosted on a bare metal or virtual machine. The cloud-controller-manager does not manage the node even of one of the cloud providers is enabled;
      • Hybrid — a static node (created manually or using any external tools) hosted in the cloud integrated with one of the cloud provider. This node has the CSI running, and it is managed by the cloud-controller-manager: the Node object automatically gets the information about the zone and region based on the cloud data; if a node gets deleted from the cloud, its corresponding Node object will be deleted in Kubernetes.

      Allowed values: Cloud, Static, Hybrid

    • operatingSystemobject

      Operating System settings for nodes.

      • manageKernelboolean

        Enable kernel maintenance from bashible.

        Default: true

Defines the runtime parameters of a node group.

  • specobject

    Required value

    • chaosobject

      Chaos monkey settings.

      Example:

      mode: DrainAndDelete
      period: 24h
      
      • modestring

        The chaos monkey mode:

        • DrainAndDelete — drains and deletes a node when triggered;
        • Disabled — leaves this NodeGroup intact.

        Default: "Disabled"

        Allowed values: Disabled, DrainAndDelete

      • periodstring

        The time interval to use for the chaos monkey (can be specified in the Go format).

        Default: "6h"

        Pattern: ^[0-9]+[mh]{1}$

    • cloudInstancesobject

      Parameter for provisioning the cloud-based VMs.

      Caution! Can only be used together with nodeType: CloudEphemeral.

      • classReferenceobject

        Required value

        The reference to the InstanceClass object. It is unique for each cloud-provider-* module.

        • kindstring

          The object type (e.g., OpenStackInstanceClass). The object type is specified in the documentation of the corresponding cloud-provider- module.

          Allowed values: OpenStackInstanceClass, GCPInstanceClass, VsphereInstanceClass, AWSInstanceClass, YandexInstanceClass, AzureInstanceClass

        • namestring

          The name of the required InstanceClass object (e.g., finland-medium).

      • maxPerZoneinteger

        Required value

        The maximum number of instances for the group in each zone.

        This value is used as the upper bound in cluster-autoscaler.

        Allowed values: 0 <= X

      • maxSurgePerZoneinteger

        The maximum number of instances to rollout simultaneously in the group in each zone.

        Default: 1

        Allowed values: 0 <= X

      • maxUnavailablePerZoneinteger

        The maximum number of unavailable instances (during rollout) in the group in each zone.

        Default: 0

        Allowed values: 0 <= X

      • minPerZoneinteger

        Required value

        The minimum number of instances for the group in each zone.

        This value is used in the MachineDeployment object and as a lower bound in cluster-autoscaler.

        Allowed values: 0 <= X

      • standbyinteger or string

        The summary number of overprovisioned Nodes for this NodeGroup in all zones.

        The value can be an absolute number (for example, 2) or a percentage of desired Nodes (for example, 10%). The absolute number is calculated from percentage of maximum Nodes amount by rounding down.

        Pattern: ^[0-9]+%?$

      • standbyHolderobject

        Parameters of the “idle” process (resource consumer) for the prepared instances.

        • notHeldResourcesobject

          Describes the resources that will not be held (consumed) by the standby holder.

          • cpuinteger or string

            Describes the amount of CPU that will not be held by standby holder on Nodes from this NodeGroup.

            The value can be an absolute number of cpus (for example, 2) as well as a milli representation (for example, 1500m).

            Pattern: ^[0-9]+m?$

          • memoryinteger or string

            Describes the amount of memory that will not be held by standby holder on Nodes from this NodeGroup.

            The value can be an absolute number of bytes (for example, 128974848) as well as a fixed-point number using one of memory suffixes: G, Gi, M, Mi.

            Pattern: ^[0-9]+(\.[0-9]+)?(E|P|T|G|M|K|Ei|Pi|Ti|Gi|Mi|Ki)?$

      • zonesarray of strings

        List of availability zones to create instances in.

        The default value depends on the cloud provider selected and usually corresponds to all zones of the region being used.

        Example:

        zones:
        - Helsinki
        - Espoo
        - Tampere
        
    • criobject

      Container runtime parameters.

      • containerdobject

        Containerd runtime parameters.

        If used, cri.type must be set to Containerd.

        • maxConcurrentDownloadsinteger

          Set the max concurrent downloads for each pull.

          Default: 3

      • typestring

        Container runtime type.

        Value defaultCRI from the initial cluster configration (cluster-configuration.yaml parameter from the d8-cluster-configuration secret in the kube-system namespace) is used if not specified.

        Allowed values: Docker, Containerd, NotManaged

    • disruptionsobject

      Disruptions settings for nodes.

      Example:

      disruptions:
        approvalMode: Automatic
        automatic:
          drainBeforeApproval: false
          windows:
          - from: '06:00'
            to: '08:00'
            days:
            - Tue
            - Sun
      
      • approvalModestring

        The approval mode for disruptive updates:

        • Manual — disable automatic disruption approval; the alert will be displayed if disruption is needed. Caution! The master node group update mode must be Manual to avoid issues with draining.
        • Automatic — automatically approve disruption-involving updates.
        • RollingUpdate — in this mode, a new node with new settings will be created; then, the old node will be deleted. Available only for cloud nodes.

        Default: "Automatic"

        Allowed values: Manual, Automatic, RollingUpdate

      • automaticobject

        Additional parameters for the Automatic mode.

        • drainBeforeApprovalboolean

          Drain Pods from the nodes before approving disruption.

          Caution! This setting ignores (nodes will be approved without draining Pods):

          • for the nodeGroup master with a single node;
          • for a single ready node in a nodeGroup picked out for Deckhouse placement.

          Default: true

        • windowsarray of objects

          Time windows for node disruptive updates.

          • daysarray of strings

            Days of the week when node could be updated.

            Example:

            days:
            - Mon
            - Wed
            
            • Element of the arraystring

              Day of the week.

              Allowed values: Mon, Tue, Wed, Thu, Fri, Sat, Sun

          • fromstring

            Required value

            Start time of disruptive update window (UTC timezone).

            Pattern: ^(?:\d|[01]\d|2[0-3]):[0-5]\d$

            Example:

            from: '13:00'
            
          • tostring

            Required value

            End time of disruptive update window (UTC timezone).

            Pattern: ^(?:\d|[01]\d|2[0-3]):[0-5]\d$

            Example:

            to: '18:30'
            
      • rollingUpdateobject

        Additional parameters for the RollingUpdate mode.

        • windowsarray of objects

          Time windows for node disruptive updates.

          • daysarray of strings

            Days of the week when node could be updated.

            Example:

            days:
            - Mon
            - Wed
            
            • Element of the arraystring

              Day of the week.

              Allowed values: Mon, Tue, Wed, Thu, Fri, Sat, Sun

          • fromstring

            Required value

            Start time of disruptive update window (UTC timezone).

            Pattern: ^(?:\d|[01]\d|2[0-3]):[0-5]\d$

            Example:

            from: '13:00'
            
          • tostring

            Required value

            End time of disruptive update window (UTC timezone).

            Pattern: ^(?:\d|[01]\d|2[0-3]):[0-5]\d$

            Example:

            to: '18:30'
            
    • dockerobject

      Docker settings for nodes.

      If used, cri.type must be set to Docker.

      • manageboolean

        Enable Docker maintenance from bashible.

        Default: true

      • maxConcurrentDownloadsinteger

        Set the max concurrent downloads for each pull.

        Default: 3

    • kubeletobject

      Kubelet settings for nodes.

      • containerLogMaxFilesinteger

        How many rotated log files to store before deleting them.

        WARNING! This parameter does nothing if CRI type is Docker.

        Default: 4

        Allowed values: 1 <= X <= 20

      • containerLogMaxSizestring

        Maximum log file size before it is rotated.

        WARNING! This parameter does nothing if CRI type is Docker.

        Default: "50Mi"

        Pattern: \d+[Ei|Pi|Ti|Gi|Mi|Ki|E|P|T|G|M|k|m]

      • maxPodsinteger

        Set the max count of pods per node.

        Default: 110

      • rootDirstring

        Directory path for managing kubelet files (volume mounts,etc).

        Default: "/var/lib/kubelet"

    • kubernetesVersionstring

      The desired minor version of Kubernetes.

      By default, it corresponds to the version selected for the cluster globally (see installation documentation) or to the current version of the control plane (if the global version is not defined).

      Allowed values: 1.20, 1.21, 1.22, 1.23, 1.24

      Example:

      kubernetesVersion: '1.21'
      
    • nodeTemplateobject

      Specification of some of the fields that will be maintained in all nodes of the group.

      Example:

      labels:
        environment: production
        app: warp-drive-ai
      annotations:
        ai.fleet.com/discombobulate: "true"
      taints:
      - effect: NoExecute
        key: ship-class
        value: frigate
      
      • annotationsobject

        Similar to the standard metadata.annotations field.

        Example:

        annotations:
          ai.fleet.com/discombobulate: "true"
        
      • labelsobject

        Similar to the standard metadata.labels field.

        Example:

        labels:
          environment: production
          app: warp-drive-ai
        
      • taintsarray of objects

        Similar to the .spec.taints field of the Node object.

        Caution! Only effect, key, value fields are available.

        Example:

        taints:
        - effect: NoExecute
          key: ship-class
          value: frigate
        
        • effectstring

          Allowed values: NoSchedule, PreferNoSchedule, NoExecute

        • keystring
        • valuestring
    • nodeTypestring

      Required value

      The type of nodes this group provides.

      • Cloud — nodes for this group will be automatically created (and deleted) in the cloud of the specified cloud provider;
      • Static — a static node hosted on a bare metal or virtual machine. The cloud-controller-manager does not manage the node even of one of the cloud providers is enabled;
      • Hybrid — a static node (created manually or using any external tools) hosted in the cloud integrated with one of the cloud provider. This node has the CSI running, and it is managed by the cloud-controller-manager: the Node object automatically gets the information about the zone and region based on the cloud data; if a node gets deleted from the cloud, its corresponding Node object will be deleted in Kubernetes.

      Allowed values: Cloud, Static, Hybrid

    • operatingSystemobject

      Operating System settings for nodes.

      • manageKernelboolean

        Enable kernel maintenance from bashible.

        Default: true

    • staticobject

      Static node parameters

      • internalNetworkCIDRsarray of strings

        Subnet CIDR

NodeGroupConfiguration

Scope: Cluster
Version: v1alpha1

  • specobject

    Required value

    • bundlesarray of strings

      Required value

      Bundles for step execution. You can set '*' for selecting all bundles.

      Examples:

      bundles:
      - ubuntu-lts
      - centos-7
      
      bundles:
      - ubuntu-lts
      
      bundles:
      - "*"
      
    • contentstring

      Required value

      The content of the step. Can be either Go Template or plain bash.

    • nodeGroupsarray of strings

      Required value

      List of NodeGroups to apply the step for. You can set '*' for selecting all NodeGroups.

      Examples:

      nodeGroups:
      - master
      - worker
      
      nodeGroups:
      - worker
      
      nodeGroups:
      - "*"
      
    • weightinteger

      Order of the step execution.

      Default: 100

NodeUser

Scope: Cluster

Defines the linux users to create on all nodes.

The user’s home directory is created in the /home/deckhouse/ directory.

  • specobject

    Required value

    • extraGroupsarray of strings

      Node user additional system groups.

      Examples:

      extraGroups:
      - docker
      
      extraGroups:
      - docker
      - ftp
      
    • isSudoerboolean

      Persistence of node user in sudo group.

      Default: false

      Example:

      isSudoer: true
      
    • nodeGroupsarray of strings

      List of NodeGroups to apply the user for.

      Default: ["*"]

      Examples:

      nodeGroups:
      - master
      - worker
      
      nodeGroups:
      - worker
      
      nodeGroups:
      - "*"
      
    • passwordHashstring

      Hashed user password.

      The format corresponds to the password hashes in /etc/shadow. Yoou can get it using the following command: openssl passwd -6.

      Example:

      passwordHash: "$2a$10$F9ey7zW.sVliT224RFxpWeMsgzO.D9YRG54a8T36/K2MCiT41nzmC"
      
    • sshPublicKeystring

      Node user SSH public key.

      Either sshPublicKey or sshPublicKeys must be specified.

      Example:

      sshPublicKey: ssh-rsa AAABBB
      
    • sshPublicKeysarray of strings

      Node user SSH public keys.

      Either sshPublicKey or sshPublicKeys must be specified.

      Example:

      sshPublicKeys:
      - ssh-rsa AAABBB
      - ssh-rsa BBBCCC
      
    • uidnumber

      Required value

      Node user ID.

      This parameter does not change during the entire resource life.

      Allowed values: 1001 <= X

      Example:

      uid: 1001
      

Defines the linux users to create on all nodes.

The user’s home directory is created in the /home/deckhouse/ directory.

  • specobject

    Required value

    • extraGroupsarray of strings

      Node user additional system groups.

      Examples:

      extraGroups:
      - docker
      
      extraGroups:
      - docker
      - ftp
      
    • isSudoerboolean

      Persistence of node user in sudo group.

      Default: false

      Example:

      isSudoer: true
      
    • nodeGroupsarray of strings

      List of NodeGroups to apply the user for.

      Default: ["*"]

      Examples:

      nodeGroups:
      - master
      - worker
      
      nodeGroups:
      - worker
      
      nodeGroups:
      - "*"
      
    • passwordHashstring

      Hashed user password.

      The format corresponds to the password hashes in /etc/shadow. Yoou can get it using the following command: openssl passwd -6.

      Example:

      passwordHash: "$2a$10$F9ey7zW.sVliT224RFxpWeMsgzO.D9YRG54a8T36/K2MCiT41nzmC"
      
    • sshPublicKeystring

      Node user SSH public key.

      Either sshPublicKey or sshPublicKeys must be specified.

      Example:

      sshPublicKey: ssh-rsa AAABBB
      
    • sshPublicKeysarray of strings

      Node user SSH public keys.

      Either sshPublicKey or sshPublicKeys must be specified.

      Example:

      sshPublicKeys:
      - ssh-rsa AAABBB
      - ssh-rsa BBBCCC
      
    • uidnumber

      Required value

      Node user ID.

      This parameter does not change during the entire resource life.

      Allowed values: 1001 <= X

      Example:

      uid: 1001