Fleet API reference
Packages:
fleet.kurator.dev/v1alpha1
Package v1alpha1 contains API Schema definitions for the fleet v1alpha1 API group
Resource Types:Fleet
Fleet represents a group of clusters, it is to consistently manage a group of clusters.
Field | Description | ||||
---|---|---|---|---|---|
apiVersion string |
fleet.kurator.dev/v1alpha1
|
||||
kind string |
Fleet
|
||||
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||
spec FleetSpec |
|
||||
status FleetStatus |
ChartConfig
(Appears on: GrafanaConfig, KyvernoConfig, PrometheusConfig, ThanosConfig)
Field | Description |
---|---|
repository string |
(Optional)
Repository defines the repository of chart. Default value depends on the kind of the component. |
name string |
(Optional)
Name defines the name of the chart. Default value depends on the kind of the component. |
version string |
(Optional)
Version defines the version of the chart. Default value depends on the kind of the component. |
Endpoints
([]string
alias)
(Appears on: FleetStatus)
FleetPhase
(string
alias)
(Appears on: FleetStatus)
FleetSpec
(Appears on: Fleet)
FleetSpec defines the desired state of the fleet
Field | Description |
---|---|
clusters []Kubernetes core/v1.ObjectReference |
Clusters represents the clusters that would be registered to the fleet. |
plugin PluginConfig |
(Optional)
Plugin defines the plugins that would be installed in the fleet. |
FleetStatus
(Appears on: Fleet)
FleetStatus defines the observed state of the fleet
Field | Description |
---|---|
credentialSecret string |
CredentialSecret is the secret name that holds credentials used for accessing the fleet control plane. |
phase FleetPhase |
(Optional)
Phase represents the current phase of fleet. E.g. Pending, Running, Terminating, Failed, Ready, etc. |
reason string |
(Optional)
A brief CamelCase message indicating details about why the fleet is in this state. |
pluginEndpoints map[ string ][ Endpoints ] |
PluginEndpoints is the endpoints of the plugins. |
readyClusters int32 |
Total number of ready clusters, ready to deploy . |
unReadyClusters int32 |
Total number of unready clusters, not ready for use. |
GrafanaConfig
(Appears on: PluginConfig)
Field | Description |
---|---|
chart ChartConfig |
(Optional)
Chart defines the helm chart config of the grafana. default values is chart: repository: oci://registry-1.docker.io/bitnamicharts name: grafana version: 8.2.33 |
extraArgs Kubernetes /apiextensions/v1.JSON |
(Optional)
ExtraArgs is the set of extra arguments for Grafana chart. For Example, using following configuration to change replica count. extraArgs: grafana: replicaCount: 2 |
KyvernoConfig
(Appears on: PolicyConfig)
Field | Description |
---|---|
chart ChartConfig |
(Optional)
Chart defines the helm chart config of the kyverno. default values is chart: repository: https://kyverno.github.io/kyverno/ name: kyverno version: 3.0.0 |
podSecurity PodSecurityPolicy |
(Optional)
PodSecurity defines the pod security configuration for the kyverno. |
extraArgs Kubernetes /apiextensions/v1.JSON |
(Optional)
ExtraArgs is the set of extra arguments for Grafana chart. For Example, using following configuration to change image pull policy. extraArgs: image: pullPolicy: Always |
MetricConfig
(Appears on: PluginConfig)
Field | Description |
---|---|
thanos ThanosConfig |
Thanos defines the configuration for the thanos querier and store gateway. |
prometheus PrometheusConfig |
Prometheus defines the configuration for the prometheus installation in the clusters observed by the thanos, by default thanos sidecar will be installed in thanos sidecar mode. |
ObjectStoreConfig
(Appears on: ThanosConfig)
Field | Description |
---|---|
secretName string |
SecretName is the name of the secret that holds the object store configuration.
The path of object store configuration must be |
PluginConfig
(Appears on: FleetSpec)
Field | Description |
---|---|
metric MetricConfig |
(Optional)
Metric defines the configuration for the monitoring system installation and metrics collection.. |
grafana GrafanaConfig |
(Optional)
Grafana defines the configuration for the grafana installation and observation. |
policy PolicyConfig |
Policy defines the configuration for the ploicy management. |
PodSecurityPolicy
(Appears on: KyvernoConfig)
Field | Description |
---|---|
standard string |
(Optional)
Standard defines the pod security standard. More details: https://kubernetes.io/docs/concepts/security/pod-security-standards |
severity string |
(Optional)
Severity indicates policy check result criticality in a policy report. |
validationFailureAction string |
(Optional)
ValidationFailureAction indicates the action to take when a pod creation fails to validate. For more info https://kyverno.io/docs/writing-policies/validate/#validation-failure-action |
PolicyConfig
(Appears on: PluginConfig)
Field | Description |
---|---|
kyverno KyvernoConfig |
(Optional)
Kyverno defines the configuration for the kyverno installation and policy management. |
PrometheusConfig
(Appears on: MetricConfig)
Field | Description |
---|---|
chart ChartConfig |
(Optional)
Chart defines the helm chart config of the prometheus. default values is chart: repository: oci://registry-1.docker.io/bitnamicharts name: kube-prometheus version: 8.9.1 |
nodeExporter PrometheusExporterConfig |
(Optional)
NodeExporter defines the configuration for the node exporter. |
kubeStateMetrics PrometheusExporterConfig |
(Optional)
KubeStateMetrics defines the configuration for the kube-state-metrics. |
extraArgs Kubernetes /apiextensions/v1.JSON |
(Optional)
ExtraArgs is the set of extra arguments for Prometheus chart. For Example, using following configuration to create a ServiceMonitor to monitor prometheus itself. extraArgs: prometheus: serviceMonitor: enabled: true |
PrometheusExporterConfig
(Appears on: PrometheusConfig)
Field | Description |
---|---|
enabled bool |
Enabled indicates whether the exporters are enabled. |
ThanosConfig
(Appears on: MetricConfig)
Field | Description |
---|---|
chart ChartConfig |
(Optional)
Chart defines the helm chart config of the thanos. default values is chart: repository: oci://registry-1.docker.io/bitnamicharts name: thanos version: 12.5.1 |
objectStoreConfig ObjectStoreConfig |
ObjectStoreConfig is the secret reference of the object store. Configuration must follow the definition of the thanos: https://thanos.io/tip/thanos/storage.md/. |
extraArgs Kubernetes /apiextensions/v1.JSON |
(Optional)
ExtraArgs is the set of extra arguments for Thanos chart. For Example, using following configuration to enable query frontend. extraArgs: queryFrontend: enabled: true |
This page was automatically generated with gen-crd-api-reference-docs