Settings API - Monitoring settings schema table
Connection settings (builtin:cloud.kubernetes)
Connect to Kubernetes or OpenShift for enhanced observability. Learn more about Kubernetes or OpenShift in our documentation.
| Schema ID | Schema groups | Scope |
|---|---|---|
builtin:cloud.kubernetes | - | KUBERNETES_CLUSTER - Kubernetes cluster |
Parameters
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| enabled | Enabled | boolean | - | required |
| label | Name | text | Renaming the cluster breaks configurations that are based on its name (e.g., management zones, and alerting). | required |
| clusterIdEnabled | Connect containerized ActiveGate to local Kubernetes API endpoint | boolean | For more information on local Kubernetes API monitoring, see the documentation. Enable this toggle when the ActiveGate is deployed to the same Kubernetes clusters you want to monitor. Disable it if you want to monitor a different Kubernetes cluster. | required |
| clusterId | Kubernetes cluster ID | text | Unique ID of the cluster, the containerized ActiveGate is deployed to. Defaults to the UUID of the kube-system namespace. The cluster ID of containerized ActiveGates is shown on the Deployment status screen. | required |
| endpointUrl | Kubernetes API URL Target | text | Get the API URL for Kubernetes or OpenShift. | required |
| authToken | Kubernetes Bearer Token | secret | Create a bearer token for Kubernetes or OpenShift. | required |
| activeGateGroup | ActiveGate Group | text | - | optional |
| certificateCheckEnabled | Require valid certificates for communication with API server (recommended) | boolean | - | required |
| hostnameVerificationEnabled | Verify hostname in certificate against Kubernetes API URL | boolean | - | required |
Request body objects
The FlagDefaultTrue object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| enabled | Monitoring Enabled | boolean | - | required |