xxxxxxxxxx
 
curl --get \ --url 'https://localhost/qbert/v4/%7BprojectId%7D/clusters/%7Buuid%7D/addons' \ --header 'X-Auth-Token: {X-Auth-Token}'
Copy

Responses application/json

200

OK, after request is submitted successfully

No response body

403

Unauthorized to perform this operation

Response

xxxxxxxxxx
 
No response
Copy

Perform either addition/updation/upgrade operation on addon

Auth

Headers

X-Auth-Token string

Path Params

projectId	string	UUID of the project the cluster belongs to
uuid	string	UUID of the cluster

Request Body

object	object
name	string	name of the addon to be deployed
version	string	addon operator version of the kudo package
namespace	string	namespace under which the addon operator will be deployed
operation	string	operation to be performed - install/upgrade/uninstall

POST /v4/{projectId}/clusters/{uuid}/addons

xxxxxxxxxx
 
curl --request POST \ --url 'https://localhost/qbert/v4/%7BprojectId%7D/clusters/%7Buuid%7D/addons' \ --header 'X-Auth-Token: {X-Auth-Token}' \ --data '{  "name": "{string}",  "version": "{string}",  "namespace": "{string}",  "operation": "{string}"}'
Copy

Responses application/json

200

OK, after request is submitted successfully

No response body

403

Unauthorized to perform this operation

Response

xxxxxxxxxx
 
No response
Copy

Creates a cluster using auto deploy or manual mode

Auth

Headers

X-Auth-Token string

Path Params

projectId

string

UUID of the project the cluster belongs to

Request Body

object	object
allowWorkloadsOnMaster	integer	Field is set to 1 if the master nodes can run non-critical workloads
ami	string	AMI ID used to provision cluster nodes
appCatalogEnabled	integer	Field is set to 1 if app catalog is enabled, 0 otherwise, applicable also for manual deploy
azs	array[string]	Availability zone(s) the cluster is deployed in
calicoV4BlockSize	string	Subnet size per node for the Calico network, in CIDR notation (e.g. 26)
calicoIpIpMode	string	IP-IP encapsulation mode for Calico network. Choose: Always, Never, CrossSubnet
calicoNatOutgoing	boolean	Field is set to true if Calico nodes need to NAT north-south egress traffic.
containersCidr	string	CIDR used for container IP addresses, applicable also for manual deploy
dockerLiveRestoreEnabled	boolean	Enables the use of Docker live restore as described here: https://docs.docker.com/config/containers/live-restore/
domainId	string	Domain used for cluster FQDNs
enableMetallb	boolean	If true, install MetalLB to support the loadbalancer service-type
enableCAS	boolean	If true, cluster autoscaling is enabled (only for AWS clusters).
isEtcdBackupEnabled	boolean	Set to true if etcd backup should be enabled, false otherwise
intervalInMins	integer	etcd backup interval, specified in minutes
storageType	string	Storage type for the etcd backup. Only 'local' is current supported type. 'local' saves backup to the node's local disk
localPath	string	Path on the local filesystem where the etcd backup should be stored. For 'local' storage type only.
externalDnsName	string	Optional DNS name for API endpoint. This field is autogenerated when usePf9Domain is set, also applicable for manual deploy
httpProxy	string	The http proxy used for node communications. This parameter is required when internalElb is set to true and the private subnet selected does not route IP packets to the internet through a VPN
internalElb	boolean	Set to true if load balancer is an internal load balancer or false for an Internet-facing load balancer. More information here: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-internal-load-balancers.html. Setting this parameter to true requires that isPrivate is set to true. If the private subnet selected is not configured to route IP packets through a VPN, then an httpProxy is required for node communications to work
isPrivate	boolean	Set to true if nodes are deployed using public subnet, false otherwise, applicable also for manual deploy. This parameter is required if internalElb is set to true.
k8sApiPort	string	Port on which K8S API Server will listen, 443 by default
masterFlavor	string	Node flavor used for master node
masterVipIpv4	string	API server Virtual IP that provides failover. When specified, deploy keepalived setup to cluster master nodes together
masterVipIface	string	If masterVipIpv4 is specified, this field is required. Specify the interface that the VIP attaches to
metallbCidr	string	If enableMetallb is true, specify the comma-separated pools of IPs that MetalLB will manage (for example: A.B.C.D-E.F.G.H, I.J.K.L-M.N.O.P)
mtuSize	string	MTU for container network interfaces. Optional and used for the Calico network backend
name	string	Name of the cluster, applicable also for manual deploy
networkPlugin	string	Network backend to use for container networking. Defaults to flannel. Supported choices are flannel, calico, noop, weave
nodePoolUuid	string	UUID of the node pool used for the cluster, applicable also for manual deploy
numMasters	integer	Number of master nodes in the cluster
numWorkers	integer	Number of worker nodes in the cluster
numMinWorkers	integer	This parameter is required if enableCAS is set to true. This is the minimum number of worker nodes in ASG
numMaxWorkers	integer	This parameter is required if enableCAS is set to true. This is the maximum number of worker nodes in ASG
privateSubnets	array[string]	The private subnet ID to which the cluster is deployed. This parameter is optional if vpc (VPC ID) is set. This parameter is required if vpc (VPC ID) is set and isPrivate is set to true. This parameter is ignored if vpc (VPC ID) is not set
privileged	boolean	Field is set to 1 if cluster runs privileged containers, 0 otherwise
region	string	Cloud provider region in which the cluster was created
runtimeConfig	string	Applicable also for manual deploy
serviceFqdn	string	FQDN used to reference cluster services
servicesCidr	string	CIDR used for service IP addresses, applicable also for manual deploy
sshKey	string	Public SSH key associated with the cluster nodes
subnets	array[string]
tags	object	User defined key-value pairs represented as a JSON object
usePf9Domain	boolean	Set to true if platform9.net domain is used, false otherwise
vpc	string	If set, creates cluster using this VPC ID. Otherwise, the cluster is deployed on a new VPC. This parameter is required if internalElb is set to true
workerFlavor	string	Node flavor used for worker node
kubeRoleVersion	string	Pf9-kube role version to be used when bringing up the cluster.
cpuManagerPolicy	string	options: none, static; default: none
topologyManagerPolicy	string	options: none, best-effort, restricted, single-numa-node; default: none
reservedCPUs	string	list of CPUs to be reserved for the system. Ex: 1-3,5
dockerPrivateRegistry	string	(optional) URL of private Docker registry to fetch Platform9 images from
quayPrivateRegistry	string	(optional) URL of private Quay registry to fetch Platform9 images from
gcrPrivateRegistry	string	(optional) URL of private GCR registry to fetch Platform9 images from
k8sPrivateRegistry	string	(optional) URL of private K8S registry to fetch Platform9 images from

Expand

POST /v4/{projectId}/clusters

xxxxxxxxxx
 
curl --request POST \ --url 'https://localhost/qbert/v4/%7BprojectId%7D/clusters' \ --header 'X-Auth-Token: {X-Auth-Token}' \ --data '{  "allowWorkloadsOnMaster": "{integer}",  "ami": "{string}",  "appCatalogEnabled": "{integer}",  "azs": [    "{array[string]...}"  ],  "calicoV4BlockSize": "{string}",  "calicoIpIpMode": "{string}",  "calicoNatOutgoing": "{boolean}",  "containersCidr": "{string}",  "dockerLiveRestoreEnabled": "{boolean}",  "domainId": "{string}",  "enableMetallb": "{boolean}",  "enableCAS": "{boolean}",  "etcdBackup": "{}",  "externalDnsName": "{string}",  "httpProxy": "{string}",  "internalElb": "{boolean}",  "isPrivate": "{boolean}",  "k8sApiPort": "{string}",  "masterFlavor": "{string}",  "masterVipIpv4": "{string}",  "masterVipIface": "{string}",  "metallbCidr": "{string}",  "mtuSize": "{string}",  "name": "{string}",  "networkPlugin": "{string}",  "nodePoolUuid": "{string}",  "numMasters": "{integer}",  "numWorkers": "{integer}",  "numMinWorkers": "{integer}",  "numMaxWorkers": "{integer}",  "privateSubnets": [    "{array[string]...}"  ],  "privileged": "{boolean}",  "region": "{string}",  "runtimeConfig": "{string}",  "serviceFqdn": "{string}",  "servicesCidr": "{string}",  "sshKey": "{string}",  "subnets": [    "{array[string]...}"  ],  "tags": {},  "usePf9Domain": "{boolean}",  "vpc": "{string}",  "workerFlavor": "{string}",  "kubeRoleVersion": "{string}",  "cpuManagerPolicy": "{string}",  "topologyManagerPolicy": "{string}",  "reservedCPUs": "{string}",  "dockerPrivateRegistry": "{string}",  "quayPrivateRegistry": "{string}",  "gcrPrivateRegistry": "{string}",  "k8sPrivateRegistry": "{string}"}'
Copy

Expand

Responses application/json

200

OK, if cluster create request was submitted successfully

No response body

403

Unauthorized to perform this operation

Response

xxxxxxxxxx
 
No response
Copy

Upgrade a cluster, identified by the uuid

Auth

Headers

X-Auth-Token string

Path Params

uuid	string	UUID of the cluster
project_uuid	string	UUID of the project the cloud provider account belongs to

Request Body

object	object
batchUpgradePercent	number	Number between 1-100 which represents the percent of worker nodes to upgrade in parallel at once during an upgrade

POST /v4/{project_uuid}/clusters/{uuid}/upgrade

xxxxxxxxxx
 
curl --request POST \ --url 'https://localhost/qbert/v4/%7Bproject_uuid%7D/clusters/%7Buuid%7D/upgrade' \ --header 'X-Auth-Token: {X-Auth-Token}' \ --data '{  "batchUpgradePercent": "{number}"}'
Copy

Responses application/json

200

OK, if upgrade request is successfully issued

No response body

403

Unauthorized to perform this operation

Response

xxxxxxxxxx
 
No response
Copy

Delete all cluster addons for a PMK cluster as specified by the cluster UUID

Auth

Headers

X-Auth-Token string

Path Params

clusterId	string	UUID of the cluster
projectId	string	UUID of the project the cluster belongs to

DELETE /v4/{projectId}/clusters/{clusterId}/addons

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://localhost/qbert/v4/%7BprojectId%7D/clusters/%7BclusterId%7D/addons' \ --header 'X-Auth-Token: {X-Auth-Token}'
Copy

Responses application/json

200

OK, if clusteraddons delete request was submitted successfully

No response body

403

Unauthorized to perform this operation

Response

xxxxxxxxxx
 
No response
Copy

Provides a list of supported pf9-kube roles on the DU.

Auth

Headers

X-Auth-Token string

Path Params

projectId

string

UUID of the project the cluster belongs to

POST /v4/{projectId}/clusters/supportedRoleVersions

xxxxxxxxxx
 
curl --request POST \ --url 'https://localhost/qbert/v4/%7BprojectId%7D/clusters/supportedRoleVersions' \ --header 'X-Auth-Token: {X-Auth-Token}'
Copy

Responses application/json

200

OK, List of supported roles versions.

No response body

Response

xxxxxxxxxx
 
No response
Copy

External Cluster

GET

/v4/{projectId}/externalClusters/discover

POST

/v4/{projectId}/externalClusters/register

POST

/v4/{projectId}/externalClusters/:clusterID/deregister

Provides a list of all the external clusters available to be added to management plane

Auth

Headers

X-Auth-Token string

Path Params

projectId

string

UUID of the project the cluster belongs to

GET /v4/{projectId}/externalClusters/discover

xxxxxxxxxx
 
curl --get \ --url 'https://localhost/qbert/v4/%7BprojectId%7D/externalClusters/discover' \ --header 'X-Auth-Token: {X-Auth-Token}'
Copy

Responses application/json

200

OK, List of external clusters.

No response body

Response

xxxxxxxxxx
 
No response
Copy

Registers an external cluster

Auth

Headers

X-Auth-Token string

Path Params

projectId

string

UUID of the project the cluster belongs to

Request Body

object	object
id	string	An unique cluster idenfier
provider	string	Name of the external K8S cluster provider service
cloudProviderID	string	UUID of a cloud provider in PF9
providerDetails	object	A dynamic field to include cloud specific parameters. For example, for EKS, we need the region to be able to register a cluster

POST /v4/{projectId}/externalClusters/register

xxxxxxxxxx
 
curl --request POST \ --url 'https://localhost/qbert/v4/%7BprojectId%7D/externalClusters/register' \ --header 'X-Auth-Token: {X-Auth-Token}' \ --data '{  "id": "{string}",  "provider": "{string}",  "cloudProviderID": "{string}",  "providerDetails": {}}'
Copy

Responses application/json

200

OK, if cluster create request was submitted successfully

No response body

403

Unauthorized to perform this operation

404

Cluster could not be founds

409

Cluster already registered

Response

xxxxxxxxxx
 
No response
Copy

Deregister an external cluster

Auth

Headers

X-Auth-Token string

Path Params

projectId

string

UUID of the project the cluster belongs to

POST /v4/{projectId}/externalClusters/:clusterID/deregister

xxxxxxxxxx
 
curl --request POST \ --url 'https://localhost/qbert/v4/%7BprojectId%7D/externalClusters/:clusterID/deregister' \ --header 'X-Auth-Token: {X-Auth-Token}'
Copy

Responses application/json

200

OK, if cluster create request was submitted successfully

No response body

403

Unauthorized to perform this operation

Response

xxxxxxxxxx
 
No response
Copy