Getting Information About a Node Pool

You can get information about the node pools you have created.

Getting Information About a Node Pool Using kubectl

To get information about your node pools, use the kubectl get npl command following this syntax:

Request sample
$ kubectl get npl NAME_OF_NODEPOOL --output yaml

This command contains the following option that you may need to specify:

  • (optional) output: The output format for the response (json | yaml | wide).

The kubectl get npl command returns the following elements:

  • apiVersion: The API version used by the CustomResourceDefinition (CRD). It identifies the schema version for the NodePool resource.

  • kind: The type of Kubernetes resource, always NodePool in this case.

  • metadata: The metadata information for the node pool.

    • labels: The labels attached to the node pool.

      • oks.account-id: The ID of the OUTSCALE account running your clusters.

      • oks.network_id: The ID of your project’s control plane network.

      • oks.nodepool.security-group: The ID of the applied security group.

    • name: The name of the node pool.

    • resourceVersion: The API server’s version identifier for the node pool.

    • uid: The Universally Unique Identifier (UUID) of the node pool.

  • spec: The specification for the node pool configuration.

    • autoHealing: If true, the automatic healing of NotReady nodes is enabled.

    • autoscaling: If true, autoscaling is enabled.

    • desiredNodes: The number of desired nodes in the node pool.

    • maxNodes: The maximum number of nodes the autoscaler can scale up to.

    • minNodes: The minimum number of nodes the autoscaler is allowed to maintain.

    • nodeType: The type of VM for the nodes.

    • taint: If true, a node pool specific taint is added to each worker node of the node pool upon creation.

    • upgradeStrategy: The configuration for managing node pool upgrades.

      • autoUpgradeEnabled: If true, automatic upgrades for the node pool are enabled.

      • autoUpgradeMaintenance: The configuration for the automated upgrade maintenance window.

        • durationHours: The duration of the maintenance window, in hours.

        • startHour: The starting time of the maintenance window, in hours, in 24-hour format (0–23).

        • weekDay: The weekday on which the maintenance window begins.

      • maxSurge: The maximum number of extra nodes that can be created during an upgrade.

      • maxUnavailable: The maximum number of nodes that can be unavailable during an upgrade.

    • volumes: The list of volume configurations for the nodes.

      • device: The /dev/XXX device in which the volume is located. It can be either root, xvdX or xvdXY, where X is a letter between b and z, and Y is a letter between a and z.

      • dir: The mount point directory path for the volume.

      • filesystem: The file system that was used to create and mount the volume.

      • iops: The number of I/O operations per second (IOPS).

      • size: The size of the volume, in gibibytes (GiB).

      • type: The type of volume, among the volume types supported by 3DS OUTSCALE (gp2, io1, standard).

    • zones: The list of Subregions where nodes are deployed.

Result sample
apiVersion: oks.dev/v1beta2
kind: NodePool
metadata:
  ...
  labels:
    oks.account-id: "123456789876"
    oks.network_id: vpc-1a2b3c4d
    oks.nodepool.security-group: sg-abcd1ef2
  name: testnodepool
  resourceVersion: "1234"
  uid: 12a345bc-d678-9e87-f65g-h4321i234jk5
spec:
  autoHealing: true
  autoscaling: false
  desiredNodes: 2
  maxNodes: 0
  minNodes: 0
  nodeType: tinav6.c1r1p2
  taint: false
  upgradeStrategy:
    autoUpgradeEnabled: true
    autoUpgradeMaintenance:
      durationHours: 1
      startHour: 12
      weekDay: Tue
    maxSurge: 0
    maxUnavailable: 1
  volumes:
  - device: root
    dir: /
    filesystem: ext4
    iops: 0
    size: 100
    type: gp2
  zones:
  - eu-west-2a
  ...

Related Pages

Export to PDF