v1
latestOpenAPI 3.0.12026-07-23429391.9 KBGet the list of clusters currently setup in PMK
Path parameters
UUID of the project the cluster belongs to
Headers
Response
OK
Name of the cluster
UUID of the cluster
Creation time of the cluster
UUID of the Keystone project that this cluster is part of
Field is set to 1 if the cluster is a Kubernetes cluster, 0 otherwise
The version of the pf9-kube role
The version of etcd used for cluster
Field is set to 1 if the cluster is air-gapped, 0 otherwise
(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.
Field is set to 1 if the master nodes can run non-critical workloads
(optional) Container runtime for this cluster. Valid values: [docker, containerd]
CIDR used for container IP addresses
CIDR used for service IP addresses
Optional DNS name for API endpoint. This field is autogenerated when pf9 domain is used.
Field is set to 1 if cluster runs privileged containers, 0 otherwise
The mode of kube proxy
The storage backend of the api server
Port on which K8S API Server will listen, 443 by default
Ip of the master node, applicable only for cloud provider type 'openstack'
API server Virtual IP that provides failover if specified for the cluster. Defaults to empty string
The interface that VIP attaches to if specified. Defaults to empty string
Virtual router id choosen for the cluster. Range: 0-254. Emptry string if masterVipIpv4 not specified
Network backend to use for container networking. Defaults to flannel. Supported choices are flannel, calico, noop, weave
(optional) addon operator image tag for this cluster.
Root directory for docker
Data directory for etcd. The field is applicable to master nodes only
(optional) Number of hours before user certificates in kubeconfig expires, should be greater than 0 if set. Default is 24hrs.
Field is set to 1 if keystone is enabled, 0 otherwise
Field is set to 1 if authz is enabled, 0 otherwise
DEPRECATED. Field doesn't lead to any action on the cluster now. Field is set to 1 if app catalog is enabled, 0 otherwise
(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.
States whether tls encryption is enabled on etcd, Default:false
Set to 1 if ipv6 enabled. Defaults to 0
1 if metallb enabled. Defaults to 0
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
Base64 encoded string of metallb custom resource yaml
UUID of the node pool used for the cluster
Name of the node pool used for the cluster
UUID of the cloud provider used to create this cluster
Name of the cloud provider used to create this cluster
Type of the cloud provider used to create this cluster
User defined key-value pairs represented as a JSON object
MTU for container network interfaces. Optional and used for the Calico network backend
options: none, static; default: none
options: none, best-effort, restricted, single-numa-node; default: none
list of CPUs to be reserved for the system. Ex: 1-3,5
Number of master nodes in the cluster
Number of worker nodes in the cluster
Status of the cluster
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
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
The last operation such as node attach or node detach that was performed on the cluster
The timestamp when the cluster last reported an OK status
Status of the last task that run on the cluster.
Error details if the last task on cluster did not succeed
enable debug
1 if masterless cluster, 0 otherwise
The version that the cluster is upgrading to
Field is set to true if the cluster can be upgraded, false otherwise
Field is set to 1 if the cluster can be upgraded to a minor version, 0 otherwise
Field is set to 1 if the cluster can be upgraded to a patch version, 0 otherwise
The minor version of the pf9-kube role that can be upgraded
The patch version of the pf9-kube role that can be upgraded
The interface used by flannel for interhost communication
The IP address used as the flannel public IP for the nodes in the cluster
Calico IPv4 mode
Calico IPv4 detection method
Subnet size per node for the Calico network, in CIDR notation (e.g. 26)
Calico IPv6 mode
Calico IPv6 detection method
Calico IPv6 pool CIDR
Calico IPv6 pool block size
Calico IPv6 pool NAT outgoing
Calico router ID
IP-IP encapsulation mode for Calico network. Choose: Always, Never, CrossSubnet
Field is set to true if Calico nodes need to NAT north-south egress traffic.
Corresponds to the CALICO_NODE_CPU_LIMIT environment variable in Calico.
Corresponds to the CALICO_NODE_MEMORY_LIMIT environment variable in Calico.
Corresponds to the CALICO_TYPHA_CPU_LIMIT environment variable in Calico.
Corresponds to the CALICO_TYPHA_MEMORY_LIMIT environment variable in Calico.
Corresponds to the CALICO_CONTROLLER_CPU_LIMIT environment variable in Calico.
Corresponds to the CALICO_CONTROLLER_MEMORY_LIMIT environment variable in Calico.
Field is set to true if Felix supports IPv6
(optional) URL of the centos repo to be used for docker installation
(optional) URL of the ubuntu repo to be used for docker installation
(optional) URL of private Docker registry to fetch Platform9 images from
(optional) URL of private Quay registry to fetch Platform9 images from
(optional) URL of private GCR registry to fetch Platform9 images from
(optional) URL of private K8S registry to fetch Platform9 images from
URL for a custom registry that is expected to serve all images for the cluster
path in custom registry where all images are cached
username for the custom registry
password for the custom registry
configure containerd to skip tls verification for custom registry
Set to true if the custom registry uses self signed certs
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]