For AI agents: The documentation index is at https://docs.digitalocean.com/llms.txt. Markdown versions of pages use the same URL with index.html.md in place of the HTML page (for example, append index.html.md to the directory path instead of opening the HTML document).

Usage

client.kubernetes.run_cluster_lint(
    cluster_id="bd5f5959-5e1e-4205-a714-a914373942af",
    body={
        "include_groups": [...],
        "include_checks": [...],
        "exclude_groups": [...],
        ...,
    },
)

Description

Clusterlint helps operators conform to Kubernetes best practices around resources, security and reliability to avoid common problems while operating or upgrading the clusters.

To request a clusterlint run on your cluster, send a POST request to /v2/kubernetes/clusters/{cluster_id}/clusterlint. This will run all checks present in the doks group by default, if a request body is not specified. Optionally specify the below attributes.

For information about the available checks, please refer to the clusterlint check documentation.

Parameters

cluster_id string required

A unique ID that can be used to reference a Kubernetes cluster.

Min: 1

include_groups array of strings optional

Example: ['basic', 'doks', 'security']

An array of check groups that will be run when clusterlint executes checks.

include_checks array of strings optional

Example: ['bare-pods', 'resource-requirements']

An array of checks that will be run when clusterlint executes checks.

exclude_groups array of strings optional

Example: ['workload-health']

An array of check groups that will be omitted when clusterlint executes checks.

exclude_checks array of strings optional

Example: ['default-namespace']

An array of checks that will be run when clusterlint executes checks.

Request Sample

import os
from pydo import Client

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

req = {
  "include_groups": [
    "basic",
    "doks",
    "security"
  ],
  "include_checks": [
    "bare-pods",
    "resource-requirements"
  ],
  "exclude_groups": [
    "workload-health"
  ],
  "exclude_checks": [
    "default-namespace"
  ]
}

resp = client.kubernetes.run_cluster_lint(cluster_id="1fd32a", body=req)

Response Example

{
  "run_id": "50c2f44c-011d-493e-aee5-361a4a0d1844"
}

More Information

See /v2/kubernetes/clusters/{cluster_id}/clusterlint in the API reference for additional detail on responses, headers, parameters, and more.