Listing Your Node Pools

You can list the node pools you have created. This action also returns information about their status and type.

Listing Node Pools Using OKS CLI

The cluster nodepool list command allows you to see the existing node pools for the specified cluster.

Request sample
$ oks-cli cluster nodepool \
--project-name NAME_OF_PROJECT \
--cluster-name NAME_OF_CLUSTER \
list

This command contains the following options that you need to specify:

  • cluster-name: The name of the cluster, with a maximum length of 40 alphanumeric characters and dashes (-). This name must not start or end with a dash, and it must be unique within the project.

  • (optional) project-name: The name of the project where the cluster will be created.

Result sample
NAME        TYPE            DESIRED NODES   ATTACHED   READY   RUNNING   PENDING   STOPPING   STOPPED   SHUTTING DOWN   CURRENT PROCESSING PHASE   LAST ERROR
default     tinav6.c1r1p2   2               2          2       2         0         0          0         0               idle                       None
second      tinav6.c2r2p2   2               0          0       2         0         0          0         0               pending                    None

Listing Node pools Using Kubectl

The kubectl get nodepools.oks.dev command allows you to see the existing node pools for the specified cluster.

The available aliases are:

  • nodepools.oks.dev

  • npools

  • npls

  • npl

Request sample
$ kubectl get nodepools.oks.dev
Result sample
NAME        TYPE            DESIRED NODES   ATTACHED   READY   RUNNING   PENDING   CURRENT PROCESSING PHASE
default     tinav6.c1r1p2   2               2          2       2         0         idle
second      tinav6.c1r1p2   2               0          0       2         0         pending

You can use the -w option to permanently watch the node pools state changes.

Getting More Information About Your Node Pools

You can get information about your node pools using the kubectl get npl NODEPOOL_NAME command. Depending on the following parameter, this command returns a YAML / JSON / plain text / etc output in which you can find the ID of the OUTSCALE account running your clusters (oks.account-id), and the ID of the applied security group (oks.nodepool.security-group).

Request sample
$ kubectl get npl -oyaml

Related Pages

Export to PDF