Containers

This method allows to delete a Kubernetes cluster node.

This operation cannot be undone afterwards.

This method is synchronous (status code 202).

To delete a Kubernetes node, the id of the Kubernetes cluster and the id of the node to delete must be specified.

To list the nodes of the Kubernetes cluster, use the endpoint : GET /containers/kubernetes/{kuberneteId}/nodes/{nodeId}.

Use the following to delete a node of a Kubernetes cluster.

DELETE /containers/kubernetes/1234/nodes/4567

To keep consistency on the Kubernetes cluster, please note that :

• All nodes cannot be deleted.

• All ingress nodes cannot be deleted.

API users will have a BAD_REQUEST when trying to break one of the rule above.

This method allows to delete a K8s Cluster Container.

This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.

DELETE /k8s-clusters/123

DELETE /k8s-clusters/123
{
    "changeReference": "rfc nunmber 456"
}

This method allows to update a cluster.

Structure of payload is generic and describes :

• operation you want to be performed
• options data relative to the operation performed - see details.

Below are different operations currently implemented.

Create Nodes

Use the create_nodes operation to create the nodes of a cluster.

Create nodes operation will add the new nodes in the cluster by availability zone. You can specify the availability zone you need in the request.

This method is synchronous (status code 202).

Example :

PATCH /containers/kubernetes/1234
{
    "operation": "create_nodes",
    "options": {
        "nodes": [
            {
                "nodesNb": 1,
                "nodeSizing": "2cpu4gb",
                "az": "EB-A"
            },
            {
                "nodesNb": 2,
                "nodeSizing": "4cpu8gb",
                "az": "EB-B"
            }
        ]
    }
}

Delete Nodes

Use the delete_nodes operation to delete the nodes of a cluster.

This operation cannot be undone afterwards.

This method is synchronous (status code 202).

PATCH /containers/kubernetes/1234
{
	"operation":"delete_nodes",
	"options":{
	    "nodes": ["11112","11113","11114"]
	}
}

Enable High Availability - HA

Use the enable_ha operation to enable the HA of a cluster.

This operation cannot be undone afterwards.

This method is synchronous (status code 202).

PATCH /containers/kubernetes/1234
{
	"operation":"enable_ha"
}

Update Monitoring

Use the update_monitoring operation to update the monitoring state of the cluster.

Use the state option to turn on/off monitoring. Use the on_call option to turn on/off 24/7 monitoring.

This method is synchronous (status code 202).

PATCH /containers/kubernetes/1234
{
  "operation": "update_monitoring",
  "options": {
       "state": true,
       "on_call": true
 }
}

Update Patch Party

Use the update_patch_party operation to update the patch party scheduled plan of the cluster.

• Use the excluded option to turn on/off patch party.
• Use the patchGroup option to select the patching group, the patchGroup is optional, and is only allowed when the farm has one member.
• Use the exclusionReason option to explain the reason of excluding the resource from patch part.

This method is synchronous (status code 202).

• Include from patch party body:

PATCH /containers/kubernetes/1234
{
  "operation": "update_patch_party",
  "options": {
    "patchParty": {
        "excluded": false,
        "patchGroup": "3"
    }
 }
}

• Exclude from patch party body:

PATCH /containers/kubernetes/1234
{
  "operation": "update_patch_party",
  "options": {
    "patchParty": {
        "excluded": true,
        "exclusionReason": "I want to handle this by myself"
    }
 }
}

Upgrade

Use the upgrade operation to upgrade the cluster.

• Use the version option to set the target version to be installed.

The requirements are :

• step by step upgrade only : Use the /compute/platform/products?type=KUBERNETES to list all versions available for the cluster.
• no downgrade possibility

This method is synchronous (status code 202).

PATCH /containers/kubernetes/1234
{
  "operation": "upgrade",
  "options": {
    "version": "1.24"
 }
}

This method allows to create a cluster.

You will have to know at the minimum :

• where you want to host your cluster (area attribute)
• which network is used (networkId attribute)
• name of cluster (name attribute)
• sizing of cluster (nodeSizing attribute)
• number of nodes instances of your cluster (instanceCount attribute)
• service in which you want to put your cluster (serviceId attribute)

This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.

POST /clusters
{
	"name": "PCLUSTER01",
	"area": "EB",
	"networkId": "ED145",
	"serviceId": 123,
	"nodeSizing":, "1cpu2gb"
	"instanceCount": 2
}