Give Feedback

one_click

Generated on 11 Jul 2025 from digitalocean.cloud version v1.2.1

Synopsis

Install Kubernetes 1-Click applications. View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#operation/oneClicks_install_kubernetes. View the DigitalOcean Marketplace for available 1-Click applications at https://marketplace.digitalocean.com/.

Requirements

pydo >= 0.1.3
azure-core >= 1.26.1

Parameters

Parameter	Choices / Default	Description
`addon_slugs` list / elements=str / required		An array of 1-Click Application slugs to be installed to the Kubernetes cluster.
`client_override_options` dict		Client override options (developer use). For example, can be used to override the DigitalOcean API endpoint for an internal test suite. If provided, these options will knock out existing options.
`cluster_uuid` str / required		A unique ID for the Kubernetes cluster to which the 1-Click Applications will be installed.
`module_override_options` dict		Module override options (developer use). Can be used to override module options to support experimental or future options. If provided, these options will knock out existing options.
`state` str	Choices: `present` (default) `absent`	State of the resource, `present` to create, `absent` to destroy.
`timeout` int	Default: `300`	Polling timeout in seconds.
`token` str		DigitalOcean API token. There are several environment variables which can be used to provide this value. `DIGITALOCEAN_ACCESS_TOKEN`, `DIGITALOCEAN_TOKEN`, `DO_API_TOKEN`, `DO_API_KEY`, `DO_OAUTH_TOKEN` and `OAUTH_TOKEN`

Examples

- name: Install 1-Click Applications
  digitalocean.cloud.one_click:
    token: "{{ token }}"
    addon_slugs:
      - kube-state-metrics
      - loki
    cluster_uuid: 50a994b6-c303-438f-9495-7e896cfe6b08

Return Values

Key	Returned	Description
`error` dict	failure	DigitalOcean API error. Sample: `{ "Message": "Informational error message.", "Reason": "Unauthorized", "Status Code": 401 }`
`msg` str	always	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 be managed via the DigitalOcean API. For additional details specific to the 1-Click, find and view its DigitalOcean Marketplace page. Sample: `[ "Successfully kicked off addon job.", "Would install kube-state-metrics, loki into Kubernetes cluster 50a994b6-c303-438f-9495-7e896cfe6b08" ]`