ClusterAPI Config Schema¶
Note
This is auto-generated documentation from a JSON schema that is under construction, this will improve over time.
Return to the root config schema
https://raw.githubusercontent.com/elastisys/compliantkubernetes-apps/main/config/schemas/config.yaml#/properties/clusterApi
Set to true if kubernetes is installed with cluster-api.
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | config/schemas/config.yaml* |
TYPE:
object (ClusterAPI Config)
PROPERTIES:
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| clusters | array |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| enabled | boolean |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| monitoring | object |
Optional | cannot be null | Compliant Kubernetes Apps Config |
clusters¶
List of clusters to monitor.
Used when monitoring clusters for autoscaling.
clusters
-
is optional
-
Type:
string[] -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string[]
enabled¶
enabled
-
is optional
-
Type:
boolean(ClusterAPI Enabled) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
boolean (ClusterAPI Enabled)
monitoring¶
Enable autoscaling monitoring of cluster API clusters.
monitoring
-
is optional
-
Type:
object(ClusterAPI Monitoring) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
object (ClusterAPI Monitoring)
Return to the root config schema
Generated Sat Jun 22 03:48:20 UTC 2024 from elastisys/compliantkubernetes-apps@main