v1

latestOpenAPI 3.0.12026-07-23429391.9 KB
Cluster

Get the list of clusters currently setup in PMK

get/v4/{projectId}/clusters

Path parameters

projectIdstring required

UUID of the project the cluster belongs to

Headers

X-Auth-Tokenstring required

Response

OK

namestring

Name of the cluster

uuidstring

UUID of the cluster

created_atstring

Creation time of the cluster

projectIdstring

UUID of the Keystone project that this cluster is part of

isKubernetesinteger

Field is set to 1 if the cluster is a Kubernetes cluster, 0 otherwise

kubeRoleVersionstring

The version of the pf9-kube role

etcdVersionstring

The version of etcd used for cluster

isAirgappedinteger

Field is set to 1 if the cluster is air-gapped, 0 otherwise

useHostnameboolean

(optioanl) If set to true nodes will be registered in the cluster using hostname instead of IP address. This option is only applicable to IPv4 hosts. This option is ignored when deploying clusters on IPv6 enabled hosts and public clouds - AWS, Azure, etc.

allowWorkloadsOnMasterinteger

Field is set to 1 if the master nodes can run non-critical workloads

containerRuntimestring

(optional) Container runtime for this cluster. Valid values: [docker, containerd]

containersCidrstring

CIDR used for container IP addresses

servicesCidrstring

CIDR used for service IP addresses

externalDnsNamestring

Optional DNS name for API endpoint. This field is autogenerated when pf9 domain is used.

privilegedinteger

Field is set to 1 if cluster runs privileged containers, 0 otherwise

runtimeConfigstring
kubeProxyModestring

The mode of kube proxy

apiserverStorageBackendstring

The storage backend of the api server

k8sApiPortstring

Port on which K8S API Server will listen, 443 by default

masterIpstring

Ip of the master node, applicable only for cloud provider type 'openstack'

masterVipIpv4string

API server Virtual IP that provides failover if specified for the cluster. Defaults to empty string

masterVipIfacestring

The interface that VIP attaches to if specified. Defaults to empty string

masterVipVrouterIdstring

Virtual router id choosen for the cluster. Range: 0-254. Emptry string if masterVipIpv4 not specified

networkPluginstring

Network backend to use for container networking. Defaults to flannel. Supported choices are flannel, calico, noop, weave

addonOperatorImageTagstring

(optional) addon operator image tag for this cluster.

dockerRootstring

Root directory for docker

etcdDataDirstring

Data directory for etcd. The field is applicable to master nodes only

certExpiryHrsinteger

(optional) Number of hours before user certificates in kubeconfig expires, should be greater than 0 if set. Default is 24hrs.

keystoneEnabledinteger

Field is set to 1 if keystone is enabled, 0 otherwise

authzEnabledinteger

Field is set to 1 if authz is enabled, 0 otherwise

appCatalogEnabledinteger

DEPRECATED. Field doesn't lead to any action on the cluster now. Field is set to 1 if app catalog is enabled, 0 otherwise

enableProfileAgentboolean

(optional) If set to true platform9 profile engine agent will be deployed on the cluster. This agent is required to be able to use profiles.

enableEtcdEncryptionstring

States whether tls encryption is enabled on etcd, Default:false

ipv6boolean

Set to 1 if ipv6 enabled. Defaults to 0

enableMetallbboolean

1 if metallb enabled. Defaults to 0

metallbCidrstring

Comma separated pools of IPs like A.B.C.D-E.F.G.H, I.J.K.L-M.N.O.P that metallb will manage if specified

base64EncMetallbConfigstring

Base64 encoded string of metallb custom resource yaml

nodePoolUuidstring

UUID of the node pool used for the cluster

nodePoolNamestring

Name of the node pool used for the cluster

cloudProviderUuidstring

UUID of the cloud provider used to create this cluster

cloudProviderNamestring

Name of the cloud provider used to create this cluster

cloudProviderTypestring

Type of the cloud provider used to create this cluster

tagsobject

User defined key-value pairs represented as a JSON object

mtuSizestring

MTU for container network interfaces. Optional and used for the Calico network backend

cpuManagerPolicystring

options: none, static; default: none

topologyManagerPolicystring

options: none, best-effort, restricted, single-numa-node; default: none

reservedCPUsstring

list of CPUs to be reserved for the system. Ex: 1-3,5

numMastersinteger

Number of master nodes in the cluster

numWorkersinteger

Number of worker nodes in the cluster

statusstring

Status of the cluster

masterStatusstring

Status of the master nodes. 'healthy' means all masters are healthy. 'partially healthy' means quorum number of masters are healthy, but some are not. 'unhealthy' means quorum number of master are unhealthy

workerStatusstring

Status of the worker nodes. 'healthy' means all workers are healthy. 'partially healthy' means more than 50% of the workers are healthy, rest are unhealthy. 'unhealthy' means more than 50% of the workers are unhealthy

lastOpstring

The last operation such as node attach or node detach that was performed on the cluster

lastOkstring

The timestamp when the cluster last reported an OK status

taskStatusstring

Status of the last task that run on the cluster.

taskErrorstring

Error details if the last task on cluster did not succeed

debugstring

enable debug

masterlessinteger

1 if masterless cluster, 0 otherwise

upgradingTostring

The version that the cluster is upgrading to

canUpgradeboolean

Field is set to true if the cluster can be upgraded, false otherwise

canMinorUpgradeinteger

Field is set to 1 if the cluster can be upgraded to a minor version, 0 otherwise

canPatchUpgradeinteger

Field is set to 1 if the cluster can be upgraded to a patch version, 0 otherwise

minorUpgradeRoleVersionstring

The minor version of the pf9-kube role that can be upgraded

patchUpgradeRoleVersionstring

The patch version of the pf9-kube role that can be upgraded

flannelIfaceLabelstring

The interface used by flannel for interhost communication

flannelPublicIfaceLabelstring

The IP address used as the flannel public IP for the nodes in the cluster

calicoIPv4string

Calico IPv4 mode

calicoIPv4DetectionMethodstring

Calico IPv4 detection method

calicoV4BlockSizestring

Subnet size per node for the Calico network, in CIDR notation (e.g. 26)

calicoIPv6string

Calico IPv6 mode

calicoIPv6DetectionMethodstring

Calico IPv6 detection method

calicoIPv6PoolCidrstring

Calico IPv6 pool CIDR

calicoIPv6PoolBlockSizestring

Calico IPv6 pool block size

calicoIPv6PoolNatOutgoinginteger

Calico IPv6 pool NAT outgoing

calicoRouterIDstring

Calico router ID

calicoIpIpModestring

IP-IP encapsulation mode for Calico network. Choose: Always, Never, CrossSubnet

calicoNatOutgoingboolean

Field is set to true if Calico nodes need to NAT north-south egress traffic.

calicoNodeCpuLimitstring

Corresponds to the CALICO_NODE_CPU_LIMIT environment variable in Calico.

calicoNodeMemoryLimitstring

Corresponds to the CALICO_NODE_MEMORY_LIMIT environment variable in Calico.

calicoTyphaCpuLimitstring

Corresponds to the CALICO_TYPHA_CPU_LIMIT environment variable in Calico.

calicoTyphaMemoryLimitstring

Corresponds to the CALICO_TYPHA_MEMORY_LIMIT environment variable in Calico.

calicoControllerCpuLimitstring

Corresponds to the CALICO_CONTROLLER_CPU_LIMIT environment variable in Calico.

calicoControllerMemoryLimitstring

Corresponds to the CALICO_CONTROLLER_MEMORY_LIMIT environment variable in Calico.

felixIPv6Supportinteger

Field is set to true if Felix supports IPv6

dockerCentosPackageRepoUrlstring

(optional) URL of the centos repo to be used for docker installation

dockerUbuntuPackageRepoUrlstring

(optional) URL of the ubuntu repo to be used for docker installation

dockerPrivateRegistrystring

(optional) URL of private Docker registry to fetch Platform9 images from

quayPrivateRegistrystring

(optional) URL of private Quay registry to fetch Platform9 images from

gcrPrivateRegistrystring

(optional) URL of private GCR registry to fetch Platform9 images from

k8sPrivateRegistrystring

(optional) URL of private K8S registry to fetch Platform9 images from

customRegistryUrlstring

URL for a custom registry that is expected to serve all images for the cluster

customRegistryRepoPathstring

path in custom registry where all images are cached

customRegistryUsernamestring

username for the custom registry

customRegistryPasswordstring

password for the custom registry

customRegistrySkipTlsboolean

configure containerd to skip tls verification for custom registry

customRegistrySelfSignedCertsboolean

Set to true if the custom registry uses self signed certs

customRegistryCertPathstring

Path to the cert file for the custom registry if using self signed certs. Can be of the following formats: [https://example.com/path/to/cert, http://example.com/path/to/cert, file:///path/to/cert, /path/to/cert]