pydo.one_clicks.install_kubernetes()

Description

To install a Kubernetes 1-Click application on a cluster, send a POST request to /v2/1-clicks/kubernetes. The addon_slugs and cluster_uuid must be provided as body parameter in order to specify which 1-Click application(s) to install. To list all available 1-Click Kubernetes applications, send a request to /v2/1-clicks?type=kubernetes.

Request Sample

import os
from pydo import Client

client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))

install_req = {
    "addon_slugs": ["kube-state-metrics", "loki"],
    "cluster_uuid": "50a994b6-c303-438f-9495-7e896cfe6b08",
}
install_resp = client.one_clicks.install_kubernetes(install_req)

Responses

See the API spec for this endpoint to view additional detail on responses, headers, parameters, and more.

The response will verify that a job has been successfully created to install a 1-Click. The post-installation lifecycle of a 1-Click application can not be managed via the DigitalOcean API. For additional details specific to the 1-Click, find and view its DigitalOcean Marketplace page.

Click to expand an example response for Install a 1-Click Application.
{
  "value": {
    "message": "Successfully kicked off addon job."
  }
}

Unauthorized

Click to expand an example response.
{
  "id": "unauthorized",
  "message": "Unable to authenticate you."
}

API Rate limit exceeded

Click to expand an example response.
{
  "id": "too_many_requests",
  "message": "API Rate limit exceeded."
}

Server error.

Click to expand an example response.
{
  "id": "server_error",
  "message": "Unexpected server-side error"
}

Unexpected error

Click to expand an example response.
{
  "id": "example_error",
  "message": "some error message"
}