POST - /kubernetes/item/deploy/soajs
- antoine hage
Description
This API deploys an item from the catalog using soajs recipe of type deployment or daemonset.
Input
Type: application/jsonParam | Source | Type | Required | Description |
|---|---|---|---|---|
configuration | body | object | Yes | configuration |
recipe | body | object | Yes | recipe |
catalog | body.recipe | object | Yes |
|
id | body.recipe.catalog | string | Yes |
|
version | body.recipe.catalog | string | Yes |
|
shell | body.recipe.catalog | string | Yes |
|
restartPolicy | body.recipe.catalog | string | no |
|
item | body.recipe | object | Yes |
|
env | body.recipe.item | string | Yes |
|
name | body.recipe.item | string | Yes |
|
group | body.recipe.item | string | Yes |
|
type | body.recipe.item | string | Yes |
|
subtype | body.recipe.item | string | no |
|
version | body.recipe.item | string | Yes |
|
src | body.recipe | object | no |
|
from | body.recipe.src | object | Yes |
|
repo | body.recipe.src | string | yes |
|
owner | body.recipe.src | string | yes |
|
mode | body.recipe | enum | yes | ["Deployment", "DaemonSet"] |
labels | body.recipe | object | no | free object of key and value as labels |
image | body.recipe | object | yes |
|
name | body.recipe.image | string | yes |
|
imagePullPolicy | body.recipe.image | string | yes |
|
secret | body.recipe.image | string | no |
|
ports | body.recipe | array of objects | no |
|
name | body.recipe.ports | string | yes |
|
containerPort | body.recipe.ports | integer | yes |
|
workingDir | body.recipe | string | no |
|
command | body.recipe | array | no |
|
args | body.recipe | array | no |
|
readinessProbe | body.recipe | object | yes | readinessProde object from kubernetes |
livenessProbe | body.recipe | object | no | livenessProbe object from kubernetes |
env | body.recipe | array of objects | no |
|
items | body.recipe.env | object | no |
|
volume | body.recipe | object | no |
|
volumeMounts | body.recipe.volume | array of objects | no |
|
volumes | body.recipe.volume | array of objects | no |
|
replicas | body.recipe | integer | no |
|
revisionHistoryLimit | body.recipe | integer | no |
|
service | body.recipe | object | no |
|
ports | body.recipe.service | array of objects | Yes |
|
items | body.recipe.service.ports | object | yes |
|
name | body.recipe.service.ports.items | string | yes |
|
port | body.recipe.service.ports.items | integer | yes |
|
type | body.recipe.service | string | Yes |
|
externalTrafficPolicy | body.recipe.service | string | Yes |
|
body.recipe.src.from
Conditional require, with one of the following:
["tag"]["branch", "commit"]
Param | Source | Type | Required | Description |
|---|---|---|---|---|
tag | body.recipe.src.from | string | Yes conditional |
|
branch | body.recipe.src.from | string | Yes conditional |
|
commit | body.recipe.src.from | string | Yes conditional |
|
body.recipe.env.items
Conditional require, with one of the following:
["name", "valueFrom"]["name", "value"]
Param | Source | Type | Required | Description |
|---|---|---|---|---|
name | body.recipe.src.env | string | Yes conditional |
|
value | body.recipe.src.env | string | Yes conditional |
|
valueFrom | body.recipe.src.env | object | Yes conditional |
|
secretKeyRef | body.recipe.src.env.valueFrom | object | yes |
|
name | body.recipe.src.env.valueFrom.secretKeyRef | string | yes |
|
key | body.recipe.src.env.valueFrom.secretKeyRef | string | yes |
|