Create Kubernetes Deployment
Only Solution users, Container admins, and System admins can create KubernetesDeployments.
Request
URI
POST
https://{api_host}/container-service/api/resources/kubernetes-deployments
COPY
Request Body
KubernetesDeployment of type(s) application/json
Required
{
"documentExpirationTimeMicros": "string",
"parentLink": "string",
"descriptionLink": "string",
"kubernetesSelfLink": "string",
"compositeComponentLink": "string",
"documentUpdateTimeMicros": "string",
"regionId": "string",
"documentSelfLink": "string",
"tagLinks": [
"string"
],
"name": "string",
"groupLinks": [
"string"
],
"tenantLinks": [
"string"
],
"id": "string",
"desc": "string",
"deployment": {
"metadata": {
"uid": "string",
"clusterName": "string",
"name": "string",
"namespace": "string",
"creationTimestamp": "string",
"generateName": "string",
"selfLink": "string"
},
"apiVersion": "string",
"kind": "string",
"spec": {
"template": {
"metadata": {
"uid": "string",
"clusterName": "string",
"name": "string",
"namespace": "string",
"creationTimestamp": "string",
"generateName": "string",
"selfLink": "string"
},
"spec": {
"dnsPolicy": "string",
"nodeName": "string",
"terminationGracePeriodSeconds": 0,
"hostNetwork": "string",
"volumes": [
{
"gcePersistentDisk": {
"partition": 0,
"readOnly": false,
"pdName": "string",
"fsType": "string"
},
"photonPersistentDisk": {
"pdID": "string",
"fsType": "string"
},
"quobyte": {
"volume": "string",
"registry": "string",
"readOnly": false,
"user": "string",
"group": "string"
},
"azureDisk": {
"diskName": "string",
"readOnly": false,
"diskURI": "string",
"fsType": "string"
},
"cinder": {
"volumeID": "string",
"readOnly": false,
"fsType": "string"
},
"downwardAPI": {
"defaultMode": 0,
"items": [
{
"mode": 0,
"path": "string",
"resourceFieldRef": {
"divisor": "string",
"resource": "string",
"containerName": "string"
},
"fieldRef": {
"apiVersion": "string",
"fieldPath": "string"
}
}
]
},
"azureFile": {
"secretName": "string",
"readOnly": false,
"shareName": "string"
},
"awsElasticBlockStore": {
"partition": 0,
"volumeID": "string",
"readOnly": false,
"fsType": "string"
},
"flexVolume": {
"driver": "string",
"secretRef": {
"name": "string"
},
"readOnly": false,
"fsType": "string"
},
"secret": {
"secretName": "string",
"defaultMode": 0,
"items": [
{
"mode": 0,
"path": "string",
"key": "string"
}
]
},
"iscsi": {
"iscsiInterface": "string",
"lun": 0,
"iqn": "string",
"readOnly": false,
"fsType": "string",
"targetPortal": "string"
},
"cephfs": {
"path": "string",
"secretRef": {
"name": "string"
},
"secretFile": "string",
"readOnly": false,
"user": "string",
"monitors": [
"string"
]
},
"rbd": {
"image": "string",
"pool": "string",
"readOnly": false,
"sourceRef": {
"name": "string"
},
"fsType": "string",
"user": "string",
"keyring": "string",
"monitors": [
"string"
]
},
"configMap": {
"defaultMode": 0,
"name": "string",
"items": [
{
"mode": 0,
"path": "string",
"key": "string"
}
]
},
"emptyDir": {
"medium": "string"
},
"name": "string",
"nfs": {
"server": "string",
"path": "string",
"readOnly": false
},
"glusterfs": {
"path": "string",
"endpoints": "string",
"readOnly": false
},
"persistentVolumeClaim": {
"claimName": "string",
"readOnly": "string"
},
"gitRepo": {
"repository": "string",
"directory": "string",
"revision": "string"
},
"vsphereVolume": {
"volumePath": "string",
"fsType": "string"
},
"fc": {
"targetWWNs": [
"string"
],
"lun": 0,
"readOnly": false,
"fsType": "string"
},
"hostPath": {
"path": "string"
}
}
],
"hostIPC": false,
"securityContext": {
"runAsUser": 0,
"fsGroup": 0,
"supplementalGroups": [
0
],
"runAsNonRoot": false
},
"restartPolicy": "string",
"hostname": "string",
"subdomain": "string",
"containers": [
{
"image": "string",
"livenessProbe": {
"failureThreshold": 0,
"tcpSocket": {
"port": "string"
},
"timeoutSeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"initialDelaySeconds": 0,
"exec": {
"command": [
"string"
]
},
"httpGet": {
"path": "string",
"scheme": "string",
"port": "string",
"host": "string"
}
},
"imagePullPolicy": "string",
"stdin": false,
"terminationMessagePath": "string",
"workingDir": "string",
"resources": {},
"securityContext": {
"privileged": false,
"runAsUser": 0,
"runAsNonRoot": false,
"readOnlyRootFilesystem": false
},
"ports": [
{
"protocol": "string",
"hostIP": "string",
"name": "string",
"containerPort": 0,
"hostPort": 0
}
],
"env": [
{
"name": "string",
"value": "string",
"valueFrom": {
"secretKeyRef": {
"name": "string",
"key": "string"
},
"resourceFieldRef": {
"divisor": "string",
"resource": "string",
"containerName": "string"
},
"fieldRef": {
"apiVersion": "string",
"fieldPath": "string"
},
"configMapKeyRef": {
"name": "string",
"key": "string"
}
}
}
],
"command": [
"string"
],
"volumeMounts": [
{
"mountPath": "string",
"name": "string",
"readOnly": false,
"subPath": "string"
}
],
"args": [
"string"
],
"lifecycle": {
"preStop": {
"tcpSocket": {
"port": "string"
},
"exec": {
"command": [
"string"
]
},
"httpGet": {
"path": "string",
"scheme": "string",
"port": "string",
"host": "string"
}
},
"podStart": {
"tcpSocket": {
"port": "string"
},
"exec": {
"command": [
"string"
]
},
"httpGet": {
"path": "string",
"scheme": "string",
"port": "string",
"host": "string"
}
}
},
"name": "string",
"tty": false,
"readinessProbe": {
"failureThreshold": 0,
"tcpSocket": {
"port": "string"
},
"timeoutSeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"initialDelaySeconds": 0,
"exec": {
"command": [
"string"
]
},
"httpGet": {
"path": "string",
"scheme": "string",
"port": "string",
"host": "string"
}
},
"stdinOnce": false
}
],
"activeDeadlineSeconds": 0,
"hostPID": false
}
},
"paused": false,
"replicas": 0,
"selector": {
"matchExpressions": [
{
"values": [
"string"
],
"key": "string",
"operator": "string"
}
]
},
"revisionHistoryLimit": 0,
"minReadySeconds": 0,
"strategy": {
"type": "string",
"rollingUpdate": {}
},
"progressDeadlineSeconds": 0,
"rollbackTo": {
"revision": 0
}
},
"status": {
"unavailableReplicas": 0,
"replicas": 0,
"readyReplicas": 0,
"conditions": [
{
"reason": "string",
"type": "string",
"lastTransitionTime": "string",
"message": "string",
"status": "string",
"lastUpdateTime": "string"
}
],
"updatedReplicas": 0,
"observedGeneration": 0,
"availableReplicas": 0
}
}
}string
documentExpirationTimeMicros
Optional
documentExpirationTimeMicros
string
parentLink
Optional
parentLink
string
descriptionLink
Optional
descriptionLink
string
kubernetesSelfLink
Optional
kubernetesSelfLink
string
compositeComponentLink
Optional
compositeComponentLink
string
documentUpdateTimeMicros
Optional
documentUpdateTimeMicros
object
customProperties
Optional
customProperties
string
regionId
Optional
regionId
string
documentSelfLink
Optional
documentSelfLink
array of string
tagLinks
Optional
tagLinks
string
name
Optional
name
array of string
groupLinks
Optional
groupLinks
array of string
tenantLinks
Optional
tenantLinks
string
id
Optional
id
string
desc
Optional
desc
Responses
200
successful operation
Returns KubernetesDeployment of type(s) */*
{
"documentExpirationTimeMicros": "string",
"parentLink": "string",
"descriptionLink": "string",
"kubernetesSelfLink": "string",
"compositeComponentLink": "string",
"documentUpdateTimeMicros": "string",
"regionId": "string",
"documentSelfLink": "string",
"tagLinks": [
"string"
],
"name": "string",
"groupLinks": [
"string"
],
"tenantLinks": [
"string"
],
"id": "string",
"desc": "string",
"deployment": {
"metadata": {
"uid": "string",
"clusterName": "string",
"name": "string",
"namespace": "string",
"creationTimestamp": "string",
"generateName": "string",
"selfLink": "string"
},
"apiVersion": "string",
"kind": "string",
"spec": {
"template": {
"metadata": {
"uid": "string",
"clusterName": "string",
"name": "string",
"namespace": "string",
"creationTimestamp": "string",
"generateName": "string",
"selfLink": "string"
},
"spec": {
"dnsPolicy": "string",
"nodeName": "string",
"terminationGracePeriodSeconds": 0,
"hostNetwork": "string",
"volumes": [
{
"gcePersistentDisk": {
"partition": 0,
"readOnly": false,
"pdName": "string",
"fsType": "string"
},
"photonPersistentDisk": {
"pdID": "string",
"fsType": "string"
},
"quobyte": {
"volume": "string",
"registry": "string",
"readOnly": false,
"user": "string",
"group": "string"
},
"azureDisk": {
"diskName": "string",
"readOnly": false,
"diskURI": "string",
"fsType": "string"
},
"cinder": {
"volumeID": "string",
"readOnly": false,
"fsType": "string"
},
"downwardAPI": {
"defaultMode": 0,
"items": [
{
"mode": 0,
"path": "string",
"resourceFieldRef": {
"divisor": "string",
"resource": "string",
"containerName": "string"
},
"fieldRef": {
"apiVersion": "string",
"fieldPath": "string"
}
}
]
},
"azureFile": {
"secretName": "string",
"readOnly": false,
"shareName": "string"
},
"awsElasticBlockStore": {
"partition": 0,
"volumeID": "string",
"readOnly": false,
"fsType": "string"
},
"flexVolume": {
"driver": "string",
"secretRef": {
"name": "string"
},
"readOnly": false,
"fsType": "string"
},
"secret": {
"secretName": "string",
"defaultMode": 0,
"items": [
{
"mode": 0,
"path": "string",
"key": "string"
}
]
},
"iscsi": {
"iscsiInterface": "string",
"lun": 0,
"iqn": "string",
"readOnly": false,
"fsType": "string",
"targetPortal": "string"
},
"cephfs": {
"path": "string",
"secretRef": {
"name": "string"
},
"secretFile": "string",
"readOnly": false,
"user": "string",
"monitors": [
"string"
]
},
"rbd": {
"image": "string",
"pool": "string",
"readOnly": false,
"sourceRef": {
"name": "string"
},
"fsType": "string",
"user": "string",
"keyring": "string",
"monitors": [
"string"
]
},
"configMap": {
"defaultMode": 0,
"name": "string",
"items": [
{
"mode": 0,
"path": "string",
"key": "string"
}
]
},
"emptyDir": {
"medium": "string"
},
"name": "string",
"nfs": {
"server": "string",
"path": "string",
"readOnly": false
},
"glusterfs": {
"path": "string",
"endpoints": "string",
"readOnly": false
},
"persistentVolumeClaim": {
"claimName": "string",
"readOnly": "string"
},
"gitRepo": {
"repository": "string",
"directory": "string",
"revision": "string"
},
"vsphereVolume": {
"volumePath": "string",
"fsType": "string"
},
"fc": {
"targetWWNs": [
"string"
],
"lun": 0,
"readOnly": false,
"fsType": "string"
},
"hostPath": {
"path": "string"
}
}
],
"hostIPC": false,
"securityContext": {
"runAsUser": 0,
"fsGroup": 0,
"supplementalGroups": [
0
],
"runAsNonRoot": false
},
"restartPolicy": "string",
"hostname": "string",
"subdomain": "string",
"containers": [
{
"image": "string",
"livenessProbe": {
"failureThreshold": 0,
"tcpSocket": {
"port": "string"
},
"timeoutSeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"initialDelaySeconds": 0,
"exec": {
"command": [
"string"
]
},
"httpGet": {
"path": "string",
"scheme": "string",
"port": "string",
"host": "string"
}
},
"imagePullPolicy": "string",
"stdin": false,
"terminationMessagePath": "string",
"workingDir": "string",
"resources": {},
"securityContext": {
"privileged": false,
"runAsUser": 0,
"runAsNonRoot": false,
"readOnlyRootFilesystem": false
},
"ports": [
{
"protocol": "string",
"hostIP": "string",
"name": "string",
"containerPort": 0,
"hostPort": 0
}
],
"env": [
{
"name": "string",
"value": "string",
"valueFrom": {
"secretKeyRef": {
"name": "string",
"key": "string"
},
"resourceFieldRef": {
"divisor": "string",
"resource": "string",
"containerName": "string"
},
"fieldRef": {
"apiVersion": "string",
"fieldPath": "string"
},
"configMapKeyRef": {
"name": "string",
"key": "string"
}
}
}
],
"command": [
"string"
],
"volumeMounts": [
{
"mountPath": "string",
"name": "string",
"readOnly": false,
"subPath": "string"
}
],
"args": [
"string"
],
"lifecycle": {
"preStop": {
"tcpSocket": {
"port": "string"
},
"exec": {
"command": [
"string"
]
},
"httpGet": {
"path": "string",
"scheme": "string",
"port": "string",
"host": "string"
}
},
"podStart": {
"tcpSocket": {
"port": "string"
},
"exec": {
"command": [
"string"
]
},
"httpGet": {
"path": "string",
"scheme": "string",
"port": "string",
"host": "string"
}
}
},
"name": "string",
"tty": false,
"readinessProbe": {
"failureThreshold": 0,
"tcpSocket": {
"port": "string"
},
"timeoutSeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"initialDelaySeconds": 0,
"exec": {
"command": [
"string"
]
},
"httpGet": {
"path": "string",
"scheme": "string",
"port": "string",
"host": "string"
}
},
"stdinOnce": false
}
],
"activeDeadlineSeconds": 0,
"hostPID": false
}
},
"paused": false,
"replicas": 0,
"selector": {
"matchExpressions": [
{
"values": [
"string"
],
"key": "string",
"operator": "string"
}
]
},
"revisionHistoryLimit": 0,
"minReadySeconds": 0,
"strategy": {
"type": "string",
"rollingUpdate": {}
},
"progressDeadlineSeconds": 0,
"rollbackTo": {
"revision": 0
}
},
"status": {
"unavailableReplicas": 0,
"replicas": 0,
"readyReplicas": 0,
"conditions": [
{
"reason": "string",
"type": "string",
"lastTransitionTime": "string",
"message": "string",
"status": "string",
"lastUpdateTime": "string"
}
],
"updatedReplicas": 0,
"observedGeneration": 0,
"availableReplicas": 0
}
}
}string
documentExpirationTimeMicros
Optional
documentExpirationTimeMicros
string
parentLink
Optional
parentLink
string
descriptionLink
Optional
descriptionLink
string
kubernetesSelfLink
Optional
kubernetesSelfLink
string
compositeComponentLink
Optional
compositeComponentLink
string
documentUpdateTimeMicros
Optional
documentUpdateTimeMicros
object
customProperties
Optional
customProperties
string
regionId
Optional
regionId
string
documentSelfLink
Optional
documentSelfLink
array of string
tagLinks
Optional
tagLinks
string
name
Optional
name
array of string
groupLinks
Optional
groupLinks
array of string
tenantLinks
Optional
tenantLinks
string
id
Optional
id
string
desc
Optional
desc
201
'Created' is returned for the new state with the state url in the location header of the response;
Operation doesn't return any data structure
Kubernetes Operations
POST
Create Generic Kubernetes Entity State
POST
Create Kubernetes Deployment
POST
Create Kubernetes Description
POST
Create Kubernetes Pod
POST
Create Kubernetes Service
DELETE
Delete Generic Kubernetes Entity State
DELETE
Delete Kubernetes Deployment
DELETE
Delete Kubernetes Description
DELETE
Delete Kubernetes Pod
DELETE
Delete Kubernetes Service
GET
Get Generic Kubernetes Entity State
GET
Get Kubernetes Deployment
GET
Get Kubernetes Description
GET
Get Kubernetes Pod
GET
Get Kubernetes Service
GET
List Generic Kubernetes Entity States
GET
List Kubernetes Deployment
GET
List Kubernetes Description
GET
List Kubernetes Pod
GET
List Kubernetes Service
PATCH
Patch Generic Kubernetes Entity State
PATCH
Patch Kubernetes Deployment
PATCH
Patch Kubernetes Description
PATCH
Patch Kubernetes Pod
PATCH
Patch Kubernetes Service
PUT
Update Generic Kubernetes Entity State
PUT
Update Kubernetes Deployment
PUT
Update Kubernetes Description
PUT
Update Kubernetes Pod
PUT
Update Kubernetes Service