Containers
OAuth2 flow
Names, example: resource01,!resource02,resource42
Environments, example: PRODUCTION,DEVELOPMENT
Status, example: ACTIVE,INACTIVE
Tags, example: agkey:mytagvalue,application:itcare
Filter list by backup status
Filter list by DRP status
Filter list by patch party status
Topology, example: Standard, HA
Version, example: v1.26.15, v1.28.13, etc...
Region, example: EB,ET
Availability Zone, example: EB-A, EB-B, EB-C, etc...
IPs, example: 10.59.13.29
VLAN, example: EB_1125_DMZ8
Results page you want to retrieve (0..N)
Number of records per page.
Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria is not supported.
OK
Bad Request
This method allows to create a cluster.
You will have to know at the minimum :
- the area or availability zone of the region where you want to host your cluster (
area&azattributes) - the product code (
productCodeattribute). - which network is used (
networkIdattribute) - name of cluster (
nameattribute) - sizing of cluster (
nodeSizingattribute) - number of nodes instances of your cluster (
instanceCountattribute) - service in which you want to put your cluster (
serviceIdattribute)
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
}
OAuth2 flow
Describes the k8s container to be created.
Area. Refer to an Area of a Region, that is a low-latency network area, available in List Regions method. If absent, default Area of Region will be used.
Availability zone of the maria DB
Indicates if backup has to be setup on instance. If absent, backup will be setup automatically if instance is in a production service.
BackupPolicy id. Refers to desired backup policy to be applied for the database, must be set when backup is enabled.
Kubernetes Container Ingress Providers
Number of instances to create in k8s cluster
Name of k8s cluster
[a-z0-9\-]+The network Id of the ELS cluster
Indicates why a production resource is not under backup.
Indicates why a production resource is not under monitoring.
Indicates why a production resource is not replicated.
Node sizing for cluster
Region. that is a low-latency network area, available in List Regions method. If absent, default Area of Region will be used.
Regulation. Refer to the regulation of the Area (HDS|STANDARD). If absent, default 'STANDARD' will be used.
Indicates if replication will be setup. If absent, it will be automatically be setup if this is an production environment
BackupPolicy id. Refers to desired backup policy to be applied for the virtual machine, must be set when backup is enabled.
id of service to put instance in.
Indicates monitoring and support level, if absent then we use boolean variables to describe which level
OK
An action gives status about processing of a task previously launched by an API call and asynchronously processed.
Human readable message of status
Code of action performed
Status label of action
Bad Request
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"
}
OAuth2 flow
id, example: 123
Parameters when deleting a resource
Optional reference for change
OK
An action gives status about processing of a task previously launched by an API call and asynchronously processed.
Human readable message of status
Code of action performed
Status label of action
Bad Request
OAuth2 flow
Resource Id, example: 123
OK
K8s Container object
Indicates backup is active on the host
Kubernetes Container Ingress Providers
Area pretty name
A list of Area name
Availability Zone pretty name
DataCenter pretty name
Region pretty name
Recent Version of the K8S Cluster
Management host of the K8S Cluster
Number of Nodes of the K8s Cluster
Storage Replication Enabled - The farm has replicated storage
Technical ID of the K8S Cluster
High availability mode status
Version of the K8S Cluster
Version of the K8S Cluster
Bad Request
This method allows to update a cluster.
Structure of payload is generic and describes :
operationyou want to be performedoptionsdata 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"
}
]
}
}
you can also add isInternalIngressNode key in the options with true (which by default false) for Ingress Node.
Example :
PATCH /containers/kubernetes/1234
{
"operation": "create_nodes",
"options": {
"nodes": [
{
"nodesNb": 1,
"nodeSizing": "2cpu4gb",
"az": "EB-A"
},
{
"nodesNb": 2,
"nodeSizing": "4cpu8gb",
"az": "EB-B"
}
],
"isInternalIngressNode": true
}
}
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 Patch Party
Use the update_patch_party operation to update the patch party scheduled plan of the cluster.
- Use the
excludedoption to turn on/off patch party. - Use the
patchGroupoption to select the patching group, thepatchGroupis optional, and is only allowed when the farm has one member. - Use the
exclusionReasonoption 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
versionoption to set the target version to be installed.
The requirements are :
- step by step upgrade only : Use the
/compute/platform/products?type=KUBERNETESto 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"
}
}
OAuth2 flow
K8s Cluster Id, example: 123
OK
An action gives status about processing of a task previously launched by an API call and asynchronously processed.
Human readable message of status
Code of action performed
Status label of action
Bad Request
OAuth2 flow
K8sCluster Id, example: 123
OK
LoadBalancer object
Bot Defense state
Bot Defense is updating
Advanced property such as default persistence
Advanced property such as fallback persistence
Area pretty name
Availability Zone pretty name
DataCenter pretty name
Region pretty name
Advanced property such as load balancing mode
Source addresse translation automap enabled
Bad Request
OAuth2 flow
K8sCluster Id, example: 123
Describes a load balancer.
Area. Refer to an Area of a Region, that is a low-latency network area, available in List Regions method. If absent, default Area of Region will be used.
Indicates if backup has to be setup on instance. If absent, backup will be setup automatically if instance is in a production service.
certificate of the load balancer., example: wildcard_cegedim.com
BackupPolicy id. Refers to desired backup policy to be applied for the database, must be set when backup is enabled.
healtcheck of load balancer., example: http
Network id. Refer to networks available in List Networks method. If absent, a default network of AZ will be used.
Indicates why a production resource is not under backup.
Indicates why a production resource is not under monitoring.
Indicates why a production resource is not replicated.
port member of load balancer., example: 80, 443, ...
profile name of load balancer.
Region. that is a low-latency network area, available in List Regions method. If absent, default Area of Region will be used.
Regulation. Refer to the regulation of the Area (HDS|STANDARD). If absent, default 'STANDARD' will be used.
Indicates if replication will be setup. If absent, it will be automatically be setup if this is an production environment
BackupPolicy id. Refers to desired backup policy to be applied for the virtual machine, must be set when backup is enabled.
id of service to put instance in.
Indicates if a DNS record is to be set. If absent, set to false.
ssl profile of the load balancer., example: profile_wildcard.cegedim.com_secure
Indicates monitoring and support level, if absent then we use boolean variables to describe which level
url of load balancer. Must be unique, and fit naming rules convention., example: url.cegedim.com
^(https?:\\/\\/)?(www\\.)?[a-zA-Z][a-zA-Z0-9.-]{2,63}+$port of load balancer in case of TCP VS Profile
OK
An action gives status about processing of a task previously launched by an API call and asynchronously processed.
Human readable message of status
Code of action performed
Status label of action
Bad Request
OAuth2 flow
K8sCluster Id, example: 123
type, example: az-distribution | dc-distribution
OK
Bad Request
OAuth2 flow
OK
Bad Request
OAuth2 flow
OK
Instance object
CPU of the resource
Internal Image linked to this instance
This instance is ingress external node
This instance is ingress internal node
Instance is member of load balancer
Area pretty name
Availability Zone pretty name
DataCenter pretty name
Region pretty name
OS name of this instance
OS type of this instance
RAM of the resource
Storage after disks format in GB of the resource
Information about storage replication in Progress
Total Disk size of the resource
Bad Request
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.
OAuth2 flow
id, example: 123
id, example: 456
OK
An action gives status about processing of a task previously launched by an API call and asynchronously processed.
Human readable message of status
Code of action performed
Status label of action
Bad Request
Last updated