Deployment Manager API

import json, requests

api_root = 'https://www.instabase.com/api/v1/control_plane'

export TOKEN=$(kubectl -n $IB_NS get \
secret/control-plane-metadata \
--template={{.data.api_token}} | base64 -d)

url = api_root + '/setup'
headers = {
  'Token': token,
}
resp = requests.get(url, headers=headers).json()

HTTP STATUS CODE 200

# body
{
  "status": "OK"
}

url = api_root + '/setup/status'
headers = {
  'Token': token,
}
resp = requests.get(url, headers=headers).json()

{
  "isSetup": "true"
}

url = api_root + '/database/setup'

data = dict(
  create_admin_account = "true",
  admin_email = "admin@email.com", # optional (only if 'create_admin_account' is true)
  admin_username = "admin", # optional (default: 'admin')
  enable_control_plane = "false", # optional (default: 'false')
  enable_key_service = "false", # optional (default: 'false')
  enable_models = "false" # optional (default: 'false')
)

headers = {
  'Token': token,
}
resp = requests.post(url, headers=headers, data=json.dumps(data)).json()

HTTP STATUS CODE 200

# body
{
  "status": "OK"
}

POST api_root/database/mock_ddl

# body
{
  "create_admin_account": "true",
  "admin_email": "admin@email.com", # optional (only if 'create_admin_account' is true)
  "admin_username": "admin", # optional (default: 'admin')
  "enable_control_plane": "false", # optional (default: 'false')
  "enable_key_service": "false", # optional (default: 'false')
  "enable_ml_studio": "false", # optional (default: 'false')
  "enable_model_registry_pv": "false" # optional (default: 'false')
}

url = api_root + '/database/mock_ddl'

data = dict(
  create_admin_account = "true",
  admin_email = "admin@email.com", # optional (only if 'create_admin_account' is true)
  admin_username = "admin", # optional (default: 'admin')
  enable_control_plane = "false", # optional (default: 'false')
  enable_key_service = "false", # optional (default: 'false')
  enable_models = "false" # optional (default: 'false')
)

headers = {
  'Token': token,
}
resp = requests.post(url, headers=headers, data=json.dumps(data)).json()

HTTP STATUS CODE 200

# body
{
  "ddls": [
    ..., <string: the DDL strings>
  ]
}

HTTP STATUS CODE 400
HTTP STATUS CODE 500

GET api_root/database/connection

url = api_root + '/database/connection'

headers = {
  'Token': token,
}
resp = requests.get(url, headers=headers).json()

HTTP STATUS CODE 200

HTTP STATUS CODE 500

curl -i -X POST -H "Content-Type: multipart/form-data" -H 'Token: token' \
-F "file=@configs.zip" -F "release_version=21.x.0" api_root/base_configs

url = api_root + '/base_configs'

data = dict(
  release_version = "21.x.0", # release version of the base configs
  base_config = "...", # the configuration
)

headers = {
  'Token': token,
  'Content-type': contentType,
}
resp = requests.post(url, headers=headers, data=json.dumps(data)).json()

HTTP STATUS CODE 200

{
  "data": {
    "successful_apply": [
      <string: the names of the objects that were successfully updated in the cluster>
    ]
  },
  "status_code": 200
}

HTTP STATUS CODE 500

{
  "data": {
    "successful_apply": [
      <string: the names of the objects that were successfully updated in the cluster>
    ],
    "failed_to_apply": [
      <string: the names of the objects that failed to get updated in the cluster>
    ],
  },
  "status_code": <number: the status code of the response>,
  "error": <string: the reason for the failure>
}

url = api_root + '/base_configs/versions'

headers = {
  'Token': token,
}
resp = requests.get(url, headers=headers).json()

GET api_root/base_configs/versions

HTTP STATUS CODE 200

# body
{
  "baseConfigVersions": [
    {
      "objectName": <string: the Kubernetes object name>,
      "Versions": <list of strings: the release versions of the object stored in Deployment Manager>
    },
    ...
  ]
}

HTTP STATUS CODE 500

url = api_root + '/base_configs/' + object_name + '/versions'

headers = {
  'Token': token,
}
resp = requests.get(url, headers=headers).json()

HTTP STATUS CODE 200

# body
{
  "versions": [
    <string: each release version of the object stored in Deployment Manager>,
    ...
  ]
}

curl -i -X POST -H "Content-Type: application/x-www-form-urlencoded" -H 'Token: token' \
--data-urlencode 'image=imageValue' --data-urlencode 'object=deployment-core-platform-service' --data-urlencode 'comment=numpy-package-update' api_root/patches/apply api_root/base_configs/image

url = api_root + '/base_configs/image'

data = dict(
  image = "...", 
  object = "...",
  comment = "...",
  container = "..."
)

headers = {
  'Token': token,
  'Content-Type': 'application/x-www-form-urlencoded',
}
resp = requests.post(url, headers=headers, data=json.dumps(data)).json()

HTTP STATUS CODE 200

{
  "data": {
    "successful_apply": [
      <string: the names of the object that were successfully updated in the cluster>
    ]
  },
  "status_code": 200
}

HTTP STATUS CODE 500

{
  "data": {
    "successful_apply": [
      <string: the names of the object that were successfully updated in the cluster>
    ],
    "failed_to_apply": [
      <string: the names of the object that failed to get updated in the cluster>
    ],
  },
  "status_code": <number: the status code of the response>,
  "error": <string: the reason for the failure>
}

curl -i -X POST -H "Content-Type: application/x-www-form-urlencoded" -H 'Token: token' \
--data-urlencode 'patch=patchText' api_root/patches/apply

{
  "comment": "Open new egress port for external service",
  "kind": "NetworkPolicy",
  "target": "some-network-policy",
  "patch": [
    {
      "op": "add",
      "path": "/spec/egress/1/ports/-",
      "value": {
        "protocol": "TCP",
        "port": 9999
      }
    }
  ]
}

# target: targetName
apiVersion: v1
kind: Deployment
...

url = api_root + '/patches/apply'

data = dict(
  patch = "...", # body of the patch - include target tag at beginning of string
  description = "This patch updates the number of replicas for the given service",
)

headers = {
  'Token': token,
  'Content-Type': 'application/x-www-form-urlencoded',
}

resp = requests.post(url, headers=headers, data=data).json()

url = api_root + '/patches/apply'

files=[
  ('file',('patch.yml',open('patch.yml','rb'),'application/octet-stream'))
]

data = {
    "description" : "..."
}

headers = {
    'Token': token
}

resp = requests.post(url, headers=headers, files=files, data=data).json()

curl --location 'api_root/patches/apply' \
--header 'token: your_token' \
--form 'file=@"patch.yml"' \
--form 'description="This patch updates the number of replicas for the given service"'

HTTP STATUS CODE 200

# body
{
  "data": {
    "successful_apply": [
      <string: the names of the objects that were successfully updated in the cluster>,
      ...
    ],
  },
  "status_code": 200
}

# body
{
  "data": {
    "successful_apply": [
      <string: the names of the objects that were successfully updated in the cluster>,
      ...
    ],
    "failed_to_apply": [
      <string: the names of the objects that failed to get updated in the cluster>,
      ...
    ],
  },
  "status_code": <number: the status code of the response>,
  "error": <string: the reason for the failure>
}

# body
{
    "statusCode": 200,
    "data": {
        "dryRuns": [
            {
                "message": null,
                "dryRun": {
                    "objectName": "object-1",
                    "releaseVersion": "21.1.0",
                    "patchVersion": null,
                    "previousReleaseVersion": null,
                    "previousPatchVersion": null,
                    "state": null,
                    "config": "apiVersion: batch/v1\nkind: Deployment\nmetadata:\n  name: object-1\n  namespace:instabase",
                    "metadata": "{\"type\":\"Deployment\",\"isEncrypted\":false}",
                    "timestampMS": 1652116484052
                }
            },
            {
                "message": "Target 'object-2' is a nonexistent object. If you apply a patch to this target there will be no configuration file associated with it until an object called 'object-2' is created.",
                "dryRun": null
            }
        ]
    },
    "error": null
}

url = api_root + '/patches'

headers = {
  'Token': token,
}
resp = requests.get(url, headers=headers).json()

HTTP STATUS CODE 200
{
    "statusCode": 200,
    "data": {
        "patches": [
            {
                "version": 1658866352520,
                "nextVersion": 1658866353683,
                "target": "deployment-core-platform-service",
                "state": "NOT_GOLDEN",
                "patch": "apiVersion: apps/v1\nkind: Deployment\nspec:\n  template:\n    spec:\n      containers:\n        - name: CONTAINER_NAME\n          env:\n            - name: S3_SERVER_URL\n              value: \"test-server-url\"\n            - name: S3_SERVER_IS_SECURE\n              value: \"true\"\n            - name: S3_SERVER_CALLING_FORMAT\n              value: \"SubdomainCallingFormat\"\n            - name: AWS_ACCESS_KEY_ID\n              value: \"test-access-key\"\n            - name: AWS_SECRET_ACCESS_KEY\n              value: \"test-secret-key\"\n            - name: S3_AWS_REGION\n              value: \"us-east-1\"\n            - name: HOSTING_BUCKET\n              value: \"test-bucket-name\"\n            - name: INSTABASE_BUCKET\n              value: \"test-bucket-name\"\n            - name: HOSTED_STORAGE_TYPE\n              value: \"S3\"\n            - name: HOSTED_S3_ENCRYPTION_TYPE\n              value: \"aws_sse_s3\"\n            - name: USE_VIRTUAL_STYLE_URL\n              value: \"true\"",
                "metadata": "{\"type\":\"Deployment\",\"isEncrypted\":false,\"format\":\"YAML\",\"createdBy\":\"Installer\"}",
                "description": "Control Plane Installation Patch: s3_storage_patch"
            }
        ]
    },
    "error": null
}

url = api_root + '/patches/deployment-core-platform-service'

headers = {
  'Token': token,
}
resp = requests.get(url, headers=headers).json()

HTTP STATUS CODE 200
{
    "statusCode": 200,
    "data": {
        "patches": [
            {
                "version": 1658866352520,
                "nextVersion": 1658866353683,
                "target": "deployment-core-platform-service",
                "state": "NOT_GOLDEN",
                "patch": "apiVersion: apps/v1\nkind: Deployment\nspec:\n  template:\n    spec:\n      containers:\n        - name: CONTAINER_NAME\n          env:\n            - name: S3_SERVER_URL\n              value: \"test-server-url\"\n            - name: S3_SERVER_IS_SECURE\n              value: \"true\"\n            - name: S3_SERVER_CALLING_FORMAT\n              value: \"SubdomainCallingFormat\"\n            - name: AWS_ACCESS_KEY_ID\n              value: \"test-access-key\"\n            - name: AWS_SECRET_ACCESS_KEY\n              value: \"test-secret-key\"\n            - name: S3_AWS_REGION\n              value: \"us-east-1\"\n            - name: HOSTING_BUCKET\n              value: \"test-bucket-name\"\n            - name: INSTABASE_BUCKET\n              value: \"test-bucket-name\"\n            - name: HOSTED_STORAGE_TYPE\n              value: \"S3\"\n            - name: HOSTED_S3_ENCRYPTION_TYPE\n              value: \"aws_sse_s3\"\n            - name: USE_VIRTUAL_STYLE_URL\n              value: \"true\"",
                "metadata": "{\"type\":\"Deployment\",\"isEncrypted\":false,\"format\":\"YAML\",\"createdBy\":\"Installer\"}",
                "description": "Control Plane Installation Patch: s3_storage_patch"
            }
        ]
    },
    "error": null
}

url = api_root + '/patches/' + version

headers = {
  'Token': token,
}
resp = requests.delete(url, headers=headers)

HTTP STATUS CODE 200

{
  "data": {
    "successful_apply": [
      <string: the names of the objects that were successfully updated in the cluster>
    ]
  },
  "status_code": 200
}

# body
{
  "data": {
    "successful_apply": [
      <string: the names of the objects that were successfully updated in the cluster>
    ],
    "failed_to_apply": [
      <string: the names of the objects that failed to get updated in the cluster>
    ],
  },
  "status_code": <number: the status code of the response>,
  "error": <string: the reason for the failure>
}

url = api_root + '/patches/namespace'
data = dict(
  namespace = "instabase", # the new namespace for Instabase to run in
  description = "The namespace for the new cluster.",
)
headers = {
  'Token': token,
}
resp = requests.post(url, headers=headers, data=json.dumps(data)).json()

HTTP STATUS CODE 200
{
  "data": {
    "successful_apply": [
      <string: the names of the objects that were successfully updated in the cluster>
    ]
  },
  "status_code": 200
}

# body
{
  "data": {
    "successful_apply": [
      <string: the names of the objects that were successfully updated in the cluster>
    ],
    "failed_to_apply": [
      <string: the names of the objects that failed to get updated in the cluster>
    ],
  },
  "status_code": <number: the status code of the response>,
  "error": <string: the reason for the failure>
}

url = api_root + '/patches/registry'

data = dict(
  registry = "gcr.io/instabase-public", # the new image registry to pull the Instabase docker images from
)

headers = {
  'Token': token,
}
resp = requests.post(url, headers=headers, data=json.dumps(data)).json()

HTTP STATUS CODE 200

{
  "data": {
    "successful_apply": [
      <string: the names of the objects that were successfully updated in the cluster>
    ]
  },
  "status_code": 200
}

# body
{
  "data": {
    "successful_apply": [
      <string: the names of the objects that were successfully updated in the cluster>
    ],
    "failed_to_apply": [
      <string: the names of the objects that failed to get updated in the cluster>
    ],
  },
  "status_code": <number: the status code of the response>,
  "error": <string: the reason for the failure>
}

url = api_root + '/configs'

headers = {
  'Token': token,
}
resp = requests.get(url, headers=headers).json()

HTTP STATUS CODE 200

# body
{
  "configs": [
    {
      "objectName": <string>,
      "releaseVersion": <string>,
      "patchVersion": <integer>,
      "previousReleaseVersion": <string>,
      "previousPatchVersion": <integer>,
      "state": <string>,
      "config": <string>,
      "metadata": <string>,
      "timestampMS": <integer>
    }
    ...
  ]
}

url = api_root + '/configs/service-victoriametrics'

headers = {
  'Token': token,
}
resp = requests.get(url, headers=headers).json()

GET api_root/configs/service-victoriametrics

{
    "objectName": "service-victoriametrics",
    "releaseVersion": "$RELEASE_VERSION",
    "patchVersion": 0,
    "previousReleaseVersion": "",
    "previousPatchVersion": 0,
    "state": "NOT_GOLDEN",
    "config": "apiVersion: v1\nkind: Service\nmetadata:\n  name: service-victoriametrics\n  namespace: instabase\n  labels:\n    app: 
victoriametrics\n  annotations:\n    monitoring/enabled: \"true\"\nspec:\n  selector:\n    app: victoriametrics\n  ports:\n    - name: http\n      
protocol: TCP\n      port: 8428\n      targetPort: http\n  clusterIP: None\n",
    "metadata": "{\"type\":\"Service\",\"isEncrypted\":false}",
    "timestampMS": 1656287479653
}

url = api_root + '/deployment/update'

headers = {
  'Token': token,
}
resp = requests.post(url, headers=headers, data=json.dumps(data)).json()

POST api_root/deployment/update

{
    "statusCode": 200,
    "data": {
        "successful_apply": [
           "alertmanager-egress",
           "api-server-apps-egress",
           "service-victoriametrics"
        ]
    },
    "error": null
}

url = api_root + '/resource_labels'

headers = {
  'Token': token,
}
resp = requests.post(url, headers=headers, data=json.dumps(data)).json()

POST api_root/deployment/update

{
    "statusCode": 200,
    "data": {
        "labels": [
           "ConfigMap",
           "Deployment",
           "Job"
        ]
    },
    "error": null
}

url = api_root + '/resource_labels/binding'

data = ("label=database"
        "&label=grpc"
        "&object_name=deployment-a-service"
        "&object_name=deployment-b-service"
        "&object_name=deployment-c-service")

headers = {
    'Token': token,
    'content-type': 'application/x-www-form-urlencoded'
}

resp = requests.post(url, headers=headers, data=data)

{
    "statusCode": 200,
    "data": {
        "successful_apply": [
           "alertmanager-egress",
           "api-server-apps-egress",
           "service-victoriametrics"
        ]
    },
    "error": null
}

GET api_root/resource_labels/objects/LABEL?must_exist=false

url = api_root + '/resource_labels/objects/' + label

headers = {
  'Token': token,
}
resp = requests.get(url, headers=headers).json()

HTTP STATUS CODE 200

# body
{
  "objects": <list<string: Kubernetes object name>>
}

GET api_root/resource_labels/labels/OBJECT_NAME

url = api_root + '/resource_labels/labels/' + object_name

headers = {
  'Token': token,
}
resp = requests.get(url, headers=headers).json()

HTTP STATUS CODE 200

# body
{
  "labels": <list<string: label name>>
}

DELETE api_root/resource_labels/binding/OBJECT_NAME

url = api_root + '/resource_labels/binding/' + object_name

headers = {
  'Token': token,
}
resp = requests.delete(url, headers=headers)

HTTP STATUS CODE 200

POST api_root/resource_labels/update-defaults

url = api_root + '/resource_labels/update-defaults'

headers = {
  'Token': token,
}
resp = requests.post(url, headers=headers)

HTTP STATUS CODE 200