pydo.kubernetes.run_cluster_lint()
Generated on 1 May 2025
from pydo
version
v0.11.0
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/$K8S_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
Name | Type | Required | Description | Default Value |
---|---|---|---|---|
cluster_id |
string | True | A unique ID that can be used to reference a Kubernetes cluster. | |
body |
JSON or IO[bytes] | False |
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)
More Information
See the API spec for this endpoint to view additional detail on responses, headers, parameters, and more.