diff --git a/manifests/alertmanager-prometheusRule.yaml b/manifests/alertmanager-prometheusRule.yaml
index 7a38bc26d6ad99b4f43cf552286b59233e3194c1..534bca21074e9f31f00b84d2902b38d3dc4e4edf 100644
--- a/manifests/alertmanager-prometheusRule.yaml
+++ b/manifests/alertmanager-prometheusRule.yaml
@@ -17,8 +17,7 @@ spec:
rules:
- alert: AlertmanagerFailedReload
annotations:
- description: Configuration has failed to load for {{ $labels.namespace }}/{{
- $labels.pod}}.
+ description: Configuration has failed to load for {{ $labels.namespace }}/{{ $labels.pod}}.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/alertmanager/alertmanagerfailedreload
summary: Reloading an Alertmanager configuration has failed.
expr: |
@@ -30,11 +29,9 @@ spec:
severity: critical
- alert: AlertmanagerMembersInconsistent
annotations:
- description: Alertmanager {{ $labels.namespace }}/{{ $labels.pod}} has only
- found {{ $value }} members of the {{$labels.job}} cluster.
+ description: Alertmanager {{ $labels.namespace }}/{{ $labels.pod}} has only found {{ $value }} members of the {{$labels.job}} cluster.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/alertmanager/alertmanagermembersinconsistent
- summary: A member of an Alertmanager cluster has not found all other cluster
- members.
+ summary: A member of an Alertmanager cluster has not found all other cluster members.
expr: |
# Without max_over_time, failed scrapes could create false negatives, see
# https://www.robustperception.io/alerting-on-gauges-in-prometheus-2-0 for details.
@@ -46,9 +43,7 @@ spec:
severity: critical
- alert: AlertmanagerFailedToSendAlerts
annotations:
- description: Alertmanager {{ $labels.namespace }}/{{ $labels.pod}} failed
- to send {{ $value | humanizePercentage }} of notifications to {{ $labels.integration
- }}.
+ description: Alertmanager {{ $labels.namespace }}/{{ $labels.pod}} failed to send {{ $value | humanizePercentage }} of notifications to {{ $labels.integration }}.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/alertmanager/alertmanagerfailedtosendalerts
summary: An Alertmanager instance failed to send notifications.
expr: |
@@ -63,12 +58,9 @@ spec:
severity: warning
- alert: AlertmanagerClusterFailedToSendAlerts
annotations:
- description: The minimum notification failure rate to {{ $labels.integration
- }} sent from any instance in the {{$labels.job}} cluster is {{ $value |
- humanizePercentage }}.
+ description: The minimum notification failure rate to {{ $labels.integration }} sent from any instance in the {{$labels.job}} cluster is {{ $value | humanizePercentage }}.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/alertmanager/alertmanagerclusterfailedtosendalerts
- summary: All Alertmanager instances in a cluster failed to send notifications
- to a critical integration.
+ summary: All Alertmanager instances in a cluster failed to send notifications to a critical integration.
expr: |
min by (namespace,service, integration) (
rate(alertmanager_notifications_failed_total{job="alertmanager-main",namespace="monitoring", integration=~`.*`}[5m])
@@ -81,12 +73,9 @@ spec:
severity: critical
- alert: AlertmanagerClusterFailedToSendAlerts
annotations:
- description: The minimum notification failure rate to {{ $labels.integration
- }} sent from any instance in the {{$labels.job}} cluster is {{ $value |
- humanizePercentage }}.
+ description: The minimum notification failure rate to {{ $labels.integration }} sent from any instance in the {{$labels.job}} cluster is {{ $value | humanizePercentage }}.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/alertmanager/alertmanagerclusterfailedtosendalerts
- summary: All Alertmanager instances in a cluster failed to send notifications
- to a non-critical integration.
+ summary: All Alertmanager instances in a cluster failed to send notifications to a non-critical integration.
expr: |
min by (namespace,service, integration) (
rate(alertmanager_notifications_failed_total{job="alertmanager-main",namespace="monitoring", integration!~`.*`}[5m])
@@ -99,8 +88,7 @@ spec:
severity: warning
- alert: AlertmanagerConfigInconsistent
annotations:
- description: Alertmanager instances within the {{$labels.job}} cluster have
- different configurations.
+ description: Alertmanager instances within the {{$labels.job}} cluster have different configurations.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/alertmanager/alertmanagerconfiginconsistent
summary: Alertmanager instances within the same cluster have different configurations.
expr: |
@@ -113,12 +101,9 @@ spec:
severity: critical
- alert: AlertmanagerClusterDown
annotations:
- description: '{{ $value | humanizePercentage }} of Alertmanager instances
- within the {{$labels.job}} cluster have been up for less than half of the
- last 5m.'
+ description: '{{ $value | humanizePercentage }} of Alertmanager instances within the {{$labels.job}} cluster have been up for less than half of the last 5m.'
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/alertmanager/alertmanagerclusterdown
- summary: Half or more of the Alertmanager instances within the same cluster
- are down.
+ summary: Half or more of the Alertmanager instances within the same cluster are down.
expr: |
(
count by (namespace,service) (
@@ -135,12 +120,9 @@ spec:
severity: critical
- alert: AlertmanagerClusterCrashlooping
annotations:
- description: '{{ $value | humanizePercentage }} of Alertmanager instances
- within the {{$labels.job}} cluster have restarted at least 5 times in the
- last 10m.'
+ description: '{{ $value | humanizePercentage }} of Alertmanager instances within the {{$labels.job}} cluster have restarted at least 5 times in the last 10m.'
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/alertmanager/alertmanagerclustercrashlooping
- summary: Half or more of the Alertmanager instances within the same cluster
- are crashlooping.
+ summary: Half or more of the Alertmanager instances within the same cluster are crashlooping.
expr: |
(
count by (namespace,service) (
diff --git a/manifests/grafana-prometheusRule.yaml b/manifests/grafana-prometheusRule.yaml
index b31ee879c93bccca342b9cc9d7a9dd752ac7fc4c..600374e4777ec3a63f21650d785b82924a016ec0 100644
--- a/manifests/grafana-prometheusRule.yaml
+++ b/manifests/grafana-prometheusRule.yaml
@@ -16,8 +16,7 @@ spec:
rules:
- alert: GrafanaRequestsFailing
annotations:
- message: '{{ $labels.namespace }}/{{ $labels.job }}/{{ $labels.handler }}
- is experiencing {{ $value | humanize }}% errors'
+ message: '{{ $labels.namespace }}/{{ $labels.job }}/{{ $labels.handler }} is experiencing {{ $value | humanize }}% errors'
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/grafana/grafanarequestsfailing
expr: |
100 * namespace_job_handler_statuscode:grafana_http_request_duration_seconds_count:rate5m{handler!~"/api/datasources/proxy/:id.*|/api/ds/query|/api/tsdb/query", status_code=~"5.."}
diff --git a/manifests/kubePrometheus-prometheusRule.yaml b/manifests/kubePrometheus-prometheusRule.yaml
index 8ed330ba7bbf94ae0801f7cbc44eb68903df57a2..0facf214fa83c8581765379cd5af59a35a86d6ff 100644
--- a/manifests/kubePrometheus-prometheusRule.yaml
+++ b/manifests/kubePrometheus-prometheusRule.yaml
@@ -15,12 +15,10 @@ spec:
rules:
- alert: TargetDown
annotations:
- description: '{{ printf "%.4g" $value }}% of the {{ $labels.job }}/{{ $labels.service
- }} targets in {{ $labels.namespace }} namespace are down.'
+ description: '{{ printf "%.4g" $value }}% of the {{ $labels.job }}/{{ $labels.service }} targets in {{ $labels.namespace }} namespace are down.'
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/general/targetdown
summary: One or more targets are unreachable.
- expr: 100 * (count(up == 0) BY (job, namespace, service) / count(up) BY (job,
- namespace, service)) > 10
+ expr: 100 * (count(up == 0) BY (job, namespace, service) / count(up) BY (job, namespace, service)) > 10
for: 10m
labels:
severity: warning
@@ -33,8 +31,7 @@ spec:
mechanisms that send a notification when this alert is not firing. For example the
"DeadMansSnitch" integration in PagerDuty.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/general/watchdog
- summary: An alert that should always be firing to certify that Alertmanager
- is working properly.
+ summary: An alert that should always be firing to certify that Alertmanager is working properly.
expr: vector(1)
labels:
severity: none
@@ -49,16 +46,14 @@ spec:
This alert should be routed to a null receiver and configured to inhibit alerts with severity="info".
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/general/infoinhibitor
summary: Info-level alert inhibition.
- expr: ALERTS{severity = "info"} == 1 unless on(namespace) ALERTS{alertname !=
- "InfoInhibitor", severity =~ "warning|critical", alertstate="firing"} == 1
+ expr: ALERTS{severity = "info"} == 1 unless on(namespace) ALERTS{alertname != "InfoInhibitor", severity =~ "warning|critical", alertstate="firing"} == 1
labels:
severity: none
- name: node-network
rules:
- alert: NodeNetworkInterfaceFlapping
annotations:
- description: Network interface "{{ $labels.device }}" changing its up status
- often on node-exporter {{ $labels.namespace }}/{{ $labels.pod }}
+ description: Network interface "{{ $labels.device }}" changing its up status often on node-exporter {{ $labels.namespace }}/{{ $labels.pod }}
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/general/nodenetworkinterfaceflapping
summary: Network interface is often changing its status
expr: |
@@ -68,21 +63,17 @@ spec:
severity: warning
- name: kube-prometheus-node-recording.rules
rules:
- - expr: sum(rate(node_cpu_seconds_total{mode!="idle",mode!="iowait",mode!="steal"}[3m]))
- BY (instance)
+ - expr: sum(rate(node_cpu_seconds_total{mode!="idle",mode!="iowait",mode!="steal"}[3m])) BY (instance)
record: instance:node_cpu:rate:sum
- expr: sum(rate(node_network_receive_bytes_total[3m])) BY (instance)
record: instance:node_network_receive_bytes:rate:sum
- expr: sum(rate(node_network_transmit_bytes_total[3m])) BY (instance)
record: instance:node_network_transmit_bytes:rate:sum
- - expr: sum(rate(node_cpu_seconds_total{mode!="idle",mode!="iowait",mode!="steal"}[5m]))
- WITHOUT (cpu, mode) / ON(instance) GROUP_LEFT() count(sum(node_cpu_seconds_total)
- BY (instance, cpu)) BY (instance)
+ - expr: sum(rate(node_cpu_seconds_total{mode!="idle",mode!="iowait",mode!="steal"}[5m])) WITHOUT (cpu, mode) / ON(instance) GROUP_LEFT() count(sum(node_cpu_seconds_total) BY (instance, cpu)) BY (instance)
record: instance:node_cpu:ratio
- expr: sum(rate(node_cpu_seconds_total{mode!="idle",mode!="iowait",mode!="steal"}[5m]))
record: cluster:node_cpu:sum_rate5m
- - expr: cluster:node_cpu:sum_rate5m / count(sum(node_cpu_seconds_total) BY (instance,
- cpu))
+ - expr: cluster:node_cpu:sum_rate5m / count(sum(node_cpu_seconds_total) BY (instance, cpu))
record: cluster:node_cpu:ratio
- name: kube-prometheus-general.rules
rules:
diff --git a/manifests/kubeStateMetrics-prometheusRule.yaml b/manifests/kubeStateMetrics-prometheusRule.yaml
index db84f3ce5ebdd48094a5bbd9a2971257b7616463..bff3cdee3c79e0b5b1572478c9f87ee416f1604c 100644
--- a/manifests/kubeStateMetrics-prometheusRule.yaml
+++ b/manifests/kubeStateMetrics-prometheusRule.yaml
@@ -16,9 +16,7 @@ spec:
rules:
- alert: KubeStateMetricsListErrors
annotations:
- description: kube-state-metrics is experiencing errors at an elevated rate
- in list operations. This is likely causing it to not be able to expose metrics
- about Kubernetes objects correctly or at all.
+ description: kube-state-metrics is experiencing errors at an elevated rate in list operations. This is likely causing it to not be able to expose metrics about Kubernetes objects correctly or at all.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kube-state-metrics/kubestatemetricslisterrors
summary: kube-state-metrics is experiencing errors in list operations.
expr: |
@@ -31,9 +29,7 @@ spec:
severity: critical
- alert: KubeStateMetricsWatchErrors
annotations:
- description: kube-state-metrics is experiencing errors at an elevated rate
- in watch operations. This is likely causing it to not be able to expose
- metrics about Kubernetes objects correctly or at all.
+ description: kube-state-metrics is experiencing errors at an elevated rate in watch operations. This is likely causing it to not be able to expose metrics about Kubernetes objects correctly or at all.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kube-state-metrics/kubestatemetricswatcherrors
summary: kube-state-metrics is experiencing errors in watch operations.
expr: |
@@ -46,9 +42,7 @@ spec:
severity: critical
- alert: KubeStateMetricsShardingMismatch
annotations:
- description: kube-state-metrics pods are running with different --total-shards
- configuration, some Kubernetes objects may be exposed multiple times or
- not exposed at all.
+ description: kube-state-metrics pods are running with different --total-shards configuration, some Kubernetes objects may be exposed multiple times or not exposed at all.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kube-state-metrics/kubestatemetricsshardingmismatch
summary: kube-state-metrics sharding is misconfigured.
expr: |
@@ -58,8 +52,7 @@ spec:
severity: critical
- alert: KubeStateMetricsShardsMissing
annotations:
- description: kube-state-metrics shards are missing, some Kubernetes objects
- are not being exposed.
+ description: kube-state-metrics shards are missing, some Kubernetes objects are not being exposed.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kube-state-metrics/kubestatemetricsshardsmissing
summary: kube-state-metrics shards are missing.
expr: |
diff --git a/manifests/kubernetesControlPlane-prometheusRule.yaml b/manifests/kubernetesControlPlane-prometheusRule.yaml
index 10f2b087ae525b600b7a9c6dd47d5c6089d844fb..9f25e4fc94476eb80d2d49f355e702af569ed1c8 100644
--- a/manifests/kubernetesControlPlane-prometheusRule.yaml
+++ b/manifests/kubernetesControlPlane-prometheusRule.yaml
@@ -14,8 +14,7 @@ spec:
rules:
- alert: KubePodCrashLooping
annotations:
- description: 'Pod {{ $labels.namespace }}/{{ $labels.pod }} ({{ $labels.container
- }}) is in waiting state (reason: "CrashLoopBackOff").'
+ description: 'Pod {{ $labels.namespace }}/{{ $labels.pod }} ({{ $labels.container }}) is in waiting state (reason: "CrashLoopBackOff").'
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubepodcrashlooping
summary: Pod is crash looping.
expr: |
@@ -25,8 +24,7 @@ spec:
severity: warning
- alert: KubePodNotReady
annotations:
- description: Pod {{ $labels.namespace }}/{{ $labels.pod }} has been in a non-ready
- state for longer than 15 minutes.
+ description: Pod {{ $labels.namespace }}/{{ $labels.pod }} has been in a non-ready state for longer than 15 minutes.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubepodnotready
summary: Pod has been in a non-ready state for more than 15 minutes.
expr: |
@@ -42,9 +40,7 @@ spec:
severity: warning
- alert: KubeDeploymentGenerationMismatch
annotations:
- description: Deployment generation for {{ $labels.namespace }}/{{ $labels.deployment
- }} does not match, this indicates that the Deployment has failed but has
- not been rolled back.
+ description: Deployment generation for {{ $labels.namespace }}/{{ $labels.deployment }} does not match, this indicates that the Deployment has failed but has not been rolled back.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubedeploymentgenerationmismatch
summary: Deployment generation mismatch due to possible roll-back
expr: |
@@ -56,8 +52,7 @@ spec:
severity: warning
- alert: KubeDeploymentReplicasMismatch
annotations:
- description: Deployment {{ $labels.namespace }}/{{ $labels.deployment }} has
- not matched the expected number of replicas for longer than 15 minutes.
+ description: Deployment {{ $labels.namespace }}/{{ $labels.deployment }} has not matched the expected number of replicas for longer than 15 minutes.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubedeploymentreplicasmismatch
summary: Deployment has not matched the expected number of replicas.
expr: |
@@ -75,8 +70,7 @@ spec:
severity: warning
- alert: KubeStatefulSetReplicasMismatch
annotations:
- description: StatefulSet {{ $labels.namespace }}/{{ $labels.statefulset }}
- has not matched the expected number of replicas for longer than 15 minutes.
+ description: StatefulSet {{ $labels.namespace }}/{{ $labels.statefulset }} has not matched the expected number of replicas for longer than 15 minutes.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubestatefulsetreplicasmismatch
summary: Deployment has not matched the expected number of replicas.
expr: |
@@ -94,9 +88,7 @@ spec:
severity: warning
- alert: KubeStatefulSetGenerationMismatch
annotations:
- description: StatefulSet generation for {{ $labels.namespace }}/{{ $labels.statefulset
- }} does not match, this indicates that the StatefulSet has failed but has
- not been rolled back.
+ description: StatefulSet generation for {{ $labels.namespace }}/{{ $labels.statefulset }} does not match, this indicates that the StatefulSet has failed but has not been rolled back.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubestatefulsetgenerationmismatch
summary: StatefulSet generation mismatch due to possible roll-back
expr: |
@@ -108,8 +100,7 @@ spec:
severity: warning
- alert: KubeStatefulSetUpdateNotRolledOut
annotations:
- description: StatefulSet {{ $labels.namespace }}/{{ $labels.statefulset }}
- update has not been rolled out.
+ description: StatefulSet {{ $labels.namespace }}/{{ $labels.statefulset }} update has not been rolled out.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubestatefulsetupdatenotrolledout
summary: StatefulSet update has not been rolled out.
expr: |
@@ -135,8 +126,7 @@ spec:
severity: warning
- alert: KubeDaemonSetRolloutStuck
annotations:
- description: DaemonSet {{ $labels.namespace }}/{{ $labels.daemonset }} has
- not finished or progressed for at least 15 minutes.
+ description: DaemonSet {{ $labels.namespace }}/{{ $labels.daemonset }} has not finished or progressed for at least 15 minutes.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubedaemonsetrolloutstuck
summary: DaemonSet rollout is stuck.
expr: |
@@ -168,9 +158,7 @@ spec:
severity: warning
- alert: KubeContainerWaiting
annotations:
- description: pod/{{ $labels.pod }} in namespace {{ $labels.namespace }} on
- container {{ $labels.container}} has been in waiting state for longer than
- 1 hour.
+ description: pod/{{ $labels.pod }} in namespace {{ $labels.namespace }} on container {{ $labels.container}} has been in waiting state for longer than 1 hour.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubecontainerwaiting
summary: Pod container waiting longer than 1 hour
expr: |
@@ -180,8 +168,7 @@ spec:
severity: warning
- alert: KubeDaemonSetNotScheduled
annotations:
- description: '{{ $value }} Pods of DaemonSet {{ $labels.namespace }}/{{ $labels.daemonset
- }} are not scheduled.'
+ description: '{{ $value }} Pods of DaemonSet {{ $labels.namespace }}/{{ $labels.daemonset }} are not scheduled.'
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubedaemonsetnotscheduled
summary: DaemonSet pods are not scheduled.
expr: |
@@ -193,8 +180,7 @@ spec:
severity: warning
- alert: KubeDaemonSetMisScheduled
annotations:
- description: '{{ $value }} Pods of DaemonSet {{ $labels.namespace }}/{{ $labels.daemonset
- }} are running where they are not supposed to run.'
+ description: '{{ $value }} Pods of DaemonSet {{ $labels.namespace }}/{{ $labels.daemonset }} are running where they are not supposed to run.'
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubedaemonsetmisscheduled
summary: DaemonSet pods are misscheduled.
expr: |
@@ -204,8 +190,7 @@ spec:
severity: warning
- alert: KubeJobNotCompleted
annotations:
- description: Job {{ $labels.namespace }}/{{ $labels.job_name }} is taking
- more than {{ "43200" | humanizeDuration }} to complete.
+ description: Job {{ $labels.namespace }}/{{ $labels.job_name }} is taking more than {{ "43200" | humanizeDuration }} to complete.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubejobnotcompleted
summary: Job did not complete in time
expr: |
@@ -216,8 +201,7 @@ spec:
severity: warning
- alert: KubeJobFailed
annotations:
- description: Job {{ $labels.namespace }}/{{ $labels.job_name }} failed to
- complete. Removing failed job after investigation should clear this alert.
+ description: Job {{ $labels.namespace }}/{{ $labels.job_name }} failed to complete. Removing failed job after investigation should clear this alert.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubejobfailed
summary: Job failed to complete.
expr: |
@@ -227,8 +211,7 @@ spec:
severity: warning
- alert: KubeHpaReplicasMismatch
annotations:
- description: HPA {{ $labels.namespace }}/{{ $labels.horizontalpodautoscaler }}
- has not matched the desired number of replicas for longer than 15 minutes.
+ description: HPA {{ $labels.namespace }}/{{ $labels.horizontalpodautoscaler }} has not matched the desired number of replicas for longer than 15 minutes.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubehpareplicasmismatch
summary: HPA has not matched desired number of replicas.
expr: |
@@ -250,8 +233,7 @@ spec:
severity: warning
- alert: KubeHpaMaxedOut
annotations:
- description: HPA {{ $labels.namespace }}/{{ $labels.horizontalpodautoscaler }}
- has been running at max replicas for longer than 15 minutes.
+ description: HPA {{ $labels.namespace }}/{{ $labels.horizontalpodautoscaler }} has been running at max replicas for longer than 15 minutes.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubehpamaxedout
summary: HPA is running at max replicas
expr: |
@@ -265,8 +247,7 @@ spec:
rules:
- alert: KubeCPUOvercommit
annotations:
- description: Cluster has overcommitted CPU resource requests for Pods by {{
- $value }} CPU shares and cannot tolerate node failure.
+ description: Cluster has overcommitted CPU resource requests for Pods by {{ $value }} CPU shares and cannot tolerate node failure.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubecpuovercommit
summary: Cluster has overcommitted CPU resource requests.
expr: |
@@ -278,8 +259,7 @@ spec:
severity: warning
- alert: KubeMemoryOvercommit
annotations:
- description: Cluster has overcommitted memory resource requests for Pods by
- {{ $value | humanize }} bytes and cannot tolerate node failure.
+ description: Cluster has overcommitted memory resource requests for Pods by {{ $value | humanize }} bytes and cannot tolerate node failure.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubememoryovercommit
summary: Cluster has overcommitted memory resource requests.
expr: |
@@ -317,8 +297,7 @@ spec:
severity: warning
- alert: KubeQuotaAlmostFull
annotations:
- description: Namespace {{ $labels.namespace }} is using {{ $value | humanizePercentage
- }} of its {{ $labels.resource }} quota.
+ description: Namespace {{ $labels.namespace }} is using {{ $value | humanizePercentage }} of its {{ $labels.resource }} quota.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubequotaalmostfull
summary: Namespace quota is going to be full.
expr: |
@@ -331,8 +310,7 @@ spec:
severity: info
- alert: KubeQuotaFullyUsed
annotations:
- description: Namespace {{ $labels.namespace }} is using {{ $value | humanizePercentage
- }} of its {{ $labels.resource }} quota.
+ description: Namespace {{ $labels.namespace }} is using {{ $value | humanizePercentage }} of its {{ $labels.resource }} quota.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubequotafullyused
summary: Namespace quota is fully used.
expr: |
@@ -345,8 +323,7 @@ spec:
severity: info
- alert: KubeQuotaExceeded
annotations:
- description: Namespace {{ $labels.namespace }} is using {{ $value | humanizePercentage
- }} of its {{ $labels.resource }} quota.
+ description: Namespace {{ $labels.namespace }} is using {{ $value | humanizePercentage }} of its {{ $labels.resource }} quota.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubequotaexceeded
summary: Namespace quota has exceeded the limits.
expr: |
@@ -359,9 +336,7 @@ spec:
severity: warning
- alert: CPUThrottlingHigh
annotations:
- description: '{{ $value | humanizePercentage }} throttling of CPU in namespace
- {{ $labels.namespace }} for container {{ $labels.container }} in pod {{
- $labels.pod }}.'
+ description: '{{ $value | humanizePercentage }} throttling of CPU in namespace {{ $labels.namespace }} for container {{ $labels.container }} in pod {{ $labels.pod }}.'
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/cputhrottlinghigh
summary: Processes experience elevated CPU throttling.
expr: |
@@ -376,9 +351,7 @@ spec:
rules:
- alert: KubePersistentVolumeFillingUp
annotations:
- description: The PersistentVolume claimed by {{ $labels.persistentvolumeclaim
- }} in Namespace {{ $labels.namespace }} is only {{ $value | humanizePercentage
- }} free.
+ description: The PersistentVolume claimed by {{ $labels.persistentvolumeclaim }} in Namespace {{ $labels.namespace }} is only {{ $value | humanizePercentage }} free.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubepersistentvolumefillingup
summary: PersistentVolume is filling up.
expr: |
@@ -398,10 +371,7 @@ spec:
severity: critical
- alert: KubePersistentVolumeFillingUp
annotations:
- description: Based on recent sampling, the PersistentVolume claimed by {{
- $labels.persistentvolumeclaim }} in Namespace {{ $labels.namespace }} is
- expected to fill up within four days. Currently {{ $value | humanizePercentage
- }} is available.
+ description: Based on recent sampling, the PersistentVolume claimed by {{ $labels.persistentvolumeclaim }} in Namespace {{ $labels.namespace }} is expected to fill up within four days. Currently {{ $value | humanizePercentage }} is available.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubepersistentvolumefillingup
summary: PersistentVolume is filling up.
expr: |
@@ -423,9 +393,7 @@ spec:
severity: warning
- alert: KubePersistentVolumeInodesFillingUp
annotations:
- description: The PersistentVolume claimed by {{ $labels.persistentvolumeclaim
- }} in Namespace {{ $labels.namespace }} only has {{ $value | humanizePercentage
- }} free inodes.
+ description: The PersistentVolume claimed by {{ $labels.persistentvolumeclaim }} in Namespace {{ $labels.namespace }} only has {{ $value | humanizePercentage }} free inodes.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubepersistentvolumeinodesfillingup
summary: PersistentVolumeInodes are filling up.
expr: |
@@ -445,10 +413,7 @@ spec:
severity: critical
- alert: KubePersistentVolumeInodesFillingUp
annotations:
- description: Based on recent sampling, the PersistentVolume claimed by {{
- $labels.persistentvolumeclaim }} in Namespace {{ $labels.namespace }} is
- expected to run out of inodes within four days. Currently {{ $value | humanizePercentage
- }} of its inodes are free.
+ description: Based on recent sampling, the PersistentVolume claimed by {{ $labels.persistentvolumeclaim }} in Namespace {{ $labels.namespace }} is expected to run out of inodes within four days. Currently {{ $value | humanizePercentage }} of its inodes are free.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubepersistentvolumeinodesfillingup
summary: PersistentVolumeInodes are filling up.
expr: |
@@ -470,8 +435,7 @@ spec:
severity: warning
- alert: KubePersistentVolumeErrors
annotations:
- description: The persistent volume {{ $labels.persistentvolume }} has status
- {{ $labels.phase }}.
+ description: The persistent volume {{ $labels.persistentvolume }} has status {{ $labels.phase }}.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubepersistentvolumeerrors
summary: PersistentVolume is having issues with provisioning.
expr: |
@@ -483,8 +447,7 @@ spec:
rules:
- alert: KubeVersionMismatch
annotations:
- description: There are {{ $value }} different semantic versions of Kubernetes
- components running.
+ description: There are {{ $value }} different semantic versions of Kubernetes components running.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubeversionmismatch
summary: Different semantic versions of Kubernetes components running.
expr: |
@@ -494,8 +457,7 @@ spec:
severity: warning
- alert: KubeClientErrors
annotations:
- description: Kubernetes API server client '{{ $labels.job }}/{{ $labels.instance
- }}' is experiencing {{ $value | humanizePercentage }} errors.'
+ description: Kubernetes API server client '{{ $labels.job }}/{{ $labels.instance }}' is experiencing {{ $value | humanizePercentage }} errors.'
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubeclienterrors
summary: Kubernetes API server client is experiencing errors.
expr: |
@@ -568,8 +530,7 @@ spec:
rules:
- alert: KubeClientCertificateExpiration
annotations:
- description: A client certificate used to authenticate to kubernetes apiserver
- is expiring in less than 7.0 days.
+ description: A client certificate used to authenticate to kubernetes apiserver is expiring in less than 7.0 days.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubeclientcertificateexpiration
summary: Client certificate is about to expire.
expr: |
@@ -579,8 +540,7 @@ spec:
severity: warning
- alert: KubeClientCertificateExpiration
annotations:
- description: A client certificate used to authenticate to kubernetes apiserver
- is expiring in less than 24.0 hours.
+ description: A client certificate used to authenticate to kubernetes apiserver is expiring in less than 24.0 hours.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubeclientcertificateexpiration
summary: Client certificate is about to expire.
expr: |
@@ -590,9 +550,7 @@ spec:
severity: critical
- alert: KubeAggregatedAPIErrors
annotations:
- description: Kubernetes aggregated API {{ $labels.name }}/{{ $labels.namespace
- }} has reported errors. It has appeared unavailable {{ $value | humanize
- }} times averaged over the past 10m.
+ description: Kubernetes aggregated API {{ $labels.name }}/{{ $labels.namespace }} has reported errors. It has appeared unavailable {{ $value | humanize }} times averaged over the past 10m.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubeaggregatedapierrors
summary: Kubernetes aggregated API has reported errors.
expr: |
@@ -601,8 +559,7 @@ spec:
severity: warning
- alert: KubeAggregatedAPIDown
annotations:
- description: Kubernetes aggregated API {{ $labels.name }}/{{ $labels.namespace
- }} has been only {{ $value | humanize }}% available over the last 10m.
+ description: Kubernetes aggregated API {{ $labels.name }}/{{ $labels.namespace }} has been only {{ $value | humanize }}% available over the last 10m.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubeaggregatedapidown
summary: Kubernetes aggregated API is down.
expr: |
@@ -622,11 +579,9 @@ spec:
severity: critical
- alert: KubeAPITerminatedRequests
annotations:
- description: The kubernetes apiserver has terminated {{ $value | humanizePercentage
- }} of its incoming requests.
+ description: The kubernetes apiserver has terminated {{ $value | humanizePercentage }} of its incoming requests.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubeapiterminatedrequests
- summary: The kubernetes apiserver has terminated {{ $value | humanizePercentage
- }} of its incoming requests.
+ summary: The kubernetes apiserver has terminated {{ $value | humanizePercentage }} of its incoming requests.
expr: |
sum(rate(apiserver_request_terminations_total{job="apiserver"}[10m])) / ( sum(rate(apiserver_request_total{job="apiserver"}[10m])) + sum(rate(apiserver_request_terminations_total{job="apiserver"}[10m])) ) > 0.20
for: 5m
@@ -646,8 +601,7 @@ spec:
severity: warning
- alert: KubeNodeUnreachable
annotations:
- description: '{{ $labels.node }} is unreachable and some workloads may be
- rescheduled.'
+ description: '{{ $labels.node }} is unreachable and some workloads may be rescheduled.'
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubenodeunreachable
summary: Node is unreachable.
expr: |
@@ -657,8 +611,7 @@ spec:
severity: warning
- alert: KubeletTooManyPods
annotations:
- description: Kubelet '{{ $labels.node }}' is running at {{ $value | humanizePercentage
- }} of its Pod capacity.
+ description: Kubelet '{{ $labels.node }}' is running at {{ $value | humanizePercentage }} of its Pod capacity.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubelettoomanypods
summary: Kubelet is running at capacity.
expr: |
@@ -674,8 +627,7 @@ spec:
severity: info
- alert: KubeNodeReadinessFlapping
annotations:
- description: The readiness status of node {{ $labels.node }} has changed {{
- $value }} times in the last 15 minutes.
+ description: The readiness status of node {{ $labels.node }} has changed {{ $value }} times in the last 15 minutes.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubenodereadinessflapping
summary: Node readiness status is flapping.
expr: |
@@ -685,8 +637,7 @@ spec:
severity: warning
- alert: KubeletPlegDurationHigh
annotations:
- description: The Kubelet Pod Lifecycle Event Generator has a 99th percentile
- duration of {{ $value }} seconds on node {{ $labels.node }}.
+ description: The Kubelet Pod Lifecycle Event Generator has a 99th percentile duration of {{ $value }} seconds on node {{ $labels.node }}.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubeletplegdurationhigh
summary: Kubelet Pod Lifecycle Event Generator is taking too long to relist.
expr: |
@@ -696,8 +647,7 @@ spec:
severity: warning
- alert: KubeletPodStartUpLatencyHigh
annotations:
- description: Kubelet Pod startup 99th percentile latency is {{ $value }} seconds
- on node {{ $labels.node }}.
+ description: Kubelet Pod startup 99th percentile latency is {{ $value }} seconds on node {{ $labels.node }}.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubeletpodstartuplatencyhigh
summary: Kubelet Pod startup latency is too high.
expr: |
@@ -707,8 +657,7 @@ spec:
severity: warning
- alert: KubeletClientCertificateExpiration
annotations:
- description: Client certificate for Kubelet on node {{ $labels.node }} expires
- in {{ $value | humanizeDuration }}.
+ description: Client certificate for Kubelet on node {{ $labels.node }} expires in {{ $value | humanizeDuration }}.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubeletclientcertificateexpiration
summary: Kubelet client certificate is about to expire.
expr: |
@@ -717,8 +666,7 @@ spec:
severity: warning
- alert: KubeletClientCertificateExpiration
annotations:
- description: Client certificate for Kubelet on node {{ $labels.node }} expires
- in {{ $value | humanizeDuration }}.
+ description: Client certificate for Kubelet on node {{ $labels.node }} expires in {{ $value | humanizeDuration }}.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubeletclientcertificateexpiration
summary: Kubelet client certificate is about to expire.
expr: |
@@ -727,8 +675,7 @@ spec:
severity: critical
- alert: KubeletServerCertificateExpiration
annotations:
- description: Server certificate for Kubelet on node {{ $labels.node }} expires
- in {{ $value | humanizeDuration }}.
+ description: Server certificate for Kubelet on node {{ $labels.node }} expires in {{ $value | humanizeDuration }}.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubeletservercertificateexpiration
summary: Kubelet server certificate is about to expire.
expr: |
@@ -737,8 +684,7 @@ spec:
severity: warning
- alert: KubeletServerCertificateExpiration
annotations:
- description: Server certificate for Kubelet on node {{ $labels.node }} expires
- in {{ $value | humanizeDuration }}.
+ description: Server certificate for Kubelet on node {{ $labels.node }} expires in {{ $value | humanizeDuration }}.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubeletservercertificateexpiration
summary: Kubelet server certificate is about to expire.
expr: |
@@ -747,8 +693,7 @@ spec:
severity: critical
- alert: KubeletClientCertificateRenewalErrors
annotations:
- description: Kubelet on node {{ $labels.node }} has failed to renew its client
- certificate ({{ $value | humanize }} errors in the last 5 minutes).
+ description: Kubelet on node {{ $labels.node }} has failed to renew its client certificate ({{ $value | humanize }} errors in the last 5 minutes).
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubeletclientcertificaterenewalerrors
summary: Kubelet has failed to renew its client certificate.
expr: |
@@ -758,8 +703,7 @@ spec:
severity: warning
- alert: KubeletServerCertificateRenewalErrors
annotations:
- description: Kubelet on node {{ $labels.node }} has failed to renew its server
- certificate ({{ $value | humanize }} errors in the last 5 minutes).
+ description: Kubelet on node {{ $labels.node }} has failed to renew its server certificate ({{ $value | humanize }} errors in the last 5 minutes).
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubeletservercertificaterenewalerrors
summary: Kubelet has failed to renew its server certificate.
expr: |
@@ -793,8 +737,7 @@ spec:
rules:
- alert: KubeControllerManagerDown
annotations:
- description: KubeControllerManager has disappeared from Prometheus target
- discovery.
+ description: KubeControllerManager has disappeared from Prometheus target discovery.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/kubernetes/kubecontrollermanagerdown
summary: Target disappeared from Prometheus target discovery.
expr: |
diff --git a/manifests/nodeExporter-prometheusRule.yaml b/manifests/nodeExporter-prometheusRule.yaml
index 38ed81ab004f61cc16235f2ca06fefd860da49f0..5e5e52c15f4d87e086b60f6383e86e68ae6eb846 100644
--- a/manifests/nodeExporter-prometheusRule.yaml
+++ b/manifests/nodeExporter-prometheusRule.yaml
@@ -16,9 +16,7 @@ spec:
rules:
- alert: NodeFilesystemSpaceFillingUp
annotations:
- description: Filesystem on {{ $labels.device }} at {{ $labels.instance }}
- has only {{ printf "%.2f" $value }}% available space left and is filling
- up.
+ description: Filesystem on {{ $labels.device }} at {{ $labels.instance }} has only {{ printf "%.2f" $value }}% available space left and is filling up.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/node/nodefilesystemspacefillingup
summary: Filesystem is predicted to run out of space within the next 24 hours.
expr: |
@@ -34,9 +32,7 @@ spec:
severity: warning
- alert: NodeFilesystemSpaceFillingUp
annotations:
- description: Filesystem on {{ $labels.device }} at {{ $labels.instance }}
- has only {{ printf "%.2f" $value }}% available space left and is filling
- up fast.
+ description: Filesystem on {{ $labels.device }} at {{ $labels.instance }} has only {{ printf "%.2f" $value }}% available space left and is filling up fast.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/node/nodefilesystemspacefillingup
summary: Filesystem is predicted to run out of space within the next 4 hours.
expr: |
@@ -52,8 +48,7 @@ spec:
severity: critical
- alert: NodeFilesystemAlmostOutOfSpace
annotations:
- description: Filesystem on {{ $labels.device }} at {{ $labels.instance }}
- has only {{ printf "%.2f" $value }}% available space left.
+ description: Filesystem on {{ $labels.device }} at {{ $labels.instance }} has only {{ printf "%.2f" $value }}% available space left.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/node/nodefilesystemalmostoutofspace
summary: Filesystem has less than 5% space left.
expr: |
@@ -67,8 +62,7 @@ spec:
severity: warning
- alert: NodeFilesystemAlmostOutOfSpace
annotations:
- description: Filesystem on {{ $labels.device }} at {{ $labels.instance }}
- has only {{ printf "%.2f" $value }}% available space left.
+ description: Filesystem on {{ $labels.device }} at {{ $labels.instance }} has only {{ printf "%.2f" $value }}% available space left.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/node/nodefilesystemalmostoutofspace
summary: Filesystem has less than 3% space left.
expr: |
@@ -82,9 +76,7 @@ spec:
severity: critical
- alert: NodeFilesystemFilesFillingUp
annotations:
- description: Filesystem on {{ $labels.device }} at {{ $labels.instance }}
- has only {{ printf "%.2f" $value }}% available inodes left and is filling
- up.
+ description: Filesystem on {{ $labels.device }} at {{ $labels.instance }} has only {{ printf "%.2f" $value }}% available inodes left and is filling up.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/node/nodefilesystemfilesfillingup
summary: Filesystem is predicted to run out of inodes within the next 24 hours.
expr: |
@@ -100,9 +92,7 @@ spec:
severity: warning
- alert: NodeFilesystemFilesFillingUp
annotations:
- description: Filesystem on {{ $labels.device }} at {{ $labels.instance }}
- has only {{ printf "%.2f" $value }}% available inodes left and is filling
- up fast.
+ description: Filesystem on {{ $labels.device }} at {{ $labels.instance }} has only {{ printf "%.2f" $value }}% available inodes left and is filling up fast.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/node/nodefilesystemfilesfillingup
summary: Filesystem is predicted to run out of inodes within the next 4 hours.
expr: |
@@ -118,8 +108,7 @@ spec:
severity: critical
- alert: NodeFilesystemAlmostOutOfFiles
annotations:
- description: Filesystem on {{ $labels.device }} at {{ $labels.instance }}
- has only {{ printf "%.2f" $value }}% available inodes left.
+ description: Filesystem on {{ $labels.device }} at {{ $labels.instance }} has only {{ printf "%.2f" $value }}% available inodes left.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/node/nodefilesystemalmostoutoffiles
summary: Filesystem has less than 5% inodes left.
expr: |
@@ -133,8 +122,7 @@ spec:
severity: warning
- alert: NodeFilesystemAlmostOutOfFiles
annotations:
- description: Filesystem on {{ $labels.device }} at {{ $labels.instance }}
- has only {{ printf "%.2f" $value }}% available inodes left.
+ description: Filesystem on {{ $labels.device }} at {{ $labels.instance }} has only {{ printf "%.2f" $value }}% available inodes left.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/node/nodefilesystemalmostoutoffiles
summary: Filesystem has less than 3% inodes left.
expr: |
@@ -148,8 +136,7 @@ spec:
severity: critical
- alert: NodeNetworkReceiveErrs
annotations:
- description: '{{ $labels.instance }} interface {{ $labels.device }} has encountered
- {{ printf "%.0f" $value }} receive errors in the last two minutes.'
+ description: '{{ $labels.instance }} interface {{ $labels.device }} has encountered {{ printf "%.0f" $value }} receive errors in the last two minutes.'
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/node/nodenetworkreceiveerrs
summary: Network interface is reporting many receive errors.
expr: |
@@ -159,8 +146,7 @@ spec:
severity: warning
- alert: NodeNetworkTransmitErrs
annotations:
- description: '{{ $labels.instance }} interface {{ $labels.device }} has encountered
- {{ printf "%.0f" $value }} transmit errors in the last two minutes.'
+ description: '{{ $labels.instance }} interface {{ $labels.device }} has encountered {{ printf "%.0f" $value }} transmit errors in the last two minutes.'
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/node/nodenetworktransmiterrs
summary: Network interface is reporting many transmit errors.
expr: |
@@ -188,8 +174,7 @@ spec:
severity: warning
- alert: NodeClockSkewDetected
annotations:
- description: Clock on {{ $labels.instance }} is out of sync by more than 300s.
- Ensure NTP is configured correctly on this host.
+ description: Clock on {{ $labels.instance }} is out of sync by more than 300s. Ensure NTP is configured correctly on this host.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/node/nodeclockskewdetected
summary: Clock skew detected.
expr: |
@@ -209,8 +194,7 @@ spec:
severity: warning
- alert: NodeClockNotSynchronising
annotations:
- description: Clock on {{ $labels.instance }} is not synchronising. Ensure
- NTP is configured on this host.
+ description: Clock on {{ $labels.instance }} is not synchronising. Ensure NTP is configured on this host.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/node/nodeclocknotsynchronising
summary: Clock not synchronising.
expr: |
@@ -222,9 +206,7 @@ spec:
severity: warning
- alert: NodeRAIDDegraded
annotations:
- description: RAID array '{{ $labels.device }}' on {{ $labels.instance }} is
- in degraded state due to one or more disks failures. Number of spare drives
- is insufficient to fix issue automatically.
+ description: RAID array '{{ $labels.device }}' on {{ $labels.instance }} is in degraded state due to one or more disks failures. Number of spare drives is insufficient to fix issue automatically.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/node/noderaiddegraded
summary: RAID Array is degraded
expr: |
@@ -234,8 +216,7 @@ spec:
severity: critical
- alert: NodeRAIDDiskFailure
annotations:
- description: At least one device in RAID array on {{ $labels.instance }} failed.
- Array '{{ $labels.device }}' needs attention and possibly a disk swap.
+ description: At least one device in RAID array on {{ $labels.instance }} failed. Array '{{ $labels.device }}' needs attention and possibly a disk swap.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/node/noderaiddiskfailure
summary: Failed device in RAID array
expr: |
@@ -244,8 +225,7 @@ spec:
severity: warning
- alert: NodeFileDescriptorLimit
annotations:
- description: File descriptors limit at {{ $labels.instance }} is currently
- at {{ printf "%.2f" $value }}%.
+ description: File descriptors limit at {{ $labels.instance }} is currently at {{ printf "%.2f" $value }}%.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/node/nodefiledescriptorlimit
summary: Kernel is predicted to exhaust file descriptors limit soon.
expr: |
@@ -257,8 +237,7 @@ spec:
severity: warning
- alert: NodeFileDescriptorLimit
annotations:
- description: File descriptors limit at {{ $labels.instance }} is currently
- at {{ printf "%.2f" $value }}%.
+ description: File descriptors limit at {{ $labels.instance }} is currently at {{ printf "%.2f" $value }}%.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/node/nodefiledescriptorlimit
summary: Kernel is predicted to exhaust file descriptors limit soon.
expr: |
diff --git a/manifests/prometheus-prometheusRule.yaml b/manifests/prometheus-prometheusRule.yaml
index 4789c3708ce5dbfd02478e389b8a447c3804cf18..9459a3f223f706b0f6eacd1701c5b3ac627989f9 100644
--- a/manifests/prometheus-prometheusRule.yaml
+++ b/manifests/prometheus-prometheusRule.yaml
@@ -17,8 +17,7 @@ spec:
rules:
- alert: PrometheusBadConfig
annotations:
- description: Prometheus {{$labels.namespace}}/{{$labels.pod}} has failed to
- reload its configuration.
+ description: Prometheus {{$labels.namespace}}/{{$labels.pod}} has failed to reload its configuration.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/prometheus/prometheusbadconfig
summary: Failed Prometheus configuration reload.
expr: |
@@ -30,11 +29,9 @@ spec:
severity: critical
- alert: PrometheusNotificationQueueRunningFull
annotations:
- description: Alert notification queue of Prometheus {{$labels.namespace}}/{{$labels.pod}}
- is running full.
+ description: Alert notification queue of Prometheus {{$labels.namespace}}/{{$labels.pod}} is running full.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/prometheus/prometheusnotificationqueuerunningfull
- summary: Prometheus alert notification queue predicted to run full in less
- than 30m.
+ summary: Prometheus alert notification queue predicted to run full in less than 30m.
expr: |
# Without min_over_time, failed scrapes could create false negatives, see
# https://www.robustperception.io/alerting-on-gauges-in-prometheus-2-0 for details.
@@ -48,11 +45,9 @@ spec:
severity: warning
- alert: PrometheusErrorSendingAlertsToSomeAlertmanagers
annotations:
- description: '{{ printf "%.1f" $value }}% errors while sending alerts from
- Prometheus {{$labels.namespace}}/{{$labels.pod}} to Alertmanager {{$labels.alertmanager}}.'
+ description: '{{ printf "%.1f" $value }}% errors while sending alerts from Prometheus {{$labels.namespace}}/{{$labels.pod}} to Alertmanager {{$labels.alertmanager}}.'
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/prometheus/prometheuserrorsendingalertstosomealertmanagers
- summary: Prometheus has encountered more than 1% errors sending alerts to
- a specific Alertmanager.
+ summary: Prometheus has encountered more than 1% errors sending alerts to a specific Alertmanager.
expr: |
(
rate(prometheus_notifications_errors_total{job="prometheus-k8s",namespace="monitoring"}[5m])
@@ -66,8 +61,7 @@ spec:
severity: warning
- alert: PrometheusNotConnectedToAlertmanagers
annotations:
- description: Prometheus {{$labels.namespace}}/{{$labels.pod}} is not connected
- to any Alertmanagers.
+ description: Prometheus {{$labels.namespace}}/{{$labels.pod}} is not connected to any Alertmanagers.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/prometheus/prometheusnotconnectedtoalertmanagers
summary: Prometheus is not connected to any Alertmanagers.
expr: |
@@ -79,8 +73,7 @@ spec:
severity: warning
- alert: PrometheusTSDBReloadsFailing
annotations:
- description: Prometheus {{$labels.namespace}}/{{$labels.pod}} has detected
- {{$value | humanize}} reload failures over the last 3h.
+ description: Prometheus {{$labels.namespace}}/{{$labels.pod}} has detected {{$value | humanize}} reload failures over the last 3h.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/prometheus/prometheustsdbreloadsfailing
summary: Prometheus has issues reloading blocks from disk.
expr: |
@@ -90,8 +83,7 @@ spec:
severity: warning
- alert: PrometheusTSDBCompactionsFailing
annotations:
- description: Prometheus {{$labels.namespace}}/{{$labels.pod}} has detected
- {{$value | humanize}} compaction failures over the last 3h.
+ description: Prometheus {{$labels.namespace}}/{{$labels.pod}} has detected {{$value | humanize}} compaction failures over the last 3h.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/prometheus/prometheustsdbcompactionsfailing
summary: Prometheus has issues compacting blocks.
expr: |
@@ -101,8 +93,7 @@ spec:
severity: warning
- alert: PrometheusNotIngestingSamples
annotations:
- description: Prometheus {{$labels.namespace}}/{{$labels.pod}} is not ingesting
- samples.
+ description: Prometheus {{$labels.namespace}}/{{$labels.pod}} is not ingesting samples.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/prometheus/prometheusnotingestingsamples
summary: Prometheus is not ingesting samples.
expr: |
@@ -120,9 +111,7 @@ spec:
severity: warning
- alert: PrometheusDuplicateTimestamps
annotations:
- description: Prometheus {{$labels.namespace}}/{{$labels.pod}} is dropping
- {{ printf "%.4g" $value }} samples/s with different values but duplicated
- timestamp.
+ description: Prometheus {{$labels.namespace}}/{{$labels.pod}} is dropping {{ printf "%.4g" $value }} samples/s with different values but duplicated timestamp.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/prometheus/prometheusduplicatetimestamps
summary: Prometheus is dropping samples with duplicate timestamps.
expr: |
@@ -132,8 +121,7 @@ spec:
severity: warning
- alert: PrometheusOutOfOrderTimestamps
annotations:
- description: Prometheus {{$labels.namespace}}/{{$labels.pod}} is dropping
- {{ printf "%.4g" $value }} samples/s with timestamps arriving out of order.
+ description: Prometheus {{$labels.namespace}}/{{$labels.pod}} is dropping {{ printf "%.4g" $value }} samples/s with timestamps arriving out of order.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/prometheus/prometheusoutofordertimestamps
summary: Prometheus drops samples with out-of-order timestamps.
expr: |
@@ -143,9 +131,7 @@ spec:
severity: warning
- alert: PrometheusRemoteStorageFailures
annotations:
- description: Prometheus {{$labels.namespace}}/{{$labels.pod}} failed to send
- {{ printf "%.1f" $value }}% of the samples to {{ $labels.remote_name}}:{{
- $labels.url }}
+ description: Prometheus {{$labels.namespace}}/{{$labels.pod}} failed to send {{ printf "%.1f" $value }}% of the samples to {{ $labels.remote_name}}:{{ $labels.url }}
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/prometheus/prometheusremotestoragefailures
summary: Prometheus fails to send samples to remote storage.
expr: |
@@ -165,9 +151,7 @@ spec:
severity: critical
- alert: PrometheusRemoteWriteBehind
annotations:
- description: Prometheus {{$labels.namespace}}/{{$labels.pod}} remote write
- is {{ printf "%.1f" $value }}s behind for {{ $labels.remote_name}}:{{ $labels.url
- }}.
+ description: Prometheus {{$labels.namespace}}/{{$labels.pod}} remote write is {{ printf "%.1f" $value }}s behind for {{ $labels.remote_name}}:{{ $labels.url }}.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/prometheus/prometheusremotewritebehind
summary: Prometheus remote write is behind.
expr: |
@@ -184,14 +168,9 @@ spec:
severity: critical
- alert: PrometheusRemoteWriteDesiredShards
annotations:
- description: Prometheus {{$labels.namespace}}/{{$labels.pod}} remote write
- desired shards calculation wants to run {{ $value }} shards for queue {{
- $labels.remote_name}}:{{ $labels.url }}, which is more than the max of {{
- printf `prometheus_remote_storage_shards_max{instance="%s",job="prometheus-k8s",namespace="monitoring"}`
- $labels.instance | query | first | value }}.
+ description: Prometheus {{$labels.namespace}}/{{$labels.pod}} remote write desired shards calculation wants to run {{ $value }} shards for queue {{ $labels.remote_name}}:{{ $labels.url }}, which is more than the max of {{ printf `prometheus_remote_storage_shards_max{instance="%s",job="prometheus-k8s",namespace="monitoring"}` $labels.instance | query | first | value }}.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/prometheus/prometheusremotewritedesiredshards
- summary: Prometheus remote write desired shards calculation wants to run more
- than configured max shards.
+ summary: Prometheus remote write desired shards calculation wants to run more than configured max shards.
expr: |
# Without max_over_time, failed scrapes could create false negatives, see
# https://www.robustperception.io/alerting-on-gauges-in-prometheus-2-0 for details.
@@ -205,8 +184,7 @@ spec:
severity: warning
- alert: PrometheusRuleFailures
annotations:
- description: Prometheus {{$labels.namespace}}/{{$labels.pod}} has failed to
- evaluate {{ printf "%.0f" $value }} rules in the last 5m.
+ description: Prometheus {{$labels.namespace}}/{{$labels.pod}} has failed to evaluate {{ printf "%.0f" $value }} rules in the last 5m.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/prometheus/prometheusrulefailures
summary: Prometheus is failing rule evaluations.
expr: |
@@ -216,8 +194,7 @@ spec:
severity: critical
- alert: PrometheusMissingRuleEvaluations
annotations:
- description: Prometheus {{$labels.namespace}}/{{$labels.pod}} has missed {{
- printf "%.0f" $value }} rule group evaluations in the last 5m.
+ description: Prometheus {{$labels.namespace}}/{{$labels.pod}} has missed {{ printf "%.0f" $value }} rule group evaluations in the last 5m.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/prometheus/prometheusmissingruleevaluations
summary: Prometheus is missing rule evaluations due to slow rule group evaluation.
expr: |
@@ -227,12 +204,9 @@ spec:
severity: warning
- alert: PrometheusTargetLimitHit
annotations:
- description: Prometheus {{$labels.namespace}}/{{$labels.pod}} has dropped
- {{ printf "%.0f" $value }} targets because the number of targets exceeded
- the configured target_limit.
+ description: Prometheus {{$labels.namespace}}/{{$labels.pod}} has dropped {{ printf "%.0f" $value }} targets because the number of targets exceeded the configured target_limit.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/prometheus/prometheustargetlimithit
- summary: Prometheus has dropped targets because some scrape configs have exceeded
- the targets limit.
+ summary: Prometheus has dropped targets because some scrape configs have exceeded the targets limit.
expr: |
increase(prometheus_target_scrape_pool_exceeded_target_limit_total{job="prometheus-k8s",namespace="monitoring"}[5m]) > 0
for: 15m
@@ -240,12 +214,9 @@ spec:
severity: warning
- alert: PrometheusLabelLimitHit
annotations:
- description: Prometheus {{$labels.namespace}}/{{$labels.pod}} has dropped
- {{ printf "%.0f" $value }} targets because some samples exceeded the configured
- label_limit, label_name_length_limit or label_value_length_limit.
+ description: Prometheus {{$labels.namespace}}/{{$labels.pod}} has dropped {{ printf "%.0f" $value }} targets because some samples exceeded the configured label_limit, label_name_length_limit or label_value_length_limit.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/prometheus/prometheuslabellimithit
- summary: Prometheus has dropped targets because some scrape configs have exceeded
- the labels limit.
+ summary: Prometheus has dropped targets because some scrape configs have exceeded the labels limit.
expr: |
increase(prometheus_target_scrape_pool_exceeded_label_limits_total{job="prometheus-k8s",namespace="monitoring"}[5m]) > 0
for: 15m
@@ -253,9 +224,7 @@ spec:
severity: warning
- alert: PrometheusScrapeBodySizeLimitHit
annotations:
- description: Prometheus {{$labels.namespace}}/{{$labels.pod}} has failed {{
- printf "%.0f" $value }} scrapes in the last 5m because some targets exceeded
- the configured body_size_limit.
+ description: Prometheus {{$labels.namespace}}/{{$labels.pod}} has failed {{ printf "%.0f" $value }} scrapes in the last 5m because some targets exceeded the configured body_size_limit.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/prometheus/prometheusscrapebodysizelimithit
summary: Prometheus has dropped some targets that exceeded body size limit.
expr: |
@@ -265,12 +234,9 @@ spec:
severity: warning
- alert: PrometheusScrapeSampleLimitHit
annotations:
- description: Prometheus {{$labels.namespace}}/{{$labels.pod}} has failed {{
- printf "%.0f" $value }} scrapes in the last 5m because some targets exceeded
- the configured sample_limit.
+ description: Prometheus {{$labels.namespace}}/{{$labels.pod}} has failed {{ printf "%.0f" $value }} scrapes in the last 5m because some targets exceeded the configured sample_limit.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/prometheus/prometheusscrapesamplelimithit
- summary: Prometheus has failed scrapes that have exceeded the configured sample
- limit.
+ summary: Prometheus has failed scrapes that have exceeded the configured sample limit.
expr: |
increase(prometheus_target_scrapes_exceeded_sample_limit_total{job="prometheus-k8s",namespace="monitoring"}[5m]) > 0
for: 15m
@@ -278,8 +244,7 @@ spec:
severity: warning
- alert: PrometheusTargetSyncFailure
annotations:
- description: '{{ printf "%.0f" $value }} targets in Prometheus {{$labels.namespace}}/{{$labels.pod}}
- have failed to sync because invalid configuration was supplied.'
+ description: '{{ printf "%.0f" $value }} targets in Prometheus {{$labels.namespace}}/{{$labels.pod}} have failed to sync because invalid configuration was supplied.'
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/prometheus/prometheustargetsyncfailure
summary: Prometheus has failed to sync targets.
expr: |
@@ -289,8 +254,7 @@ spec:
severity: critical
- alert: PrometheusHighQueryLoad
annotations:
- description: Prometheus {{$labels.namespace}}/{{$labels.pod}} query API has
- less than 20% available capacity in its query engine for the last 15 minutes.
+ description: Prometheus {{$labels.namespace}}/{{$labels.pod}} query API has less than 20% available capacity in its query engine for the last 15 minutes.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/prometheus/prometheushighqueryload
summary: Prometheus is reaching its maximum capacity serving concurrent requests.
expr: |
@@ -300,8 +264,7 @@ spec:
severity: warning
- alert: PrometheusErrorSendingAlertsToAnyAlertmanager
annotations:
- description: '{{ printf "%.1f" $value }}% minimum errors while sending alerts
- from Prometheus {{$labels.namespace}}/{{$labels.pod}} to any Alertmanager.'
+ description: '{{ printf "%.1f" $value }}% minimum errors while sending alerts from Prometheus {{$labels.namespace}}/{{$labels.pod}} to any Alertmanager.'
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/prometheus/prometheuserrorsendingalertstoanyalertmanager
summary: Prometheus encounters more than 3% errors sending alerts to any Alertmanager.
expr: |
diff --git a/manifests/prometheusOperator-prometheusRule.yaml b/manifests/prometheusOperator-prometheusRule.yaml
index 3770d01829931d7cd673b47569c29649bdd684d4..044f4f880055c10fee1cb5b4c508a539327151af 100644
--- a/manifests/prometheusOperator-prometheusRule.yaml
+++ b/manifests/prometheusOperator-prometheusRule.yaml
@@ -16,8 +16,7 @@ spec:
rules:
- alert: PrometheusOperatorListErrors
annotations:
- description: Errors while performing List operations in controller {{$labels.controller}}
- in {{$labels.namespace}} namespace.
+ description: Errors while performing List operations in controller {{$labels.controller}} in {{$labels.namespace}} namespace.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/prometheus-operator/prometheusoperatorlisterrors
summary: Errors while performing list operations in controller.
expr: |
@@ -27,8 +26,7 @@ spec:
severity: warning
- alert: PrometheusOperatorWatchErrors
annotations:
- description: Errors while performing watch operations in controller {{$labels.controller}}
- in {{$labels.namespace}} namespace.
+ description: Errors while performing watch operations in controller {{$labels.controller}} in {{$labels.namespace}} namespace.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/prometheus-operator/prometheusoperatorwatcherrors
summary: Errors while performing watch operations in controller.
expr: |
@@ -38,8 +36,7 @@ spec:
severity: warning
- alert: PrometheusOperatorSyncFailed
annotations:
- description: Controller {{ $labels.controller }} in {{ $labels.namespace }}
- namespace fails to reconcile {{ $value }} objects.
+ description: Controller {{ $labels.controller }} in {{ $labels.namespace }} namespace fails to reconcile {{ $value }} objects.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/prometheus-operator/prometheusoperatorsyncfailed
summary: Last controller reconciliation failed
expr: |
@@ -49,9 +46,7 @@ spec:
severity: warning
- alert: PrometheusOperatorReconcileErrors
annotations:
- description: '{{ $value | humanizePercentage }} of reconciling operations
- failed for {{ $labels.controller }} controller in {{ $labels.namespace }}
- namespace.'
+ description: '{{ $value | humanizePercentage }} of reconciling operations failed for {{ $labels.controller }} controller in {{ $labels.namespace }} namespace.'
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/prometheus-operator/prometheusoperatorreconcileerrors
summary: Errors while reconciling controller.
expr: |
@@ -61,8 +56,7 @@ spec:
severity: warning
- alert: PrometheusOperatorNodeLookupErrors
annotations:
- description: Errors while reconciling Prometheus in {{ $labels.namespace }}
- Namespace.
+ description: Errors while reconciling Prometheus in {{ $labels.namespace }} Namespace.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/prometheus-operator/prometheusoperatornodelookuperrors
summary: Errors while reconciling Prometheus.
expr: |
@@ -72,8 +66,7 @@ spec:
severity: warning
- alert: PrometheusOperatorNotReady
annotations:
- description: Prometheus operator in {{ $labels.namespace }} namespace isn't
- ready to reconcile {{ $labels.controller }} resources.
+ description: Prometheus operator in {{ $labels.namespace }} namespace isn't ready to reconcile {{ $labels.controller }} resources.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/prometheus-operator/prometheusoperatornotready
summary: Prometheus operator not ready
expr: |
@@ -83,9 +76,7 @@ spec:
severity: warning
- alert: PrometheusOperatorRejectedResources
annotations:
- description: Prometheus operator in {{ $labels.namespace }} namespace rejected
- {{ printf "%0.0f" $value }} {{ $labels.controller }}/{{ $labels.resource
- }} resources.
+ description: Prometheus operator in {{ $labels.namespace }} namespace rejected {{ printf "%0.0f" $value }} {{ $labels.controller }}/{{ $labels.resource }} resources.
runbook_url: https://runbooks.prometheus-operator.dev/runbooks/prometheus-operator/prometheusoperatorrejectedresources
summary: Resources rejected by Prometheus operator
expr: |
diff --git a/manifests/setup/0alertmanagerConfigCustomResourceDefinition.yaml b/manifests/setup/0alertmanagerConfigCustomResourceDefinition.yaml
index 5fb86ebfd7fe1f8e4f73e1ae05f47e80c28e7124..5c8b76db98d5279356448e023bf16c92117f5790 100644
--- a/manifests/setup/0alertmanagerConfigCustomResourceDefinition.yaml
+++ b/manifests/setup/0alertmanagerConfigCustomResourceDefinition.yaml
@@ -21,51 +21,36 @@ spec:
- name: v1alpha1
schema:
openAPIV3Schema:
- description: AlertmanagerConfig defines a namespaced AlertmanagerConfig to
- be aggregated across multiple namespaces configuring one Alertmanager cluster.
+ description: AlertmanagerConfig defines a namespaced AlertmanagerConfig to be aggregated across multiple namespaces configuring one Alertmanager cluster.
properties:
apiVersion:
- description: 'APIVersion defines the versioned schema of this representation
- of an object. Servers should convert recognized schemas to the latest
- internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+ description: 'APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: 'Kind is a string value representing the REST resource this
- object represents. Servers may infer this from the endpoint the client
- submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+ description: 'Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
spec:
- description: AlertmanagerConfigSpec is a specification of the desired
- behavior of the Alertmanager configuration. By definition, the Alertmanager
- configuration only applies to alerts for which the `namespace` label
- is equal to the namespace of the AlertmanagerConfig resource.
+ description: AlertmanagerConfigSpec is a specification of the desired behavior of the Alertmanager configuration. By definition, the Alertmanager configuration only applies to alerts for which the `namespace` label is equal to the namespace of the AlertmanagerConfig resource.
properties:
inhibitRules:
- description: List of inhibition rules. The rules will only apply to
- alerts matching the resource's namespace.
+ description: List of inhibition rules. The rules will only apply to alerts matching the resource's namespace.
items:
- description: InhibitRule defines an inhibition rule that allows
- to mute alerts when other alerts are already firing. See https://prometheus.io/docs/alerting/latest/configuration/#inhibit_rule
+ description: InhibitRule defines an inhibition rule that allows to mute alerts when other alerts are already firing. See https://prometheus.io/docs/alerting/latest/configuration/#inhibit_rule
properties:
equal:
- description: Labels that must have an equal value in the source
- and target alert for the inhibition to take effect.
+ description: Labels that must have an equal value in the source and target alert for the inhibition to take effect.
items:
type: string
type: array
sourceMatch:
- description: Matchers for which one or more alerts have to exist
- for the inhibition to take effect. The operator enforces that
- the alert matches the resource's namespace.
+ description: Matchers for which one or more alerts have to exist for the inhibition to take effect. The operator enforces that the alert matches the resource's namespace.
items:
description: Matcher defines how to match on alert's labels.
properties:
matchType:
- description: Match operation available with AlertManager
- >= v0.22.0 and takes precedence over Regex (deprecated)
- if non-empty.
+ description: Match operation available with AlertManager >= v0.22.0 and takes precedence over Regex (deprecated) if non-empty.
enum:
- '!='
- =
@@ -77,9 +62,7 @@ spec:
minLength: 1
type: string
regex:
- description: Whether to match on equality (false) or regular-expression
- (true). Deprecated as of AlertManager >= v0.22.0 where
- a user should use MatchType instead.
+ description: Whether to match on equality (false) or regular-expression (true). Deprecated as of AlertManager >= v0.22.0 where a user should use MatchType instead.
type: boolean
value:
description: Label value to match.
@@ -89,16 +72,12 @@ spec:
type: object
type: array
targetMatch:
- description: Matchers that have to be fulfilled in the alerts
- to be muted. The operator enforces that the alert matches
- the resource's namespace.
+ description: Matchers that have to be fulfilled in the alerts to be muted. The operator enforces that the alert matches the resource's namespace.
items:
description: Matcher defines how to match on alert's labels.
properties:
matchType:
- description: Match operation available with AlertManager
- >= v0.22.0 and takes precedence over Regex (deprecated)
- if non-empty.
+ description: Match operation available with AlertManager >= v0.22.0 and takes precedence over Regex (deprecated) if non-empty.
enum:
- '!='
- =
@@ -110,9 +89,7 @@ spec:
minLength: 1
type: string
regex:
- description: Whether to match on equality (false) or regular-expression
- (true). Deprecated as of AlertManager >= v0.22.0 where
- a user should use MatchType instead.
+ description: Whether to match on equality (false) or regular-expression (true). Deprecated as of AlertManager >= v0.22.0 where a user should use MatchType instead.
type: boolean
value:
description: Label value to match.
@@ -124,11 +101,9 @@ spec:
type: object
type: array
muteTimeIntervals:
- description: List of MuteTimeInterval specifying when the routes should
- be muted.
+ description: List of MuteTimeInterval specifying when the routes should be muted.
items:
- description: MuteTimeInterval specifies the periods in time when
- notifications will be muted
+ description: MuteTimeInterval specifies the periods in time when notifications will be muted
properties:
name:
description: Name of the time interval
@@ -141,8 +116,7 @@ spec:
daysOfMonth:
description: DaysOfMonth is a list of DayOfMonthRange
items:
- description: DayOfMonthRange is an inclusive range of
- days of the month beginning at 1
+ description: DayOfMonthRange is an inclusive range of days of the month beginning at 1
properties:
end:
description: End of the inclusive range
@@ -159,27 +133,21 @@ spec:
months:
description: Months is a list of MonthRange
items:
- description: MonthRange is an inclusive range of months
- of the year beginning in January Months can be specified
- by name (e.g 'January') by numerical month (e.g '1')
- or as an inclusive range (e.g 'January:March', '1:3',
- '1:March')
+ description: MonthRange is an inclusive range of months of the year beginning in January Months can be specified by name (e.g 'January') by numerical month (e.g '1') or as an inclusive range (e.g 'January:March', '1:3', '1:March')
pattern: ^((?i)january|february|march|april|may|june|july|august|september|october|november|december|[1-12])(?:((:((?i)january|february|march|april|may|june|july|august|september|october|november|december|[1-12]))$)|$)
type: string
type: array
times:
description: Times is a list of TimeRange
items:
- description: TimeRange defines a start and end time
- in 24hr format
+ description: TimeRange defines a start and end time in 24hr format
properties:
endTime:
description: EndTime is the end time in 24hr format.
pattern: ^((([01][0-9])|(2[0-3])):[0-5][0-9])$|(^24:00$)
type: string
startTime:
- description: StartTime is the start time in 24hr
- format.
+ description: StartTime is the start time in 24hr format.
pattern: ^((([01][0-9])|(2[0-3])):[0-5][0-9])$|(^24:00$)
type: string
type: object
@@ -187,10 +155,7 @@ spec:
weekdays:
description: Weekdays is a list of WeekdayRange
items:
- description: WeekdayRange is an inclusive range of days
- of the week beginning on Sunday Days can be specified
- by name (e.g 'Sunday') or as an inclusive range (e.g
- 'Monday:Friday')
+ description: WeekdayRange is an inclusive range of days of the week beginning on Sunday Days can be specified by name (e.g 'Sunday') or as an inclusive range (e.g 'Monday:Friday')
pattern: ^((?i)sun|mon|tues|wednes|thurs|fri|satur)day(?:((:(sun|mon|tues|wednes|thurs|fri|satur)day)$)|$)
type: string
type: array
@@ -219,45 +184,31 @@ spec:
description: The identity to use for authentication.
type: string
authPassword:
- description: The secret's key that contains the password
- to use for authentication. The secret needs to be in
- the same namespace as the AlertmanagerConfig object
- and accessible by the Prometheus Operator.
+ description: The secret's key that contains the password to use for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
authSecret:
- description: The secret's key that contains the CRAM-MD5
- secret. The secret needs to be in the same namespace
- as the AlertmanagerConfig object and accessible by the
- Prometheus Operator.
+ description: The secret's key that contains the CRAM-MD5 secret. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -269,9 +220,7 @@ spec:
description: The sender address.
type: string
headers:
- description: Further headers email header key/value pairs.
- Overrides any headers previously set by the notification
- implementation.
+ description: Further headers email header key/value pairs. Overrides any headers previously set by the notification implementation.
items:
description: KeyValue defines a (key, value) tuple.
properties:
@@ -294,15 +243,13 @@ spec:
description: The HTML body of the email notification.
type: string
requireTLS:
- description: The SMTP TLS requirement. Note that Go does
- not support unencrypted connections to remote SMTP endpoints.
+ description: The SMTP TLS requirement. Note that Go does not support unencrypted connections to remote SMTP endpoints.
type: boolean
sendResolved:
description: Whether or not to notify about resolved alerts.
type: boolean
smarthost:
- description: The SMTP host and port through which emails
- are sent. E.g. example.com:25
+ description: The SMTP host and port through which emails are sent. E.g. example.com:25
type: string
text:
description: The text body of the email notification.
@@ -311,47 +258,35 @@ spec:
description: TLS configuration
properties:
ca:
- description: Certificate authority used when verifying
- server certificates.
+ description: Certificate authority used when verifying server certificates.
properties:
configMap:
- description: ConfigMap containing data to use
- for the targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap
- or its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
secret:
- description: Secret containing data to use for
- the targets.
+ description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -359,47 +294,35 @@ spec:
x-kubernetes-map-type: atomic
type: object
cert:
- description: Client certificate to present when doing
- client-authentication.
+ description: Client certificate to present when doing client-authentication.
properties:
configMap:
- description: ConfigMap containing data to use
- for the targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap
- or its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
secret:
- description: Secret containing data to use for
- the targets.
+ description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -410,22 +333,16 @@ spec:
description: Disable target certificate validation.
type: boolean
keySecret:
- description: Secret containing the client key file
- for the targets.
+ description: Secret containing the client key file for the targets.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its
- key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -441,38 +358,28 @@ spec:
type: object
type: array
name:
- description: Name of the receiver. Must be unique across all
- items from the list.
+ description: Name of the receiver. Must be unique across all items from the list.
minLength: 1
type: string
opsgenieConfigs:
description: List of OpsGenie configurations.
items:
- description: OpsGenieConfig configures notifications via OpsGenie.
- See https://prometheus.io/docs/alerting/latest/configuration/#opsgenie_config
+ description: OpsGenieConfig configures notifications via OpsGenie. See https://prometheus.io/docs/alerting/latest/configuration/#opsgenie_config
properties:
actions:
- description: Comma separated list of actions that will
- be available for the alert.
+ description: Comma separated list of actions that will be available for the alert.
type: string
apiKey:
- description: The secret's key that contains the OpsGenie
- API key. The secret needs to be in the same namespace
- as the AlertmanagerConfig object and accessible by the
- Prometheus Operator.
+ description: The secret's key that contains the OpsGenie API key. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -484,8 +391,7 @@ spec:
description: Description of the incident.
type: string
details:
- description: A set of arbitrary key/value pairs that provide
- further detail about the incident.
+ description: A set of arbitrary key/value pairs that provide further detail about the incident.
items:
description: KeyValue defines a (key, value) tuple.
properties:
@@ -502,89 +408,64 @@ spec:
type: object
type: array
entity:
- description: Optional field that can be used to specify
- which domain alert is related to.
+ description: Optional field that can be used to specify which domain alert is related to.
type: string
httpConfig:
description: HTTP client configuration.
properties:
authorization:
- description: Authorization header configuration for
- the client. This is mutually exclusive with BasicAuth
- and is only available starting from Alertmanager
- v0.22+.
+ description: Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
properties:
credentials:
- description: The secret's key that contains the
- credentials of the request
+ description: The secret's key that contains the credentials of the request
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
type:
- description: Set the authentication type. Defaults
- to Bearer, Basic will cause an error
+ description: Set the authentication type. Defaults to Bearer, Basic will cause an error
type: string
type: object
basicAuth:
- description: BasicAuth for the client. This is mutually
- exclusive with Authorization. If both are defined,
- BasicAuth takes precedence.
+ description: BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
properties:
password:
- description: The secret in the service monitor
- namespace that contains the password for authentication.
+ description: The secret in the service monitor namespace that contains the password for authentication.
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
username:
- description: The secret in the service monitor
- namespace that contains the username for authentication.
+ description: The secret in the service monitor namespace that contains the username for authentication.
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -592,80 +473,56 @@ spec:
x-kubernetes-map-type: atomic
type: object
bearerTokenSecret:
- description: The secret's key that contains the bearer
- token to be used by the client for authentication.
- The secret needs to be in the same namespace as
- the AlertmanagerConfig object and accessible by
- the Prometheus Operator.
+ description: The secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its
- key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
followRedirects:
- description: FollowRedirects specifies whether the
- client should follow HTTP 3xx redirects.
+ description: FollowRedirects specifies whether the client should follow HTTP 3xx redirects.
type: boolean
oauth2:
- description: OAuth2 client credentials used to fetch
- a token for the targets.
+ description: OAuth2 client credentials used to fetch a token for the targets.
properties:
clientId:
- description: The secret or configmap containing
- the OAuth2 client id
+ description: The secret or configmap containing the OAuth2 client id
properties:
configMap:
- description: ConfigMap containing data to
- use for the targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap
- or its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
secret:
- description: Secret containing data to use
- for the targets.
+ description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to
- select from. Must be a valid secret
- key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret
- or its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -673,22 +530,16 @@ spec:
x-kubernetes-map-type: atomic
type: object
clientSecret:
- description: The secret containing the OAuth2
- client secret
+ description: The secret containing the OAuth2 client secret
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -697,12 +548,10 @@ spec:
endpointParams:
additionalProperties:
type: string
- description: Parameters to append to the token
- URL
+ description: Parameters to append to the token URL
type: object
scopes:
- description: OAuth2 scopes used for the token
- request
+ description: OAuth2 scopes used for the token request
items:
type: string
type: array
@@ -722,48 +571,35 @@ spec:
description: TLS configuration for the client.
properties:
ca:
- description: Certificate authority used when verifying
- server certificates.
+ description: Certificate authority used when verifying server certificates.
properties:
configMap:
- description: ConfigMap containing data to
- use for the targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap
- or its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
secret:
- description: Secret containing data to use
- for the targets.
+ description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to
- select from. Must be a valid secret
- key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret
- or its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -771,48 +607,35 @@ spec:
x-kubernetes-map-type: atomic
type: object
cert:
- description: Client certificate to present when
- doing client-authentication.
+ description: Client certificate to present when doing client-authentication.
properties:
configMap:
- description: ConfigMap containing data to
- use for the targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap
- or its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
secret:
- description: Secret containing data to use
- for the targets.
+ description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to
- select from. Must be a valid secret
- key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret
- or its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -823,30 +646,23 @@ spec:
description: Disable target certificate validation.
type: boolean
keySecret:
- description: Secret containing the client key
- file for the targets.
+ description: Secret containing the client key file for the targets.
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
serverName:
- description: Used to verify the hostname for the
- targets.
+ description: Used to verify the hostname for the targets.
type: string
type: object
type: object
@@ -857,15 +673,12 @@ spec:
description: Additional alert note.
type: string
priority:
- description: Priority level of alert. Possible values
- are P1, P2, P3, P4, and P5.
+ description: Priority level of alert. Possible values are P1, P2, P3, P4, and P5.
type: string
responders:
description: List of responders responsible for notifications.
items:
- description: OpsGenieConfigResponder defines a responder
- to an incident. One of `id`, `name` or `username`
- has to be defined.
+ description: OpsGenieConfigResponder defines a responder to an incident. One of `id`, `name` or `username` has to be defined.
properties:
id:
description: ID of the responder.
@@ -897,22 +710,17 @@ spec:
description: Backlink to the sender of the notification.
type: string
tags:
- description: Comma separated list of tags attached to
- the notifications.
+ description: Comma separated list of tags attached to the notifications.
type: string
updateAlerts:
- description: Whether to update message and description
- of the alert in OpsGenie if it already exists By default,
- the alert is never updated in OpsGenie, the new message
- only appears in activity log.
+ description: Whether to update message and description of the alert in OpsGenie if it already exists By default, the alert is never updated in OpsGenie, the new message only appears in activity log.
type: boolean
type: object
type: array
pagerdutyConfigs:
description: List of PagerDuty configurations.
items:
- description: PagerDutyConfig configures notifications via
- PagerDuty. See https://prometheus.io/docs/alerting/latest/configuration/#pagerduty_config
+ description: PagerDutyConfig configures notifications via PagerDuty. See https://prometheus.io/docs/alerting/latest/configuration/#pagerduty_config
properties:
class:
description: The class/type of the event.
@@ -924,15 +732,13 @@ spec:
description: Backlink to the sender of notification.
type: string
component:
- description: The part or component of the affected system
- that is broken.
+ description: The part or component of the affected system that is broken.
type: string
description:
description: Description of the incident.
type: string
details:
- description: Arbitrary key/value pairs that provide further
- detail about the incident.
+ description: Arbitrary key/value pairs that provide further detail about the incident.
items:
description: KeyValue defines a (key, value) tuple.
properties:
@@ -955,82 +761,58 @@ spec:
description: HTTP client configuration.
properties:
authorization:
- description: Authorization header configuration for
- the client. This is mutually exclusive with BasicAuth
- and is only available starting from Alertmanager
- v0.22+.
+ description: Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
properties:
credentials:
- description: The secret's key that contains the
- credentials of the request
+ description: The secret's key that contains the credentials of the request
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
type:
- description: Set the authentication type. Defaults
- to Bearer, Basic will cause an error
+ description: Set the authentication type. Defaults to Bearer, Basic will cause an error
type: string
type: object
basicAuth:
- description: BasicAuth for the client. This is mutually
- exclusive with Authorization. If both are defined,
- BasicAuth takes precedence.
+ description: BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
properties:
password:
- description: The secret in the service monitor
- namespace that contains the password for authentication.
+ description: The secret in the service monitor namespace that contains the password for authentication.
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
username:
- description: The secret in the service monitor
- namespace that contains the username for authentication.
+ description: The secret in the service monitor namespace that contains the username for authentication.
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -1038,80 +820,56 @@ spec:
x-kubernetes-map-type: atomic
type: object
bearerTokenSecret:
- description: The secret's key that contains the bearer
- token to be used by the client for authentication.
- The secret needs to be in the same namespace as
- the AlertmanagerConfig object and accessible by
- the Prometheus Operator.
+ description: The secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its
- key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
followRedirects:
- description: FollowRedirects specifies whether the
- client should follow HTTP 3xx redirects.
+ description: FollowRedirects specifies whether the client should follow HTTP 3xx redirects.
type: boolean
oauth2:
- description: OAuth2 client credentials used to fetch
- a token for the targets.
+ description: OAuth2 client credentials used to fetch a token for the targets.
properties:
clientId:
- description: The secret or configmap containing
- the OAuth2 client id
+ description: The secret or configmap containing the OAuth2 client id
properties:
configMap:
- description: ConfigMap containing data to
- use for the targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap
- or its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
secret:
- description: Secret containing data to use
- for the targets.
+ description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to
- select from. Must be a valid secret
- key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret
- or its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -1119,22 +877,16 @@ spec:
x-kubernetes-map-type: atomic
type: object
clientSecret:
- description: The secret containing the OAuth2
- client secret
+ description: The secret containing the OAuth2 client secret
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -1143,12 +895,10 @@ spec:
endpointParams:
additionalProperties:
type: string
- description: Parameters to append to the token
- URL
+ description: Parameters to append to the token URL
type: object
scopes:
- description: OAuth2 scopes used for the token
- request
+ description: OAuth2 scopes used for the token request
items:
type: string
type: array
@@ -1168,48 +918,35 @@ spec:
description: TLS configuration for the client.
properties:
ca:
- description: Certificate authority used when verifying
- server certificates.
+ description: Certificate authority used when verifying server certificates.
properties:
configMap:
- description: ConfigMap containing data to
- use for the targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap
- or its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
secret:
- description: Secret containing data to use
- for the targets.
+ description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to
- select from. Must be a valid secret
- key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret
- or its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -1217,48 +954,35 @@ spec:
x-kubernetes-map-type: atomic
type: object
cert:
- description: Client certificate to present when
- doing client-authentication.
+ description: Client certificate to present when doing client-authentication.
properties:
configMap:
- description: ConfigMap containing data to
- use for the targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap
- or its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
secret:
- description: Secret containing data to use
- for the targets.
+ description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to
- select from. Must be a valid secret
- key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret
- or its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -1269,64 +993,49 @@ spec:
description: Disable target certificate validation.
type: boolean
keySecret:
- description: Secret containing the client key
- file for the targets.
+ description: Secret containing the client key file for the targets.
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
serverName:
- description: Used to verify the hostname for the
- targets.
+ description: Used to verify the hostname for the targets.
type: string
type: object
type: object
pagerDutyImageConfigs:
- description: A list of image details to attach that provide
- further detail about an incident.
+ description: A list of image details to attach that provide further detail about an incident.
items:
- description: PagerDutyImageConfig attaches images to
- an incident
+ description: PagerDutyImageConfig attaches images to an incident
properties:
alt:
- description: Alt is the optional alternative text
- for the image.
+ description: Alt is the optional alternative text for the image.
type: string
href:
- description: Optional URL; makes the image a clickable
- link.
+ description: Optional URL; makes the image a clickable link.
type: string
src:
- description: Src of the image being attached to
- the incident
+ description: Src of the image being attached to the incident
type: string
type: object
type: array
pagerDutyLinkConfigs:
- description: A list of link details to attach that provide
- further detail about an incident.
+ description: A list of link details to attach that provide further detail about an incident.
items:
- description: PagerDutyLinkConfig attaches text links
- to an incident
+ description: PagerDutyLinkConfig attaches text links to an incident
properties:
alt:
- description: Text that describes the purpose of
- the link, and can be used as the link's text.
+ description: Text that describes the purpose of the link, and can be used as the link's text.
type: string
href:
description: Href is the URL of the link to be attached
@@ -1334,24 +1043,16 @@ spec:
type: object
type: array
routingKey:
- description: The secret's key that contains the PagerDuty
- integration key (when using Events API v2). Either this
- field or `serviceKey` needs to be defined. The secret
- needs to be in the same namespace as the AlertmanagerConfig
- object and accessible by the Prometheus Operator.
+ description: The secret's key that contains the PagerDuty integration key (when using Events API v2). Either this field or `serviceKey` needs to be defined. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -1360,25 +1061,16 @@ spec:
description: Whether or not to notify about resolved alerts.
type: boolean
serviceKey:
- description: The secret's key that contains the PagerDuty
- service key (when using integration type "Prometheus").
- Either this field or `routingKey` needs to be defined.
- The secret needs to be in the same namespace as the
- AlertmanagerConfig object and accessible by the Prometheus
- Operator.
+ description: The secret's key that contains the PagerDuty service key (when using integration type "Prometheus"). Either this field or `routingKey` needs to be defined. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -1394,99 +1086,71 @@ spec:
pushoverConfigs:
description: List of Pushover configurations.
items:
- description: PushoverConfig configures notifications via Pushover.
- See https://prometheus.io/docs/alerting/latest/configuration/#pushover_config
+ description: PushoverConfig configures notifications via Pushover. See https://prometheus.io/docs/alerting/latest/configuration/#pushover_config
properties:
expire:
- description: How long your notification will continue
- to be retried for, unless the user acknowledges the
- notification.
+ description: How long your notification will continue to be retried for, unless the user acknowledges the notification.
pattern: ^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$
type: string
html:
- description: Whether notification message is HTML or plain
- text.
+ description: Whether notification message is HTML or plain text.
type: boolean
httpConfig:
description: HTTP client configuration.
properties:
authorization:
- description: Authorization header configuration for
- the client. This is mutually exclusive with BasicAuth
- and is only available starting from Alertmanager
- v0.22+.
+ description: Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
properties:
credentials:
- description: The secret's key that contains the
- credentials of the request
+ description: The secret's key that contains the credentials of the request
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
type:
- description: Set the authentication type. Defaults
- to Bearer, Basic will cause an error
+ description: Set the authentication type. Defaults to Bearer, Basic will cause an error
type: string
type: object
basicAuth:
- description: BasicAuth for the client. This is mutually
- exclusive with Authorization. If both are defined,
- BasicAuth takes precedence.
+ description: BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
properties:
password:
- description: The secret in the service monitor
- namespace that contains the password for authentication.
+ description: The secret in the service monitor namespace that contains the password for authentication.
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
username:
- description: The secret in the service monitor
- namespace that contains the username for authentication.
+ description: The secret in the service monitor namespace that contains the username for authentication.
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -1494,80 +1158,56 @@ spec:
x-kubernetes-map-type: atomic
type: object
bearerTokenSecret:
- description: The secret's key that contains the bearer
- token to be used by the client for authentication.
- The secret needs to be in the same namespace as
- the AlertmanagerConfig object and accessible by
- the Prometheus Operator.
+ description: The secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its
- key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
followRedirects:
- description: FollowRedirects specifies whether the
- client should follow HTTP 3xx redirects.
+ description: FollowRedirects specifies whether the client should follow HTTP 3xx redirects.
type: boolean
oauth2:
- description: OAuth2 client credentials used to fetch
- a token for the targets.
+ description: OAuth2 client credentials used to fetch a token for the targets.
properties:
clientId:
- description: The secret or configmap containing
- the OAuth2 client id
+ description: The secret or configmap containing the OAuth2 client id
properties:
configMap:
- description: ConfigMap containing data to
- use for the targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap
- or its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
secret:
- description: Secret containing data to use
- for the targets.
+ description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to
- select from. Must be a valid secret
- key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret
- or its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -1575,22 +1215,16 @@ spec:
x-kubernetes-map-type: atomic
type: object
clientSecret:
- description: The secret containing the OAuth2
- client secret
+ description: The secret containing the OAuth2 client secret
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -1599,12 +1233,10 @@ spec:
endpointParams:
additionalProperties:
type: string
- description: Parameters to append to the token
- URL
+ description: Parameters to append to the token URL
type: object
scopes:
- description: OAuth2 scopes used for the token
- request
+ description: OAuth2 scopes used for the token request
items:
type: string
type: array
@@ -1624,48 +1256,35 @@ spec:
description: TLS configuration for the client.
properties:
ca:
- description: Certificate authority used when verifying
- server certificates.
+ description: Certificate authority used when verifying server certificates.
properties:
configMap:
- description: ConfigMap containing data to
- use for the targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap
- or its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
secret:
- description: Secret containing data to use
- for the targets.
+ description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to
- select from. Must be a valid secret
- key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret
- or its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -1673,48 +1292,35 @@ spec:
x-kubernetes-map-type: atomic
type: object
cert:
- description: Client certificate to present when
- doing client-authentication.
+ description: Client certificate to present when doing client-authentication.
properties:
configMap:
- description: ConfigMap containing data to
- use for the targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap
- or its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
secret:
- description: Secret containing data to use
- for the targets.
+ description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to
- select from. Must be a valid secret
- key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret
- or its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -1725,30 +1331,23 @@ spec:
description: Disable target certificate validation.
type: boolean
keySecret:
- description: Secret containing the client key
- file for the targets.
+ description: Secret containing the client key file for the targets.
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
serverName:
- description: Used to verify the hostname for the
- targets.
+ description: Used to verify the hostname for the targets.
type: string
type: object
type: object
@@ -1759,41 +1358,29 @@ spec:
description: Priority, see https://pushover.net/api#priority
type: string
retry:
- description: How often the Pushover servers will send
- the same notification to the user. Must be at least
- 30 seconds.
+ description: How often the Pushover servers will send the same notification to the user. Must be at least 30 seconds.
pattern: ^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$
type: string
sendResolved:
description: Whether or not to notify about resolved alerts.
type: boolean
sound:
- description: The name of one of the sounds supported by
- device clients to override the user's default sound
- choice
+ description: The name of one of the sounds supported by device clients to override the user's default sound choice
type: string
title:
description: Notification title.
type: string
token:
- description: The secret's key that contains the registered
- application's API token, see https://pushover.net/apps.
- The secret needs to be in the same namespace as the
- AlertmanagerConfig object and accessible by the Prometheus
- Operator.
+ description: The secret's key that contains the registered application's API token, see https://pushover.net/apps. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -1802,27 +1389,19 @@ spec:
description: A supplementary URL shown alongside the message.
type: string
urlTitle:
- description: A title for supplementary URL, otherwise
- just the URL is shown
+ description: A title for supplementary URL, otherwise just the URL is shown
type: string
userKey:
- description: The secret's key that contains the recipient
- user's user key. The secret needs to be in the same
- namespace as the AlertmanagerConfig object and accessible
- by the Prometheus Operator.
+ description: The secret's key that contains the recipient user's user key. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -1832,24 +1411,15 @@ spec:
slackConfigs:
description: List of Slack configurations.
items:
- description: SlackConfig configures notifications via Slack.
- See https://prometheus.io/docs/alerting/latest/configuration/#slack_config
+ description: SlackConfig configures notifications via Slack. See https://prometheus.io/docs/alerting/latest/configuration/#slack_config
properties:
actions:
- description: A list of Slack actions that are sent with
- each notification.
+ description: A list of Slack actions that are sent with each notification.
items:
- description: SlackAction configures a single Slack action
- that is sent with each notification. See https://api.slack.com/docs/message-attachments#action_fields
- and https://api.slack.com/docs/message-buttons for
- more information.
+ description: SlackAction configures a single Slack action that is sent with each notification. See https://api.slack.com/docs/message-attachments#action_fields and https://api.slack.com/docs/message-buttons for more information.
properties:
confirm:
- description: SlackConfirmationField protect users
- from destructive actions or particularly distinguished
- decisions by asking them to confirm their button
- click one more time. See https://api.slack.com/docs/interactive-message-field-guide#confirmation_fields
- for more information.
+ description: SlackConfirmationField protect users from destructive actions or particularly distinguished decisions by asking them to confirm their button click one more time. See https://api.slack.com/docs/interactive-message-field-guide#confirmation_fields for more information.
properties:
dismissText:
type: string
@@ -1883,23 +1453,16 @@ spec:
type: object
type: array
apiURL:
- description: The secret's key that contains the Slack
- webhook URL. The secret needs to be in the same namespace
- as the AlertmanagerConfig object and accessible by the
- Prometheus Operator.
+ description: The secret's key that contains the Slack webhook URL. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -1907,24 +1470,16 @@ spec:
callbackId:
type: string
channel:
- description: The channel or user to send notifications
- to.
+ description: The channel or user to send notifications to.
type: string
color:
type: string
fallback:
type: string
fields:
- description: A list of Slack fields that are sent with
- each notification.
+ description: A list of Slack fields that are sent with each notification.
items:
- description: SlackField configures a single Slack field
- that is sent with each notification. Each field must
- contain a title, value, and optionally, a boolean
- value to indicate if the field is short enough to
- be displayed next to other fields designated as short.
- See https://api.slack.com/docs/message-attachments#fields
- for more information.
+ description: SlackField configures a single Slack field that is sent with each notification. Each field must contain a title, value, and optionally, a boolean value to indicate if the field is short enough to be displayed next to other fields designated as short. See https://api.slack.com/docs/message-attachments#fields for more information.
properties:
short:
type: boolean
@@ -1945,82 +1500,58 @@ spec:
description: HTTP client configuration.
properties:
authorization:
- description: Authorization header configuration for
- the client. This is mutually exclusive with BasicAuth
- and is only available starting from Alertmanager
- v0.22+.
+ description: Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
properties:
credentials:
- description: The secret's key that contains the
- credentials of the request
+ description: The secret's key that contains the credentials of the request
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
type:
- description: Set the authentication type. Defaults
- to Bearer, Basic will cause an error
+ description: Set the authentication type. Defaults to Bearer, Basic will cause an error
type: string
type: object
basicAuth:
- description: BasicAuth for the client. This is mutually
- exclusive with Authorization. If both are defined,
- BasicAuth takes precedence.
+ description: BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
properties:
password:
- description: The secret in the service monitor
- namespace that contains the password for authentication.
+ description: The secret in the service monitor namespace that contains the password for authentication.
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
username:
- description: The secret in the service monitor
- namespace that contains the username for authentication.
+ description: The secret in the service monitor namespace that contains the username for authentication.
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -2028,80 +1559,56 @@ spec:
x-kubernetes-map-type: atomic
type: object
bearerTokenSecret:
- description: The secret's key that contains the bearer
- token to be used by the client for authentication.
- The secret needs to be in the same namespace as
- the AlertmanagerConfig object and accessible by
- the Prometheus Operator.
+ description: The secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its
- key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
followRedirects:
- description: FollowRedirects specifies whether the
- client should follow HTTP 3xx redirects.
+ description: FollowRedirects specifies whether the client should follow HTTP 3xx redirects.
type: boolean
oauth2:
- description: OAuth2 client credentials used to fetch
- a token for the targets.
+ description: OAuth2 client credentials used to fetch a token for the targets.
properties:
clientId:
- description: The secret or configmap containing
- the OAuth2 client id
+ description: The secret or configmap containing the OAuth2 client id
properties:
configMap:
- description: ConfigMap containing data to
- use for the targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap
- or its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
secret:
- description: Secret containing data to use
- for the targets.
+ description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to
- select from. Must be a valid secret
- key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret
- or its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -2109,22 +1616,16 @@ spec:
x-kubernetes-map-type: atomic
type: object
clientSecret:
- description: The secret containing the OAuth2
- client secret
+ description: The secret containing the OAuth2 client secret
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -2133,12 +1634,10 @@ spec:
endpointParams:
additionalProperties:
type: string
- description: Parameters to append to the token
- URL
+ description: Parameters to append to the token URL
type: object
scopes:
- description: OAuth2 scopes used for the token
- request
+ description: OAuth2 scopes used for the token request
items:
type: string
type: array
@@ -2158,48 +1657,35 @@ spec:
description: TLS configuration for the client.
properties:
ca:
- description: Certificate authority used when verifying
- server certificates.
+ description: Certificate authority used when verifying server certificates.
properties:
configMap:
- description: ConfigMap containing data to
- use for the targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap
- or its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
secret:
- description: Secret containing data to use
- for the targets.
+ description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to
- select from. Must be a valid secret
- key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret
- or its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -2207,48 +1693,35 @@ spec:
x-kubernetes-map-type: atomic
type: object
cert:
- description: Client certificate to present when
- doing client-authentication.
+ description: Client certificate to present when doing client-authentication.
properties:
configMap:
- description: ConfigMap containing data to
- use for the targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap
- or its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
secret:
- description: Secret containing data to use
- for the targets.
+ description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to
- select from. Must be a valid secret
- key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret
- or its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -2259,30 +1732,23 @@ spec:
description: Disable target certificate validation.
type: boolean
keySecret:
- description: Secret containing the client key
- file for the targets.
+ description: Secret containing the client key file for the targets.
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
serverName:
- description: Used to verify the hostname for the
- targets.
+ description: Used to verify the hostname for the targets.
type: string
type: object
type: object
@@ -2320,13 +1786,10 @@ spec:
snsConfigs:
description: List of SNS configurations
items:
- description: SNSConfig configures notifications via AWS SNS.
- See https://prometheus.io/docs/alerting/latest/configuration/#sns_configs
+ description: SNSConfig configures notifications via AWS SNS. See https://prometheus.io/docs/alerting/latest/configuration/#sns_configs
properties:
apiURL:
- description: The SNS API URL i.e. https://sns.us-east-2.amazonaws.com.
- If not specified, the SNS API URL from the SNS SDK will
- be used.
+ description: The SNS API URL i.e. https://sns.us-east-2.amazonaws.com. If not specified, the SNS API URL from the SNS SDK will be used.
type: string
attributes:
additionalProperties:
@@ -2337,82 +1800,58 @@ spec:
description: HTTP client configuration.
properties:
authorization:
- description: Authorization header configuration for
- the client. This is mutually exclusive with BasicAuth
- and is only available starting from Alertmanager
- v0.22+.
+ description: Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
properties:
credentials:
- description: The secret's key that contains the
- credentials of the request
+ description: The secret's key that contains the credentials of the request
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
type:
- description: Set the authentication type. Defaults
- to Bearer, Basic will cause an error
+ description: Set the authentication type. Defaults to Bearer, Basic will cause an error
type: string
type: object
basicAuth:
- description: BasicAuth for the client. This is mutually
- exclusive with Authorization. If both are defined,
- BasicAuth takes precedence.
+ description: BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
properties:
password:
- description: The secret in the service monitor
- namespace that contains the password for authentication.
+ description: The secret in the service monitor namespace that contains the password for authentication.
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
username:
- description: The secret in the service monitor
- namespace that contains the username for authentication.
+ description: The secret in the service monitor namespace that contains the username for authentication.
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -2420,80 +1859,56 @@ spec:
x-kubernetes-map-type: atomic
type: object
bearerTokenSecret:
- description: The secret's key that contains the bearer
- token to be used by the client for authentication.
- The secret needs to be in the same namespace as
- the AlertmanagerConfig object and accessible by
- the Prometheus Operator.
+ description: The secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its
- key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
followRedirects:
- description: FollowRedirects specifies whether the
- client should follow HTTP 3xx redirects.
+ description: FollowRedirects specifies whether the client should follow HTTP 3xx redirects.
type: boolean
oauth2:
- description: OAuth2 client credentials used to fetch
- a token for the targets.
+ description: OAuth2 client credentials used to fetch a token for the targets.
properties:
clientId:
- description: The secret or configmap containing
- the OAuth2 client id
+ description: The secret or configmap containing the OAuth2 client id
properties:
configMap:
- description: ConfigMap containing data to
- use for the targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap
- or its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
secret:
- description: Secret containing data to use
- for the targets.
+ description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to
- select from. Must be a valid secret
- key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret
- or its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -2501,22 +1916,16 @@ spec:
x-kubernetes-map-type: atomic
type: object
clientSecret:
- description: The secret containing the OAuth2
- client secret
+ description: The secret containing the OAuth2 client secret
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -2525,12 +1934,10 @@ spec:
endpointParams:
additionalProperties:
type: string
- description: Parameters to append to the token
- URL
+ description: Parameters to append to the token URL
type: object
scopes:
- description: OAuth2 scopes used for the token
- request
+ description: OAuth2 scopes used for the token request
items:
type: string
type: array
@@ -2550,48 +1957,35 @@ spec:
description: TLS configuration for the client.
properties:
ca:
- description: Certificate authority used when verifying
- server certificates.
+ description: Certificate authority used when verifying server certificates.
properties:
configMap:
- description: ConfigMap containing data to
- use for the targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap
- or its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
secret:
- description: Secret containing data to use
- for the targets.
+ description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to
- select from. Must be a valid secret
- key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret
- or its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -2599,48 +1993,35 @@ spec:
x-kubernetes-map-type: atomic
type: object
cert:
- description: Client certificate to present when
- doing client-authentication.
+ description: Client certificate to present when doing client-authentication.
properties:
configMap:
- description: ConfigMap containing data to
- use for the targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap
- or its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
secret:
- description: Secret containing data to use
- for the targets.
+ description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to
- select from. Must be a valid secret
- key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret
- or its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -2651,30 +2032,23 @@ spec:
description: Disable target certificate validation.
type: boolean
keySecret:
- description: Secret containing the client key
- file for the targets.
+ description: Secret containing the client key file for the targets.
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
serverName:
- description: Used to verify the hostname for the
- targets.
+ description: Used to verify the hostname for the targets.
type: string
type: object
type: object
@@ -2682,70 +2056,50 @@ spec:
description: The message content of the SNS notification.
type: string
phoneNumber:
- description: Phone number if message is delivered via
- SMS in E.164 format. If you don't specify this value,
- you must specify a value for the TopicARN or TargetARN.
+ description: Phone number if message is delivered via SMS in E.164 format. If you don't specify this value, you must specify a value for the TopicARN or TargetARN.
type: string
sendResolved:
description: Whether or not to notify about resolved alerts.
type: boolean
sigv4:
- description: Configures AWS's Signature Verification 4
- signing process to sign requests.
+ description: Configures AWS's Signature Verification 4 signing process to sign requests.
properties:
accessKey:
- description: AccessKey is the AWS API key. If blank,
- the environment variable `AWS_ACCESS_KEY_ID` is
- used.
+ description: AccessKey is the AWS API key. If blank, the environment variable `AWS_ACCESS_KEY_ID` is used.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its
- key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
profile:
- description: Profile is the named AWS profile used
- to authenticate.
+ description: Profile is the named AWS profile used to authenticate.
type: string
region:
- description: Region is the AWS region. If blank, the
- region from the default credentials chain used.
+ description: Region is the AWS region. If blank, the region from the default credentials chain used.
type: string
roleArn:
- description: RoleArn is the named AWS profile used
- to authenticate.
+ description: RoleArn is the named AWS profile used to authenticate.
type: string
secretKey:
- description: SecretKey is the AWS API secret. If blank,
- the environment variable `AWS_SECRET_ACCESS_KEY`
- is used.
+ description: SecretKey is the AWS API secret. If blank, the environment variable `AWS_SECRET_ACCESS_KEY` is used.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its
- key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -2753,49 +2107,35 @@ spec:
x-kubernetes-map-type: atomic
type: object
subject:
- description: Subject line when the message is delivered
- to email endpoints.
+ description: Subject line when the message is delivered to email endpoints.
type: string
targetARN:
- description: The mobile platform endpoint ARN if message
- is delivered via mobile notifications. If you don't
- specify this value, you must specify a value for the
- topic_arn or PhoneNumber.
+ description: The mobile platform endpoint ARN if message is delivered via mobile notifications. If you don't specify this value, you must specify a value for the topic_arn or PhoneNumber.
type: string
topicARN:
- description: SNS topic ARN, i.e. arn:aws:sns:us-east-2:698519295917:My-Topic
- If you don't specify this value, you must specify a
- value for the PhoneNumber or TargetARN.
+ description: SNS topic ARN, i.e. arn:aws:sns:us-east-2:698519295917:My-Topic If you don't specify this value, you must specify a value for the PhoneNumber or TargetARN.
type: string
type: object
type: array
telegramConfigs:
description: List of Telegram configurations.
items:
- description: TelegramConfig configures notifications via Telegram.
- See https://prometheus.io/docs/alerting/latest/configuration/#telegram_config
+ description: TelegramConfig configures notifications via Telegram. See https://prometheus.io/docs/alerting/latest/configuration/#telegram_config
properties:
apiURL:
- description: The Telegram API URL i.e. https://api.telegram.org.
- If not specified, default API URL will be used.
+ description: The Telegram API URL i.e. https://api.telegram.org. If not specified, default API URL will be used.
type: string
botToken:
- description: Telegram bot token The secret needs to be
- in the same namespace as the AlertmanagerConfig object
- and accessible by the Prometheus Operator.
+ description: Telegram bot token The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -2811,82 +2151,58 @@ spec:
description: HTTP client configuration.
properties:
authorization:
- description: Authorization header configuration for
- the client. This is mutually exclusive with BasicAuth
- and is only available starting from Alertmanager
- v0.22+.
+ description: Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
properties:
credentials:
- description: The secret's key that contains the
- credentials of the request
+ description: The secret's key that contains the credentials of the request
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
type:
- description: Set the authentication type. Defaults
- to Bearer, Basic will cause an error
+ description: Set the authentication type. Defaults to Bearer, Basic will cause an error
type: string
type: object
basicAuth:
- description: BasicAuth for the client. This is mutually
- exclusive with Authorization. If both are defined,
- BasicAuth takes precedence.
+ description: BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
properties:
password:
- description: The secret in the service monitor
- namespace that contains the password for authentication.
+ description: The secret in the service monitor namespace that contains the password for authentication.
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
username:
- description: The secret in the service monitor
- namespace that contains the username for authentication.
+ description: The secret in the service monitor namespace that contains the username for authentication.
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -2894,80 +2210,56 @@ spec:
x-kubernetes-map-type: atomic
type: object
bearerTokenSecret:
- description: The secret's key that contains the bearer
- token to be used by the client for authentication.
- The secret needs to be in the same namespace as
- the AlertmanagerConfig object and accessible by
- the Prometheus Operator.
+ description: The secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its
- key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
followRedirects:
- description: FollowRedirects specifies whether the
- client should follow HTTP 3xx redirects.
+ description: FollowRedirects specifies whether the client should follow HTTP 3xx redirects.
type: boolean
oauth2:
- description: OAuth2 client credentials used to fetch
- a token for the targets.
+ description: OAuth2 client credentials used to fetch a token for the targets.
properties:
clientId:
- description: The secret or configmap containing
- the OAuth2 client id
+ description: The secret or configmap containing the OAuth2 client id
properties:
configMap:
- description: ConfigMap containing data to
- use for the targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap
- or its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
secret:
- description: Secret containing data to use
- for the targets.
+ description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to
- select from. Must be a valid secret
- key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret
- or its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -2975,22 +2267,16 @@ spec:
x-kubernetes-map-type: atomic
type: object
clientSecret:
- description: The secret containing the OAuth2
- client secret
+ description: The secret containing the OAuth2 client secret
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -2999,12 +2285,10 @@ spec:
endpointParams:
additionalProperties:
type: string
- description: Parameters to append to the token
- URL
+ description: Parameters to append to the token URL
type: object
scopes:
- description: OAuth2 scopes used for the token
- request
+ description: OAuth2 scopes used for the token request
items:
type: string
type: array
@@ -3024,48 +2308,35 @@ spec:
description: TLS configuration for the client.
properties:
ca:
- description: Certificate authority used when verifying
- server certificates.
+ description: Certificate authority used when verifying server certificates.
properties:
configMap:
- description: ConfigMap containing data to
- use for the targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap
- or its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
secret:
- description: Secret containing data to use
- for the targets.
+ description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to
- select from. Must be a valid secret
- key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret
- or its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -3073,48 +2344,35 @@ spec:
x-kubernetes-map-type: atomic
type: object
cert:
- description: Client certificate to present when
- doing client-authentication.
+ description: Client certificate to present when doing client-authentication.
properties:
configMap:
- description: ConfigMap containing data to
- use for the targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap
- or its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
secret:
- description: Secret containing data to use
- for the targets.
+ description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to
- select from. Must be a valid secret
- key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret
- or its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -3125,30 +2383,23 @@ spec:
description: Disable target certificate validation.
type: boolean
keySecret:
- description: Secret containing the client key
- file for the targets.
+ description: Secret containing the client key file for the targets.
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
serverName:
- description: Used to verify the hostname for the
- targets.
+ description: Used to verify the hostname for the targets.
type: string
type: object
type: object
@@ -3170,27 +2421,19 @@ spec:
victoropsConfigs:
description: List of VictorOps configurations.
items:
- description: VictorOpsConfig configures notifications via
- VictorOps. See https://prometheus.io/docs/alerting/latest/configuration/#victorops_config
+ description: VictorOpsConfig configures notifications via VictorOps. See https://prometheus.io/docs/alerting/latest/configuration/#victorops_config
properties:
apiKey:
- description: The secret's key that contains the API key
- to use when talking to the VictorOps API. The secret
- needs to be in the same namespace as the AlertmanagerConfig
- object and accessible by the Prometheus Operator.
+ description: The secret's key that contains the API key to use when talking to the VictorOps API. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -3222,82 +2465,58 @@ spec:
description: The HTTP client's configuration.
properties:
authorization:
- description: Authorization header configuration for
- the client. This is mutually exclusive with BasicAuth
- and is only available starting from Alertmanager
- v0.22+.
+ description: Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
properties:
credentials:
- description: The secret's key that contains the
- credentials of the request
+ description: The secret's key that contains the credentials of the request
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
type:
- description: Set the authentication type. Defaults
- to Bearer, Basic will cause an error
+ description: Set the authentication type. Defaults to Bearer, Basic will cause an error
type: string
type: object
basicAuth:
- description: BasicAuth for the client. This is mutually
- exclusive with Authorization. If both are defined,
- BasicAuth takes precedence.
+ description: BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
properties:
password:
- description: The secret in the service monitor
- namespace that contains the password for authentication.
+ description: The secret in the service monitor namespace that contains the password for authentication.
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
username:
- description: The secret in the service monitor
- namespace that contains the username for authentication.
+ description: The secret in the service monitor namespace that contains the username for authentication.
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -3305,80 +2524,56 @@ spec:
x-kubernetes-map-type: atomic
type: object
bearerTokenSecret:
- description: The secret's key that contains the bearer
- token to be used by the client for authentication.
- The secret needs to be in the same namespace as
- the AlertmanagerConfig object and accessible by
- the Prometheus Operator.
+ description: The secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its
- key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
followRedirects:
- description: FollowRedirects specifies whether the
- client should follow HTTP 3xx redirects.
+ description: FollowRedirects specifies whether the client should follow HTTP 3xx redirects.
type: boolean
oauth2:
- description: OAuth2 client credentials used to fetch
- a token for the targets.
+ description: OAuth2 client credentials used to fetch a token for the targets.
properties:
clientId:
- description: The secret or configmap containing
- the OAuth2 client id
+ description: The secret or configmap containing the OAuth2 client id
properties:
configMap:
- description: ConfigMap containing data to
- use for the targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap
- or its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
secret:
- description: Secret containing data to use
- for the targets.
+ description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to
- select from. Must be a valid secret
- key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret
- or its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -3386,22 +2581,16 @@ spec:
x-kubernetes-map-type: atomic
type: object
clientSecret:
- description: The secret containing the OAuth2
- client secret
+ description: The secret containing the OAuth2 client secret
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -3410,12 +2599,10 @@ spec:
endpointParams:
additionalProperties:
type: string
- description: Parameters to append to the token
- URL
+ description: Parameters to append to the token URL
type: object
scopes:
- description: OAuth2 scopes used for the token
- request
+ description: OAuth2 scopes used for the token request
items:
type: string
type: array
@@ -3435,48 +2622,35 @@ spec:
description: TLS configuration for the client.
properties:
ca:
- description: Certificate authority used when verifying
- server certificates.
+ description: Certificate authority used when verifying server certificates.
properties:
configMap:
- description: ConfigMap containing data to
- use for the targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap
- or its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
secret:
- description: Secret containing data to use
- for the targets.
+ description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to
- select from. Must be a valid secret
- key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret
- or its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -3484,48 +2658,35 @@ spec:
x-kubernetes-map-type: atomic
type: object
cert:
- description: Client certificate to present when
- doing client-authentication.
+ description: Client certificate to present when doing client-authentication.
properties:
configMap:
- description: ConfigMap containing data to
- use for the targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap
- or its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
secret:
- description: Secret containing data to use
- for the targets.
+ description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to
- select from. Must be a valid secret
- key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret
- or its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -3536,40 +2697,31 @@ spec:
description: Disable target certificate validation.
type: boolean
keySecret:
- description: Secret containing the client key
- file for the targets.
+ description: Secret containing the client key file for the targets.
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
serverName:
- description: Used to verify the hostname for the
- targets.
+ description: Used to verify the hostname for the targets.
type: string
type: object
type: object
messageType:
- description: Describes the behavior of the alert (CRITICAL,
- WARNING, INFO).
+ description: Describes the behavior of the alert (CRITICAL, WARNING, INFO).
type: string
monitoringTool:
- description: The monitoring tool the state message is
- from.
+ description: The monitoring tool the state message is from.
type: string
routingKey:
description: A key used to map the alert to a team.
@@ -3578,97 +2730,71 @@ spec:
description: Whether or not to notify about resolved alerts.
type: boolean
stateMessage:
- description: Contains long explanation of the alerted
- problem.
+ description: Contains long explanation of the alerted problem.
type: string
type: object
type: array
webhookConfigs:
description: List of webhook configurations.
items:
- description: WebhookConfig configures notifications via a
- generic receiver supporting the webhook payload. See https://prometheus.io/docs/alerting/latest/configuration/#webhook_config
+ description: WebhookConfig configures notifications via a generic receiver supporting the webhook payload. See https://prometheus.io/docs/alerting/latest/configuration/#webhook_config
properties:
httpConfig:
description: HTTP client configuration.
properties:
authorization:
- description: Authorization header configuration for
- the client. This is mutually exclusive with BasicAuth
- and is only available starting from Alertmanager
- v0.22+.
+ description: Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
properties:
credentials:
- description: The secret's key that contains the
- credentials of the request
+ description: The secret's key that contains the credentials of the request
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
type:
- description: Set the authentication type. Defaults
- to Bearer, Basic will cause an error
+ description: Set the authentication type. Defaults to Bearer, Basic will cause an error
type: string
type: object
basicAuth:
- description: BasicAuth for the client. This is mutually
- exclusive with Authorization. If both are defined,
- BasicAuth takes precedence.
+ description: BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
properties:
password:
- description: The secret in the service monitor
- namespace that contains the password for authentication.
+ description: The secret in the service monitor namespace that contains the password for authentication.
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
username:
- description: The secret in the service monitor
- namespace that contains the username for authentication.
+ description: The secret in the service monitor namespace that contains the username for authentication.
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -3676,80 +2802,56 @@ spec:
x-kubernetes-map-type: atomic
type: object
bearerTokenSecret:
- description: The secret's key that contains the bearer
- token to be used by the client for authentication.
- The secret needs to be in the same namespace as
- the AlertmanagerConfig object and accessible by
- the Prometheus Operator.
+ description: The secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its
- key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
followRedirects:
- description: FollowRedirects specifies whether the
- client should follow HTTP 3xx redirects.
+ description: FollowRedirects specifies whether the client should follow HTTP 3xx redirects.
type: boolean
oauth2:
- description: OAuth2 client credentials used to fetch
- a token for the targets.
+ description: OAuth2 client credentials used to fetch a token for the targets.
properties:
clientId:
- description: The secret or configmap containing
- the OAuth2 client id
+ description: The secret or configmap containing the OAuth2 client id
properties:
configMap:
- description: ConfigMap containing data to
- use for the targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap
- or its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
secret:
- description: Secret containing data to use
- for the targets.
+ description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to
- select from. Must be a valid secret
- key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret
- or its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -3757,22 +2859,16 @@ spec:
x-kubernetes-map-type: atomic
type: object
clientSecret:
- description: The secret containing the OAuth2
- client secret
+ description: The secret containing the OAuth2 client secret
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -3781,12 +2877,10 @@ spec:
endpointParams:
additionalProperties:
type: string
- description: Parameters to append to the token
- URL
+ description: Parameters to append to the token URL
type: object
scopes:
- description: OAuth2 scopes used for the token
- request
+ description: OAuth2 scopes used for the token request
items:
type: string
type: array
@@ -3806,48 +2900,35 @@ spec:
description: TLS configuration for the client.
properties:
ca:
- description: Certificate authority used when verifying
- server certificates.
+ description: Certificate authority used when verifying server certificates.
properties:
configMap:
- description: ConfigMap containing data to
- use for the targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap
- or its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
secret:
- description: Secret containing data to use
- for the targets.
+ description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to
- select from. Must be a valid secret
- key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret
- or its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -3855,48 +2936,35 @@ spec:
x-kubernetes-map-type: atomic
type: object
cert:
- description: Client certificate to present when
- doing client-authentication.
+ description: Client certificate to present when doing client-authentication.
properties:
configMap:
- description: ConfigMap containing data to
- use for the targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap
- or its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
secret:
- description: Secret containing data to use
- for the targets.
+ description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to
- select from. Must be a valid secret
- key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret
- or its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -3907,36 +2975,28 @@ spec:
description: Disable target certificate validation.
type: boolean
keySecret:
- description: Secret containing the client key
- file for the targets.
+ description: Secret containing the client key file for the targets.
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
serverName:
- description: Used to verify the hostname for the
- targets.
+ description: Used to verify the hostname for the targets.
type: string
type: object
type: object
maxAlerts:
- description: Maximum number of alerts to be sent per webhook
- message. When 0, all alerts are included.
+ description: Maximum number of alerts to be sent per webhook message. When 0, all alerts are included.
format: int32
minimum: 0
type: integer
@@ -3944,30 +3004,19 @@ spec:
description: Whether or not to notify about resolved alerts.
type: boolean
url:
- description: The URL to send HTTP POST requests to. `urlSecret`
- takes precedence over `url`. One of `urlSecret` and
- `url` should be defined.
+ description: The URL to send HTTP POST requests to. `urlSecret` takes precedence over `url`. One of `urlSecret` and `url` should be defined.
type: string
urlSecret:
- description: The secret's key that contains the webhook
- URL to send HTTP requests to. `urlSecret` takes precedence
- over `url`. One of `urlSecret` and `url` should be defined.
- The secret needs to be in the same namespace as the
- AlertmanagerConfig object and accessible by the Prometheus
- Operator.
+ description: The secret's key that contains the webhook URL to send HTTP requests to. `urlSecret` takes precedence over `url`. One of `urlSecret` and `url` should be defined. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -3977,29 +3026,21 @@ spec:
wechatConfigs:
description: List of WeChat configurations.
items:
- description: WeChatConfig configures notifications via WeChat.
- See https://prometheus.io/docs/alerting/latest/configuration/#wechat_config
+ description: WeChatConfig configures notifications via WeChat. See https://prometheus.io/docs/alerting/latest/configuration/#wechat_config
properties:
agentID:
type: string
apiSecret:
- description: The secret's key that contains the WeChat
- API key. The secret needs to be in the same namespace
- as the AlertmanagerConfig object and accessible by the
- Prometheus Operator.
+ description: The secret's key that contains the WeChat API key. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -4014,82 +3055,58 @@ spec:
description: HTTP client configuration.
properties:
authorization:
- description: Authorization header configuration for
- the client. This is mutually exclusive with BasicAuth
- and is only available starting from Alertmanager
- v0.22+.
+ description: Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
properties:
credentials:
- description: The secret's key that contains the
- credentials of the request
+ description: The secret's key that contains the credentials of the request
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
type:
- description: Set the authentication type. Defaults
- to Bearer, Basic will cause an error
+ description: Set the authentication type. Defaults to Bearer, Basic will cause an error
type: string
type: object
basicAuth:
- description: BasicAuth for the client. This is mutually
- exclusive with Authorization. If both are defined,
- BasicAuth takes precedence.
+ description: BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
properties:
password:
- description: The secret in the service monitor
- namespace that contains the password for authentication.
+ description: The secret in the service monitor namespace that contains the password for authentication.
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
username:
- description: The secret in the service monitor
- namespace that contains the username for authentication.
+ description: The secret in the service monitor namespace that contains the username for authentication.
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -4097,80 +3114,56 @@ spec:
x-kubernetes-map-type: atomic
type: object
bearerTokenSecret:
- description: The secret's key that contains the bearer
- token to be used by the client for authentication.
- The secret needs to be in the same namespace as
- the AlertmanagerConfig object and accessible by
- the Prometheus Operator.
+ description: The secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its
- key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
followRedirects:
- description: FollowRedirects specifies whether the
- client should follow HTTP 3xx redirects.
+ description: FollowRedirects specifies whether the client should follow HTTP 3xx redirects.
type: boolean
oauth2:
- description: OAuth2 client credentials used to fetch
- a token for the targets.
+ description: OAuth2 client credentials used to fetch a token for the targets.
properties:
clientId:
- description: The secret or configmap containing
- the OAuth2 client id
+ description: The secret or configmap containing the OAuth2 client id
properties:
configMap:
- description: ConfigMap containing data to
- use for the targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap
- or its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
secret:
- description: Secret containing data to use
- for the targets.
+ description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to
- select from. Must be a valid secret
- key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret
- or its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -4178,22 +3171,16 @@ spec:
x-kubernetes-map-type: atomic
type: object
clientSecret:
- description: The secret containing the OAuth2
- client secret
+ description: The secret containing the OAuth2 client secret
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -4202,12 +3189,10 @@ spec:
endpointParams:
additionalProperties:
type: string
- description: Parameters to append to the token
- URL
+ description: Parameters to append to the token URL
type: object
scopes:
- description: OAuth2 scopes used for the token
- request
+ description: OAuth2 scopes used for the token request
items:
type: string
type: array
@@ -4227,48 +3212,35 @@ spec:
description: TLS configuration for the client.
properties:
ca:
- description: Certificate authority used when verifying
- server certificates.
+ description: Certificate authority used when verifying server certificates.
properties:
configMap:
- description: ConfigMap containing data to
- use for the targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap
- or its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
secret:
- description: Secret containing data to use
- for the targets.
+ description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to
- select from. Must be a valid secret
- key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret
- or its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -4276,48 +3248,35 @@ spec:
x-kubernetes-map-type: atomic
type: object
cert:
- description: Client certificate to present when
- doing client-authentication.
+ description: Client certificate to present when doing client-authentication.
properties:
configMap:
- description: ConfigMap containing data to
- use for the targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap
- or its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
secret:
- description: Secret containing data to use
- for the targets.
+ description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to
- select from. Must be a valid secret
- key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More
- info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret
- or its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -4328,36 +3287,28 @@ spec:
description: Disable target certificate validation.
type: boolean
keySecret:
- description: Secret containing the client key
- file for the targets.
+ description: Secret containing the client key file for the targets.
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
serverName:
- description: Used to verify the hostname for the
- targets.
+ description: Used to verify the hostname for the targets.
type: string
type: object
type: object
message:
- description: API request data as defined by the WeChat
- API.
+ description: API request data as defined by the WeChat API.
type: string
messageType:
type: string
@@ -4377,50 +3328,34 @@ spec:
type: object
type: array
route:
- description: The Alertmanager route definition for alerts matching
- the resource's namespace. If present, it will be added to the generated
- Alertmanager configuration as a first-level route.
+ description: The Alertmanager route definition for alerts matching the resource's namespace. If present, it will be added to the generated Alertmanager configuration as a first-level route.
properties:
activeTimeIntervals:
- description: ActiveTimeIntervals is a list of MuteTimeInterval
- names when this route should be active.
+ description: ActiveTimeIntervals is a list of MuteTimeInterval names when this route should be active.
items:
type: string
type: array
continue:
- description: Boolean indicating whether an alert should continue
- matching subsequent sibling nodes. It will always be overridden
- to true for the first-level route by the Prometheus operator.
+ description: Boolean indicating whether an alert should continue matching subsequent sibling nodes. It will always be overridden to true for the first-level route by the Prometheus operator.
type: boolean
groupBy:
- description: List of labels to group by. Labels must not be repeated
- (unique list). Special label "..." (aggregate by all possible
- labels), if provided, must be the only element in the list.
+ description: List of labels to group by. Labels must not be repeated (unique list). Special label "..." (aggregate by all possible labels), if provided, must be the only element in the list.
items:
type: string
type: array
groupInterval:
- description: 'How long to wait before sending an updated notification.
- Must match the regular expression`^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$`
- Example: "5m"'
+ description: 'How long to wait before sending an updated notification. Must match the regular expression`^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$` Example: "5m"'
type: string
groupWait:
- description: 'How long to wait before sending the initial notification.
- Must match the regular expression`^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$`
- Example: "30s"'
+ description: 'How long to wait before sending the initial notification. Must match the regular expression`^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$` Example: "30s"'
type: string
matchers:
- description: 'List of matchers that the alert''s labels should
- match. For the first level route, the operator removes any existing
- equality and regexp matcher on the `namespace` label and adds
- a `namespace: <object namespace>` matcher.'
+ description: 'List of matchers that the alert''s labels should match. For the first level route, the operator removes any existing equality and regexp matcher on the `namespace` label and adds a `namespace: <object namespace>` matcher.'
items:
description: Matcher defines how to match on alert's labels.
properties:
matchType:
- description: Match operation available with AlertManager
- >= v0.22.0 and takes precedence over Regex (deprecated)
- if non-empty.
+ description: Match operation available with AlertManager >= v0.22.0 and takes precedence over Regex (deprecated) if non-empty.
enum:
- '!='
- =
@@ -4432,9 +3367,7 @@ spec:
minLength: 1
type: string
regex:
- description: Whether to match on equality (false) or regular-expression
- (true). Deprecated as of AlertManager >= v0.22.0 where
- a user should use MatchType instead.
+ description: Whether to match on equality (false) or regular-expression (true). Deprecated as of AlertManager >= v0.22.0 where a user should use MatchType instead.
type: boolean
value:
description: Label value to match.
@@ -4444,26 +3377,15 @@ spec:
type: object
type: array
muteTimeIntervals:
- description: 'Note: this comment applies to the field definition
- above but appears below otherwise it gets included in the generated
- manifest. CRD schema doesn''t support self-referential types
- for now (see https://github.com/kubernetes/kubernetes/issues/62872).
- We have to use an alternative type to circumvent the limitation.
- The downside is that the Kube API can''t validate the data beyond
- the fact that it is a valid JSON representation. MuteTimeIntervals
- is a list of MuteTimeInterval names that will mute this route
- when matched,'
+ description: 'Note: this comment applies to the field definition above but appears below otherwise it gets included in the generated manifest. CRD schema doesn''t support self-referential types for now (see https://github.com/kubernetes/kubernetes/issues/62872). We have to use an alternative type to circumvent the limitation. The downside is that the Kube API can''t validate the data beyond the fact that it is a valid JSON representation. MuteTimeIntervals is a list of MuteTimeInterval names that will mute this route when matched,'
items:
type: string
type: array
receiver:
- description: Name of the receiver for this route. If not empty,
- it should be listed in the `receivers` field.
+ description: Name of the receiver for this route. If not empty, it should be listed in the `receivers` field.
type: string
repeatInterval:
- description: 'How long to wait before repeating the last notification.
- Must match the regular expression`^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$`
- Example: "4h"'
+ description: 'How long to wait before repeating the last notification. Must match the regular expression`^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$` Example: "4h"'
type: string
routes:
description: Child routes.
diff --git a/manifests/setup/0alertmanagerCustomResourceDefinition.yaml b/manifests/setup/0alertmanagerCustomResourceDefinition.yaml
index ae6f1f02b378f6ac37f21c3e32a76169afb590e7..3a9c1fea468f49406d0d898da5ba57fde5383f2e 100644
--- a/manifests/setup/0alertmanagerCustomResourceDefinition.yaml
+++ b/manifests/setup/0alertmanagerCustomResourceDefinition.yaml
@@ -51,24 +51,18 @@ spec:
description: Alertmanager describes an Alertmanager cluster.
properties:
apiVersion:
- description: 'APIVersion defines the versioned schema of this representation
- of an object. Servers should convert recognized schemas to the latest
- internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+ description: 'APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: 'Kind is a string value representing the REST resource this
- object represents. Servers may infer this from the endpoint the client
- submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+ description: 'Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
spec:
- description: 'Specification of the desired behavior of the Alertmanager
- cluster. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status'
+ description: 'Specification of the desired behavior of the Alertmanager cluster. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status'
properties:
additionalPeers:
- description: AdditionalPeers allows injecting a set of additional
- Alertmanagers to peer with to form a highly available cluster.
+ description: AdditionalPeers allows injecting a set of additional Alertmanagers to peer with to form a highly available cluster.
items:
type: string
type: array
@@ -76,59 +70,29 @@ spec:
description: If specified, the pod's scheduling constraints.
properties:
nodeAffinity:
- description: Describes node affinity scheduling rules for the
- pod.
+ description: Describes node affinity scheduling rules for the pod.
properties:
preferredDuringSchedulingIgnoredDuringExecution:
- description: The scheduler will prefer to schedule pods to
- nodes that satisfy the affinity expressions specified by
- this field, but it may choose a node that violates one or
- more of the expressions. The node that is most preferred
- is the one with the greatest sum of weights, i.e. for each
- node that meets all of the scheduling requirements (resource
- request, requiredDuringScheduling affinity expressions,
- etc.), compute a sum by iterating through the elements of
- this field and adding "weight" to the sum if the node matches
- the corresponding matchExpressions; the node(s) with the
- highest sum are the most preferred.
+ description: The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.
items:
- description: An empty preferred scheduling term matches
- all objects with implicit weight 0 (i.e. it's a no-op).
- A null preferred scheduling term matches no objects (i.e.
- is also a no-op).
+ description: An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
properties:
preference:
- description: A node selector term, associated with the
- corresponding weight.
+ description: A node selector term, associated with the corresponding weight.
properties:
matchExpressions:
- description: A list of node selector requirements
- by node's labels.
+ description: A list of node selector requirements by node's labels.
items:
- description: A node selector requirement is a
- selector that contains values, a key, and an
- operator that relates the key and values.
+ description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: The label key that the selector
- applies to.
+ description: The label key that the selector applies to.
type: string
operator:
- description: Represents a key's relationship
- to a set of values. Valid operators are
- In, NotIn, Exists, DoesNotExist. Gt, and
- Lt.
+ description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
type: string
values:
- description: An array of string values. If
- the operator is In or NotIn, the values
- array must be non-empty. If the operator
- is Exists or DoesNotExist, the values array
- must be empty. If the operator is Gt or
- Lt, the values array must have a single
- element, which will be interpreted as an
- integer. This array is replaced during a
- strategic merge patch.
+ description: An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -138,33 +102,18 @@ spec:
type: object
type: array
matchFields:
- description: A list of node selector requirements
- by node's fields.
+ description: A list of node selector requirements by node's fields.
items:
- description: A node selector requirement is a
- selector that contains values, a key, and an
- operator that relates the key and values.
+ description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: The label key that the selector
- applies to.
+ description: The label key that the selector applies to.
type: string
operator:
- description: Represents a key's relationship
- to a set of values. Valid operators are
- In, NotIn, Exists, DoesNotExist. Gt, and
- Lt.
+ description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
type: string
values:
- description: An array of string values. If
- the operator is In or NotIn, the values
- array must be non-empty. If the operator
- is Exists or DoesNotExist, the values array
- must be empty. If the operator is Gt or
- Lt, the values array must have a single
- element, which will be interpreted as an
- integer. This array is replaced during a
- strategic merge patch.
+ description: An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -176,8 +125,7 @@ spec:
type: object
x-kubernetes-map-type: atomic
weight:
- description: Weight associated with matching the corresponding
- nodeSelectorTerm, in the range 1-100.
+ description: Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
format: int32
type: integer
required:
@@ -186,50 +134,26 @@ spec:
type: object
type: array
requiredDuringSchedulingIgnoredDuringExecution:
- description: If the affinity requirements specified by this
- field are not met at scheduling time, the pod will not be
- scheduled onto the node. If the affinity requirements specified
- by this field cease to be met at some point during pod execution
- (e.g. due to an update), the system may or may not try to
- eventually evict the pod from its node.
+ description: If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.
properties:
nodeSelectorTerms:
- description: Required. A list of node selector terms.
- The terms are ORed.
+ description: Required. A list of node selector terms. The terms are ORed.
items:
- description: A null or empty node selector term matches
- no objects. The requirements of them are ANDed. The
- TopologySelectorTerm type implements a subset of the
- NodeSelectorTerm.
+ description: A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
properties:
matchExpressions:
- description: A list of node selector requirements
- by node's labels.
+ description: A list of node selector requirements by node's labels.
items:
- description: A node selector requirement is a
- selector that contains values, a key, and an
- operator that relates the key and values.
+ description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: The label key that the selector
- applies to.
+ description: The label key that the selector applies to.
type: string
operator:
- description: Represents a key's relationship
- to a set of values. Valid operators are
- In, NotIn, Exists, DoesNotExist. Gt, and
- Lt.
+ description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
type: string
values:
- description: An array of string values. If
- the operator is In or NotIn, the values
- array must be non-empty. If the operator
- is Exists or DoesNotExist, the values array
- must be empty. If the operator is Gt or
- Lt, the values array must have a single
- element, which will be interpreted as an
- integer. This array is replaced during a
- strategic merge patch.
+ description: An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -239,33 +163,18 @@ spec:
type: object
type: array
matchFields:
- description: A list of node selector requirements
- by node's fields.
+ description: A list of node selector requirements by node's fields.
items:
- description: A node selector requirement is a
- selector that contains values, a key, and an
- operator that relates the key and values.
+ description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: The label key that the selector
- applies to.
+ description: The label key that the selector applies to.
type: string
operator:
- description: Represents a key's relationship
- to a set of values. Valid operators are
- In, NotIn, Exists, DoesNotExist. Gt, and
- Lt.
+ description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
type: string
values:
- description: An array of string values. If
- the operator is In or NotIn, the values
- array must be non-empty. If the operator
- is Exists or DoesNotExist, the values array
- must be empty. If the operator is Gt or
- Lt, the values array must have a single
- element, which will be interpreted as an
- integer. This array is replaced during a
- strategic merge patch.
+ description: An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -283,61 +192,32 @@ spec:
x-kubernetes-map-type: atomic
type: object
podAffinity:
- description: Describes pod affinity scheduling rules (e.g. co-locate
- this pod in the same node, zone, etc. as some other pod(s)).
+ description: Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
properties:
preferredDuringSchedulingIgnoredDuringExecution:
- description: The scheduler will prefer to schedule pods to
- nodes that satisfy the affinity expressions specified by
- this field, but it may choose a node that violates one or
- more of the expressions. The node that is most preferred
- is the one with the greatest sum of weights, i.e. for each
- node that meets all of the scheduling requirements (resource
- request, requiredDuringScheduling affinity expressions,
- etc.), compute a sum by iterating through the elements of
- this field and adding "weight" to the sum if the node has
- pods which matches the corresponding podAffinityTerm; the
- node(s) with the highest sum are the most preferred.
+ description: The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
items:
- description: The weights of all of the matched WeightedPodAffinityTerm
- fields are added per-node to find the most preferred node(s)
+ description: The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
properties:
podAffinityTerm:
- description: Required. A pod affinity term, associated
- with the corresponding weight.
+ description: Required. A pod affinity term, associated with the corresponding weight.
properties:
labelSelector:
- description: A label query over a set of resources,
- in this case pods.
+ description: A label query over a set of resources, in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label
- selector requirements. The requirements are
- ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement
- is a selector that contains values, a key,
- and an operator that relates the key and
- values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that
- the selector applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's
- relationship to a set of values. Valid
- operators are In, NotIn, Exists and
- DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string
- values. If the operator is In or NotIn,
- the values array must be non-empty.
- If the operator is Exists or DoesNotExist,
- the values array must be empty. This
- array is replaced during a strategic
- merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -349,52 +229,26 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value}
- pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions,
- whose key field is "key", the operator is
- "In", and the values array contains only "value".
- The requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
namespaceSelector:
- description: A label query over the set of namespaces
- that the term applies to. The term is applied
- to the union of the namespaces selected by this
- field and the ones listed in the namespaces field.
- null selector and null or empty namespaces list
- means "this pod's namespace". An empty selector
- ({}) matches all namespaces.
+ description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
properties:
matchExpressions:
- description: matchExpressions is a list of label
- selector requirements. The requirements are
- ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement
- is a selector that contains values, a key,
- and an operator that relates the key and
- values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that
- the selector applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's
- relationship to a set of values. Valid
- operators are In, NotIn, Exists and
- DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string
- values. If the operator is In or NotIn,
- the values array must be non-empty.
- If the operator is Exists or DoesNotExist,
- the values array must be empty. This
- array is replaced during a strategic
- merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -406,40 +260,23 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value}
- pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions,
- whose key field is "key", the operator is
- "In", and the values array contains only "value".
- The requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
namespaces:
- description: namespaces specifies a static list
- of namespace names that the term applies to. The
- term is applied to the union of the namespaces
- listed in this field and the ones selected by
- namespaceSelector. null or empty namespaces list
- and null namespaceSelector means "this pod's namespace".
+ description: namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity)
- or not co-located (anti-affinity) with the pods
- matching the labelSelector in the specified namespaces,
- where co-located is defined as running on a node
- whose value of the label with key topologyKey
- matches that of any node on which any of the selected
- pods is running. Empty topologyKey is not allowed.
+ description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
type: string
required:
- topologyKey
type: object
weight:
- description: weight associated with matching the corresponding
- podAffinityTerm, in the range 1-100.
+ description: weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
format: int32
type: integer
required:
@@ -448,52 +285,26 @@ spec:
type: object
type: array
requiredDuringSchedulingIgnoredDuringExecution:
- description: If the affinity requirements specified by this
- field are not met at scheduling time, the pod will not be
- scheduled onto the node. If the affinity requirements specified
- by this field cease to be met at some point during pod execution
- (e.g. due to a pod label update), the system may or may
- not try to eventually evict the pod from its node. When
- there are multiple elements, the lists of nodes corresponding
- to each podAffinityTerm are intersected, i.e. all terms
- must be satisfied.
+ description: If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
items:
- description: Defines a set of pods (namely those matching
- the labelSelector relative to the given namespace(s))
- that this pod should be co-located (affinity) or not co-located
- (anti-affinity) with, where co-located is defined as running
- on a node whose value of the label with key <topologyKey>
- matches that of any node on which a pod of the set of
- pods is running
+ description: Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
properties:
labelSelector:
- description: A label query over a set of resources,
- in this case pods.
+ description: A label query over a set of resources, in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label
- selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a
- selector that contains values, a key, and an
- operator that relates the key and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the
- selector applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship
- to a set of values. Valid operators are
- In, NotIn, Exists and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string
- values. If the operator is In or NotIn,
- the values array must be non-empty. If the
- operator is Exists or DoesNotExist, the
- values array must be empty. This array is
- replaced during a strategic merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -505,47 +316,26 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value}
- pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions,
- whose key field is "key", the operator is "In",
- and the values array contains only "value". The
- requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
namespaceSelector:
- description: A label query over the set of namespaces
- that the term applies to. The term is applied to the
- union of the namespaces selected by this field and
- the ones listed in the namespaces field. null selector
- and null or empty namespaces list means "this pod's
- namespace". An empty selector ({}) matches all namespaces.
+ description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
properties:
matchExpressions:
- description: matchExpressions is a list of label
- selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a
- selector that contains values, a key, and an
- operator that relates the key and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the
- selector applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship
- to a set of values. Valid operators are
- In, NotIn, Exists and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string
- values. If the operator is In or NotIn,
- the values array must be non-empty. If the
- operator is Exists or DoesNotExist, the
- values array must be empty. This array is
- replaced during a strategic merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -557,33 +347,17 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value}
- pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions,
- whose key field is "key", the operator is "In",
- and the values array contains only "value". The
- requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
namespaces:
- description: namespaces specifies a static list of namespace
- names that the term applies to. The term is applied
- to the union of the namespaces listed in this field
- and the ones selected by namespaceSelector. null or
- empty namespaces list and null namespaceSelector means
- "this pod's namespace".
+ description: namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity)
- or not co-located (anti-affinity) with the pods matching
- the labelSelector in the specified namespaces, where
- co-located is defined as running on a node whose value
- of the label with key topologyKey matches that of
- any node on which any of the selected pods is running.
- Empty topologyKey is not allowed.
+ description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
type: string
required:
- topologyKey
@@ -591,62 +365,32 @@ spec:
type: array
type: object
podAntiAffinity:
- description: Describes pod anti-affinity scheduling rules (e.g.
- avoid putting this pod in the same node, zone, etc. as some
- other pod(s)).
+ description: Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
properties:
preferredDuringSchedulingIgnoredDuringExecution:
- description: The scheduler will prefer to schedule pods to
- nodes that satisfy the anti-affinity expressions specified
- by this field, but it may choose a node that violates one
- or more of the expressions. The node that is most preferred
- is the one with the greatest sum of weights, i.e. for each
- node that meets all of the scheduling requirements (resource
- request, requiredDuringScheduling anti-affinity expressions,
- etc.), compute a sum by iterating through the elements of
- this field and adding "weight" to the sum if the node has
- pods which matches the corresponding podAffinityTerm; the
- node(s) with the highest sum are the most preferred.
+ description: The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
items:
- description: The weights of all of the matched WeightedPodAffinityTerm
- fields are added per-node to find the most preferred node(s)
+ description: The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
properties:
podAffinityTerm:
- description: Required. A pod affinity term, associated
- with the corresponding weight.
+ description: Required. A pod affinity term, associated with the corresponding weight.
properties:
labelSelector:
- description: A label query over a set of resources,
- in this case pods.
+ description: A label query over a set of resources, in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label
- selector requirements. The requirements are
- ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement
- is a selector that contains values, a key,
- and an operator that relates the key and
- values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that
- the selector applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's
- relationship to a set of values. Valid
- operators are In, NotIn, Exists and
- DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string
- values. If the operator is In or NotIn,
- the values array must be non-empty.
- If the operator is Exists or DoesNotExist,
- the values array must be empty. This
- array is replaced during a strategic
- merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -658,52 +402,26 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value}
- pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions,
- whose key field is "key", the operator is
- "In", and the values array contains only "value".
- The requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
namespaceSelector:
- description: A label query over the set of namespaces
- that the term applies to. The term is applied
- to the union of the namespaces selected by this
- field and the ones listed in the namespaces field.
- null selector and null or empty namespaces list
- means "this pod's namespace". An empty selector
- ({}) matches all namespaces.
+ description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
properties:
matchExpressions:
- description: matchExpressions is a list of label
- selector requirements. The requirements are
- ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement
- is a selector that contains values, a key,
- and an operator that relates the key and
- values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that
- the selector applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's
- relationship to a set of values. Valid
- operators are In, NotIn, Exists and
- DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string
- values. If the operator is In or NotIn,
- the values array must be non-empty.
- If the operator is Exists or DoesNotExist,
- the values array must be empty. This
- array is replaced during a strategic
- merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -715,40 +433,23 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value}
- pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions,
- whose key field is "key", the operator is
- "In", and the values array contains only "value".
- The requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
namespaces:
- description: namespaces specifies a static list
- of namespace names that the term applies to. The
- term is applied to the union of the namespaces
- listed in this field and the ones selected by
- namespaceSelector. null or empty namespaces list
- and null namespaceSelector means "this pod's namespace".
+ description: namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity)
- or not co-located (anti-affinity) with the pods
- matching the labelSelector in the specified namespaces,
- where co-located is defined as running on a node
- whose value of the label with key topologyKey
- matches that of any node on which any of the selected
- pods is running. Empty topologyKey is not allowed.
+ description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
type: string
required:
- topologyKey
type: object
weight:
- description: weight associated with matching the corresponding
- podAffinityTerm, in the range 1-100.
+ description: weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
format: int32
type: integer
required:
@@ -757,52 +458,26 @@ spec:
type: object
type: array
requiredDuringSchedulingIgnoredDuringExecution:
- description: If the anti-affinity requirements specified by
- this field are not met at scheduling time, the pod will
- not be scheduled onto the node. If the anti-affinity requirements
- specified by this field cease to be met at some point during
- pod execution (e.g. due to a pod label update), the system
- may or may not try to eventually evict the pod from its
- node. When there are multiple elements, the lists of nodes
- corresponding to each podAffinityTerm are intersected, i.e.
- all terms must be satisfied.
+ description: If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
items:
- description: Defines a set of pods (namely those matching
- the labelSelector relative to the given namespace(s))
- that this pod should be co-located (affinity) or not co-located
- (anti-affinity) with, where co-located is defined as running
- on a node whose value of the label with key <topologyKey>
- matches that of any node on which a pod of the set of
- pods is running
+ description: Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
properties:
labelSelector:
- description: A label query over a set of resources,
- in this case pods.
+ description: A label query over a set of resources, in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label
- selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a
- selector that contains values, a key, and an
- operator that relates the key and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the
- selector applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship
- to a set of values. Valid operators are
- In, NotIn, Exists and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string
- values. If the operator is In or NotIn,
- the values array must be non-empty. If the
- operator is Exists or DoesNotExist, the
- values array must be empty. This array is
- replaced during a strategic merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -814,47 +489,26 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value}
- pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions,
- whose key field is "key", the operator is "In",
- and the values array contains only "value". The
- requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
namespaceSelector:
- description: A label query over the set of namespaces
- that the term applies to. The term is applied to the
- union of the namespaces selected by this field and
- the ones listed in the namespaces field. null selector
- and null or empty namespaces list means "this pod's
- namespace". An empty selector ({}) matches all namespaces.
+ description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
properties:
matchExpressions:
- description: matchExpressions is a list of label
- selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a
- selector that contains values, a key, and an
- operator that relates the key and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the
- selector applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship
- to a set of values. Valid operators are
- In, NotIn, Exists and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string
- values. If the operator is In or NotIn,
- the values array must be non-empty. If the
- operator is Exists or DoesNotExist, the
- values array must be empty. This array is
- replaced during a strategic merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -866,33 +520,17 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value}
- pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions,
- whose key field is "key", the operator is "In",
- and the values array contains only "value". The
- requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
namespaces:
- description: namespaces specifies a static list of namespace
- names that the term applies to. The term is applied
- to the union of the namespaces listed in this field
- and the ones selected by namespaceSelector. null or
- empty namespaces list and null namespaceSelector means
- "this pod's namespace".
+ description: namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity)
- or not co-located (anti-affinity) with the pods matching
- the labelSelector in the specified namespaces, where
- co-located is defined as running on a node whose value
- of the label with key topologyKey matches that of
- any node on which any of the selected pods is running.
- Empty topologyKey is not allowed.
+ description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
type: string
required:
- topologyKey
@@ -901,48 +539,32 @@ spec:
type: object
type: object
alertmanagerConfigMatcherStrategy:
- description: The AlertmanagerConfigMatcherStrategy defines how AlertmanagerConfig
- objects match the alerts. In the future more options may be added.
+ description: The AlertmanagerConfigMatcherStrategy defines how AlertmanagerConfig objects match the alerts. In the future more options may be added.
properties:
type:
default: OnNamespace
- description: If set to `OnNamespace`, the operator injects a label
- matcher matching the namespace of the AlertmanagerConfig object
- for all its routes and inhibition rules. `None` will not add
- any additional matchers other than the ones specified in the
- AlertmanagerConfig. Default is `OnNamespace`.
+ description: If set to `OnNamespace`, the operator injects a label matcher matching the namespace of the AlertmanagerConfig object for all its routes and inhibition rules. `None` will not add any additional matchers other than the ones specified in the AlertmanagerConfig. Default is `OnNamespace`.
enum:
- OnNamespace
- None
type: string
type: object
alertmanagerConfigNamespaceSelector:
- description: Namespaces to be selected for AlertmanagerConfig discovery.
- If nil, only check own namespace.
+ description: Namespaces to be selected for AlertmanagerConfig discovery. If nil, only check own namespace.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements.
- The requirements are ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a selector that
- contains values, a key, and an operator that relates the key
- and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the selector applies
- to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship to
- a set of values. Valid operators are In, NotIn, Exists
- and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string values. If the
- operator is In or NotIn, the values array must be non-empty.
- If the operator is Exists or DoesNotExist, the values
- array must be empty. This array is replaced during a strategic
- merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -954,41 +576,26 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value} pairs. A single
- {key,value} in the matchLabels map is equivalent to an element
- of matchExpressions, whose key field is "key", the operator
- is "In", and the values array contains only "value". The requirements
- are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
alertmanagerConfigSelector:
- description: AlertmanagerConfigs to be selected for to merge and configure
- Alertmanager with.
+ description: AlertmanagerConfigs to be selected for to merge and configure Alertmanager with.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements.
- The requirements are ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a selector that
- contains values, a key, and an operator that relates the key
- and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the selector applies
- to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship to
- a set of values. Valid operators are In, NotIn, Exists
- and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string values. If the
- operator is In or NotIn, the values array must be non-empty.
- If the operator is Exists or DoesNotExist, the values
- array must be empty. This array is replaced during a strategic
- merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -1000,102 +607,72 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value} pairs. A single
- {key,value} in the matchLabels map is equivalent to an element
- of matchExpressions, whose key field is "key", the operator
- is "In", and the values array contains only "value". The requirements
- are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
alertmanagerConfiguration:
- description: 'EXPERIMENTAL: alertmanagerConfiguration specifies the
- configuration of Alertmanager. If defined, it takes precedence over
- the `configSecret` field. This field may change in future releases.'
+ description: 'EXPERIMENTAL: alertmanagerConfiguration specifies the configuration of Alertmanager. If defined, it takes precedence over the `configSecret` field. This field may change in future releases.'
properties:
global:
- description: Defines the global parameters of the Alertmanager
- configuration.
+ description: Defines the global parameters of the Alertmanager configuration.
properties:
httpConfig:
description: HTTP client configuration.
properties:
authorization:
- description: Authorization header configuration for the
- client. This is mutually exclusive with BasicAuth and
- is only available starting from Alertmanager v0.22+.
+ description: Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
properties:
credentials:
- description: The secret's key that contains the credentials
- of the request
+ description: The secret's key that contains the credentials of the request
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its
- key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
type:
- description: Set the authentication type. Defaults
- to Bearer, Basic will cause an error
+ description: Set the authentication type. Defaults to Bearer, Basic will cause an error
type: string
type: object
basicAuth:
- description: BasicAuth for the client. This is mutually
- exclusive with Authorization. If both are defined, BasicAuth
- takes precedence.
+ description: BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
properties:
password:
- description: The secret in the service monitor namespace
- that contains the password for authentication.
+ description: The secret in the service monitor namespace that contains the password for authentication.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its
- key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
username:
- description: The secret in the service monitor namespace
- that contains the username for authentication.
+ description: The secret in the service monitor namespace that contains the username for authentication.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its
- key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -1103,78 +680,57 @@ spec:
x-kubernetes-map-type: atomic
type: object
bearerTokenSecret:
- description: The secret's key that contains the bearer
- token to be used by the client for authentication. The
- secret needs to be in the same namespace as the Alertmanager
- object and accessible by the Prometheus Operator.
+ description: The secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the Alertmanager object and accessible by the Prometheus Operator.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
followRedirects:
- description: FollowRedirects specifies whether the client
- should follow HTTP 3xx redirects.
+ description: FollowRedirects specifies whether the client should follow HTTP 3xx redirects.
type: boolean
oauth2:
- description: OAuth2 client credentials used to fetch a
- token for the targets.
+ description: OAuth2 client credentials used to fetch a token for the targets.
properties:
clientId:
- description: The secret or configmap containing the
- OAuth2 client id
+ description: The secret or configmap containing the OAuth2 client id
properties:
configMap:
- description: ConfigMap containing data to use
- for the targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap
- or its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
secret:
- description: Secret containing data to use for
- the targets.
+ description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -1182,22 +738,16 @@ spec:
x-kubernetes-map-type: atomic
type: object
clientSecret:
- description: The secret containing the OAuth2 client
- secret
+ description: The secret containing the OAuth2 client secret
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its
- key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -1229,47 +779,35 @@ spec:
description: TLS configuration for the client.
properties:
ca:
- description: Certificate authority used when verifying
- server certificates.
+ description: Certificate authority used when verifying server certificates.
properties:
configMap:
- description: ConfigMap containing data to use
- for the targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap
- or its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
secret:
- description: Secret containing data to use for
- the targets.
+ description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -1277,47 +815,35 @@ spec:
x-kubernetes-map-type: atomic
type: object
cert:
- description: Client certificate to present when doing
- client-authentication.
+ description: Client certificate to present when doing client-authentication.
properties:
configMap:
- description: ConfigMap containing data to use
- for the targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap
- or its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
secret:
- description: Secret containing data to use for
- the targets.
+ description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or
- its key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -1328,22 +854,16 @@ spec:
description: Disable target certificate validation.
type: boolean
keySecret:
- description: Secret containing the client key file
- for the targets.
+ description: Secret containing the client key file for the targets.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its
- key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -1355,27 +875,20 @@ spec:
type: object
type: object
resolveTimeout:
- description: ResolveTimeout is the default value used by alertmanager
- if the alert does not include EndsAt, after this time passes
- it can declare the alert as resolved if it has not been
- updated. This has no impact on alerts from Prometheus, as
- they always include EndsAt.
+ description: ResolveTimeout is the default value used by alertmanager if the alert does not include EndsAt, after this time passes it can declare the alert as resolved if it has not been updated. This has no impact on alerts from Prometheus, as they always include EndsAt.
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
slackApiUrl:
description: The default Slack API URL.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -1383,18 +896,13 @@ spec:
x-kubernetes-map-type: atomic
type: object
name:
- description: The name of the AlertmanagerConfig resource which
- is used to generate the Alertmanager configuration. It must
- be defined in the same namespace as the Alertmanager object.
- The operator will not enforce a `namespace` label for routes
- and inhibition rules.
+ description: The name of the AlertmanagerConfig resource which is used to generate the Alertmanager configuration. It must be defined in the same namespace as the Alertmanager object. The operator will not enforce a `namespace` label for routes and inhibition rules.
minLength: 1
type: string
templates:
description: Custom notification templates.
items:
- description: SecretOrConfigMap allows to specify data as a Secret
- or ConfigMap. Fields are mutually exclusive.
+ description: SecretOrConfigMap allows to specify data as a Secret or ConfigMap. Fields are mutually exclusive.
properties:
configMap:
description: ConfigMap containing data to use for the targets.
@@ -1403,12 +911,10 @@ spec:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its key
- must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
@@ -1418,16 +924,13 @@ spec:
description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -1437,13 +940,10 @@ spec:
type: array
type: object
baseImage:
- description: 'Base image that is used to deploy pods, without tag.
- Deprecated: use ''image'' instead'
+ description: 'Base image that is used to deploy pods, without tag. Deprecated: use ''image'' instead'
type: string
clusterAdvertiseAddress:
- description: 'ClusterAdvertiseAddress is the explicit address to advertise
- in cluster. Needs to be provided for non RFC1918 [1] (public) addresses.
- [1] RFC1918: https://tools.ietf.org/html/rfc1918'
+ description: 'ClusterAdvertiseAddress is the explicit address to advertise in cluster. Needs to be provided for non RFC1918 [1] (public) addresses. [1] RFC1918: https://tools.ietf.org/html/rfc1918'
type: string
clusterGossipInterval:
description: Interval between gossip attempts.
@@ -1458,93 +958,41 @@ spec:
pattern: ^(0|(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
configMaps:
- description: ConfigMaps is a list of ConfigMaps in the same namespace
- as the Alertmanager object, which shall be mounted into the Alertmanager
- Pods. Each ConfigMap is added to the StatefulSet definition as a
- volume named `configmap-<configmap-name>`. The ConfigMaps are mounted
- into `/etc/alertmanager/configmaps/<configmap-name>` in the 'alertmanager'
- container.
+ description: ConfigMaps is a list of ConfigMaps in the same namespace as the Alertmanager object, which shall be mounted into the Alertmanager Pods. Each ConfigMap is added to the StatefulSet definition as a volume named `configmap-<configmap-name>`. The ConfigMaps are mounted into `/etc/alertmanager/configmaps/<configmap-name>` in the 'alertmanager' container.
items:
type: string
type: array
configSecret:
- description: "ConfigSecret is the name of a Kubernetes Secret in the
- same namespace as the Alertmanager object, which contains the configuration
- for this Alertmanager instance. If empty, it defaults to `alertmanager-<alertmanager-name>`.
- \n The Alertmanager configuration should be available under the
- `alertmanager.yaml` key. Additional keys from the original secret
- are copied to the generated secret and mounted into the `/etc/alertmanager/config`
- directory in the `alertmanager` container. \n If either the secret
- or the `alertmanager.yaml` key is missing, the operator provisions
- a minimal Alertmanager configuration with one empty receiver (effectively
- dropping alert notifications)."
+ description: "ConfigSecret is the name of a Kubernetes Secret in the same namespace as the Alertmanager object, which contains the configuration for this Alertmanager instance. If empty, it defaults to `alertmanager-<alertmanager-name>`. \n The Alertmanager configuration should be available under the `alertmanager.yaml` key. Additional keys from the original secret are copied to the generated secret and mounted into the `/etc/alertmanager/config` directory in the `alertmanager` container. \n If either the secret or the `alertmanager.yaml` key is missing, the operator provisions a minimal Alertmanager configuration with one empty receiver (effectively dropping alert notifications)."
type: string
containers:
- description: 'Containers allows injecting additional containers. This
- is meant to allow adding an authentication proxy to an Alertmanager
- pod. Containers described here modify an operator generated container
- if they share the same name and modifications are done via a strategic
- merge patch. The current container names are: `alertmanager` and
- `config-reloader`. Overriding containers is entirely outside the
- scope of what the maintainers will support and by doing so, you
- accept that this behaviour may break at any time without notice.'
+ description: 'Containers allows injecting additional containers. This is meant to allow adding an authentication proxy to an Alertmanager pod. Containers described here modify an operator generated container if they share the same name and modifications are done via a strategic merge patch. The current container names are: `alertmanager` and `config-reloader`. Overriding containers is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice.'
items:
- description: A single application container that you want to run
- within a pod.
+ description: A single application container that you want to run within a pod.
properties:
args:
- description: 'Arguments to the entrypoint. The container image''s
- CMD is used if this is not provided. Variable references $(VAR_NAME)
- are expanded using the container''s environment. If a variable
- cannot be resolved, the reference in the input string will
- be unchanged. Double $$ are reduced to a single $, which allows
- for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references
- will never be expanded, regardless of whether the variable
- exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
+ description: 'Arguments to the entrypoint. The container image''s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container''s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
command:
- description: 'Entrypoint array. Not executed within a shell.
- The container image''s ENTRYPOINT is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container''s
- environment. If a variable cannot be resolved, the reference
- in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax:
- i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
- Escaped references will never be expanded, regardless of whether
- the variable exists or not. Cannot be updated. More info:
- https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
+ description: 'Entrypoint array. Not executed within a shell. The container image''s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container''s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
env:
- description: List of environment variables to set in the container.
- Cannot be updated.
+ description: List of environment variables to set in the container. Cannot be updated.
items:
- description: EnvVar represents an environment variable present
- in a Container.
+ description: EnvVar represents an environment variable present in a Container.
properties:
name:
- description: Name of the environment variable. Must be
- a C_IDENTIFIER.
+ description: Name of the environment variable. Must be a C_IDENTIFIER.
type: string
value:
- description: 'Variable references $(VAR_NAME) are expanded
- using the previously defined environment variables in
- the container and any service environment variables.
- If a variable cannot be resolved, the reference in the
- input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME)
- syntax: i.e. "$$(VAR_NAME)" will produce the string
- literal "$(VAR_NAME)". Escaped references will never
- be expanded, regardless of whether the variable exists
- or not. Defaults to "".'
+ description: 'Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".'
type: string
valueFrom:
- description: Source for the environment variable's value.
- Cannot be used if value is not empty.
+ description: Source for the environment variable's value. Cannot be used if value is not empty.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -1553,55 +1001,39 @@ spec:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or
- its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
fieldRef:
- description: 'Selects a field of the pod: supports
- metadata.name, metadata.namespace, `metadata.labels[''<KEY>'']`,
- `metadata.annotations[''<KEY>'']`, spec.nodeName,
- spec.serviceAccountName, status.hostIP, status.podIP,
- status.podIPs.'
+ description: 'Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels[''<KEY>'']`, `metadata.annotations[''<KEY>'']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.'
properties:
apiVersion:
- description: Version of the schema the FieldPath
- is written in terms of, defaults to "v1".
+ description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
type: string
fieldPath:
- description: Path of the field to select in the
- specified API version.
+ description: Path of the field to select in the specified API version.
type: string
required:
- fieldPath
type: object
x-kubernetes-map-type: atomic
resourceFieldRef:
- description: 'Selects a resource of the container:
- only resources limits and requests (limits.cpu,
- limits.memory, limits.ephemeral-storage, requests.cpu,
- requests.memory and requests.ephemeral-storage)
- are currently supported.'
+ description: 'Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.'
properties:
containerName:
- description: 'Container name: required for volumes,
- optional for env vars'
+ description: 'Container name: required for volumes, optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format of the
- exposed resources, defaults to "1"
+ description: Specifies the output format of the exposed resources, defaults to "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
@@ -1612,22 +1044,16 @@ spec:
type: object
x-kubernetes-map-type: atomic
secretKeyRef:
- description: Selects a key of a secret in the pod's
- namespace
+ description: Selects a key of a secret in the pod's namespace
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its
- key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -1639,42 +1065,29 @@ spec:
type: object
type: array
envFrom:
- description: List of sources to populate environment variables
- in the container. The keys defined within a source must be
- a C_IDENTIFIER. All invalid keys will be reported as an event
- when the container is starting. When a key exists in multiple
- sources, the value associated with the last source will take
- precedence. Values defined by an Env with a duplicate key
- will take precedence. Cannot be updated.
+ description: List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
items:
- description: EnvFromSource represents the source of a set
- of ConfigMaps
+ description: EnvFromSource represents the source of a set of ConfigMaps
properties:
configMapRef:
description: The ConfigMap to select from
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap must be
- defined
+ description: Specify whether the ConfigMap must be defined
type: boolean
type: object
x-kubernetes-map-type: atomic
prefix:
- description: An optional identifier to prepend to each
- key in the ConfigMap. Must be a C_IDENTIFIER.
+ description: An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
type: string
secretRef:
description: The Secret to select from
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
description: Specify whether the Secret must be defined
@@ -1684,40 +1097,22 @@ spec:
type: object
type: array
image:
- description: 'Container image name. More info: https://kubernetes.io/docs/concepts/containers/images
- This field is optional to allow higher level config management
- to default or override container images in workload controllers
- like Deployments and StatefulSets.'
+ description: 'Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.'
type: string
imagePullPolicy:
- description: 'Image pull policy. One of Always, Never, IfNotPresent.
- Defaults to Always if :latest tag is specified, or IfNotPresent
- otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
+ description: 'Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
- description: Actions that the management system should take
- in response to container lifecycle events. Cannot be updated.
+ description: Actions that the management system should take in response to container lifecycle events. Cannot be updated.
properties:
postStart:
- description: 'PostStart is called immediately after a container
- is created. If the handler fails, the container is terminated
- and restarted according to its restart policy. Other management
- of the container blocks until the hook completes. More
- info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
+ description: 'PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: Command is the command line to execute
- inside the container, the working directory for
- the command is root ('/') in the container's
- filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions
- ('|', etc) won't work. To use a shell, you need
- to explicitly call out to that shell. Exit status
- of 0 is treated as live/healthy and non-zero is
- unhealthy.
+ description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
@@ -1726,16 +1121,12 @@ spec:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to
- the pod IP. You probably want to set "Host" in
- httpHeaders instead.
+ description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request.
- HTTP allows repeated headers.
+ description: Custom headers to set in the request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header
- to be used in HTTP probes
+ description: HTTPHeader describes a custom header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -1755,65 +1146,38 @@ spec:
anyOf:
- type: integer
- type: string
- description: Name or number of the port to access
- on the container. Number must be in the range
- 1 to 65535. Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the
- host. Defaults to HTTP.
+ description: Scheme to use for connecting to the host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: Deprecated. TCPSocket is NOT supported
- as a LifecycleHandler and kept for the backward compatibility.
- There are no validation of this field and lifecycle
- hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.
properties:
host:
- description: 'Optional: Host name to connect to,
- defaults to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: Number or name of the port to access
- on the container. Number must be in the range
- 1 to 65535. Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
preStop:
- description: 'PreStop is called immediately before a container
- is terminated due to an API request or management event
- such as liveness/startup probe failure, preemption, resource
- contention, etc. The handler is not called if the container
- crashes or exits. The Pod''s termination grace period
- countdown begins before the PreStop hook is executed.
- Regardless of the outcome of the handler, the container
- will eventually terminate within the Pod''s termination
- grace period (unless delayed by finalizers). Other management
- of the container blocks until the hook completes or until
- the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
+ description: 'PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod''s termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod''s termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: Command is the command line to execute
- inside the container, the working directory for
- the command is root ('/') in the container's
- filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions
- ('|', etc) won't work. To use a shell, you need
- to explicitly call out to that shell. Exit status
- of 0 is treated as live/healthy and non-zero is
- unhealthy.
+ description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
@@ -1822,16 +1186,12 @@ spec:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to
- the pod IP. You probably want to set "Host" in
- httpHeaders instead.
+ description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request.
- HTTP allows repeated headers.
+ description: Custom headers to set in the request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header
- to be used in HTTP probes
+ description: HTTPHeader describes a custom header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -1851,34 +1211,25 @@ spec:
anyOf:
- type: integer
- type: string
- description: Name or number of the port to access
- on the container. Number must be in the range
- 1 to 65535. Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the
- host. Defaults to HTTP.
+ description: Scheme to use for connecting to the host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: Deprecated. TCPSocket is NOT supported
- as a LifecycleHandler and kept for the backward compatibility.
- There are no validation of this field and lifecycle
- hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.
properties:
host:
- description: 'Optional: Host name to connect to,
- defaults to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: Number or name of the port to access
- on the container. Number must be in the range
- 1 to 65535. Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
@@ -1886,47 +1237,30 @@ spec:
type: object
type: object
livenessProbe:
- description: 'Periodic probe of container liveness. Container
- will be restarted if the probe fails. Cannot be updated. More
- info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: Command is the command line to execute
- inside the container, the working directory for the
- command is root ('/') in the container's filesystem.
- The command is simply exec'd, it is not run inside
- a shell, so traditional shell instructions ('|', etc)
- won't work. To use a shell, you need to explicitly
- call out to that shell. Exit status of 0 is treated
- as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe
- to be considered failed after having succeeded. Defaults
- to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
format: int32
type: integer
grpc:
- description: GRPC specifies an action involving a GRPC port.
- This is a beta field and requires enabling GRPCContainerProbe
- feature gate.
+ description: GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.
properties:
port:
- description: Port number of the gRPC service. Number
- must be in the range 1 to 65535.
+ description: Port number of the gRPC service. Number must be in the range 1 to 65535.
format: int32
type: integer
service:
- description: "Service is the name of the service to
- place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
- \n If this is not specified, the default behavior
- is defined by gRPC."
+ description: "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). \n If this is not specified, the default behavior is defined by gRPC."
type: string
required:
- port
@@ -1935,16 +1269,12 @@ spec:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to the
- pod IP. You probably want to set "Host" in httpHeaders
- instead.
+ description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP
- allows repeated headers.
+ description: Custom headers to set in the request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header
- to be used in HTTP probes
+ description: HTTPHeader describes a custom header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -1964,120 +1294,75 @@ spec:
anyOf:
- type: integer
- type: string
- description: Name or number of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: 'Number of seconds after the container has
- started before liveness probes are initiated. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
format: int32
type: integer
successThreshold:
- description: Minimum consecutive successes for the probe
- to be considered successful after having failed. Defaults
- to 1. Must be 1 for liveness and startup. Minimum value
- is 1.
+ description: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
- description: TCPSocket specifies an action involving a TCP
- port.
+ description: TCPSocket specifies an action involving a TCP port.
properties:
host:
- description: 'Optional: Host name to connect to, defaults
- to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: Number or name of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: Optional duration in seconds the pod needs
- to terminate gracefully upon probe failure. The grace
- period is the duration in seconds after the processes
- running in the pod are sent a termination signal and the
- time when the processes are forcibly halted with a kill
- signal. Set this value longer than the expected cleanup
- time for your process. If this value is nil, the pod's
- terminationGracePeriodSeconds will be used. Otherwise,
- this value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates
- stop immediately via the kill signal (no opportunity to
- shut down). This is a beta field and requires enabling
- ProbeTerminationGracePeriod feature gate. Minimum value
- is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: 'Number of seconds after which the probe times
- out. Defaults to 1 second. Minimum value is 1. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
name:
- description: Name of the container specified as a DNS_LABEL.
- Each container in a pod must have a unique name (DNS_LABEL).
- Cannot be updated.
+ description: Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
type: string
ports:
- description: List of ports to expose from the container. Not
- specifying a port here DOES NOT prevent that port from being
- exposed. Any port which is listening on the default "0.0.0.0"
- address inside a container will be accessible from the network.
- Modifying this array with strategic merge patch may corrupt
- the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255.
- Cannot be updated.
+ description: List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.
items:
- description: ContainerPort represents a network port in a
- single container.
+ description: ContainerPort represents a network port in a single container.
properties:
containerPort:
- description: Number of port to expose on the pod's IP
- address. This must be a valid port number, 0 < x < 65536.
+ description: Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
format: int32
type: integer
hostIP:
description: What host IP to bind the external port to.
type: string
hostPort:
- description: Number of port to expose on the host. If
- specified, this must be a valid port number, 0 < x <
- 65536. If HostNetwork is specified, this must match
- ContainerPort. Most containers do not need this.
+ description: Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.
format: int32
type: integer
name:
- description: If specified, this must be an IANA_SVC_NAME
- and unique within the pod. Each named port in a pod
- must have a unique name. Name for the port that can
- be referred to by services.
+ description: If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
type: string
protocol:
default: TCP
- description: Protocol for port. Must be UDP, TCP, or SCTP.
- Defaults to "TCP".
+ description: Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".
type: string
required:
- containerPort
@@ -2088,47 +1373,30 @@ spec:
- protocol
x-kubernetes-list-type: map
readinessProbe:
- description: 'Periodic probe of container service readiness.
- Container will be removed from service endpoints if the probe
- fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: Command is the command line to execute
- inside the container, the working directory for the
- command is root ('/') in the container's filesystem.
- The command is simply exec'd, it is not run inside
- a shell, so traditional shell instructions ('|', etc)
- won't work. To use a shell, you need to explicitly
- call out to that shell. Exit status of 0 is treated
- as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe
- to be considered failed after having succeeded. Defaults
- to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
format: int32
type: integer
grpc:
- description: GRPC specifies an action involving a GRPC port.
- This is a beta field and requires enabling GRPCContainerProbe
- feature gate.
+ description: GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.
properties:
port:
- description: Port number of the gRPC service. Number
- must be in the range 1 to 65535.
+ description: Port number of the gRPC service. Number must be in the range 1 to 65535.
format: int32
type: integer
service:
- description: "Service is the name of the service to
- place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
- \n If this is not specified, the default behavior
- is defined by gRPC."
+ description: "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). \n If this is not specified, the default behavior is defined by gRPC."
type: string
required:
- port
@@ -2137,16 +1405,12 @@ spec:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to the
- pod IP. You probably want to set "Host" in httpHeaders
- instead.
+ description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP
- allows repeated headers.
+ description: Custom headers to set in the request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header
- to be used in HTTP probes
+ description: HTTPHeader describes a custom header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -2166,95 +1430,60 @@ spec:
anyOf:
- type: integer
- type: string
- description: Name or number of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: 'Number of seconds after the container has
- started before liveness probes are initiated. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
format: int32
type: integer
successThreshold:
- description: Minimum consecutive successes for the probe
- to be considered successful after having failed. Defaults
- to 1. Must be 1 for liveness and startup. Minimum value
- is 1.
+ description: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
- description: TCPSocket specifies an action involving a TCP
- port.
+ description: TCPSocket specifies an action involving a TCP port.
properties:
host:
- description: 'Optional: Host name to connect to, defaults
- to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: Number or name of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: Optional duration in seconds the pod needs
- to terminate gracefully upon probe failure. The grace
- period is the duration in seconds after the processes
- running in the pod are sent a termination signal and the
- time when the processes are forcibly halted with a kill
- signal. Set this value longer than the expected cleanup
- time for your process. If this value is nil, the pod's
- terminationGracePeriodSeconds will be used. Otherwise,
- this value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates
- stop immediately via the kill signal (no opportunity to
- shut down). This is a beta field and requires enabling
- ProbeTerminationGracePeriod feature gate. Minimum value
- is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: 'Number of seconds after which the probe times
- out. Defaults to 1 second. Minimum value is 1. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
resources:
- description: 'Compute Resources required by this container.
- Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
properties:
claims:
- description: "Claims lists the names of resources, defined
- in spec.resourceClaims, that are used by this container.
- \n This is an alpha field and requires enabling the DynamicResourceAllocation
- feature gate. \n This field is immutable."
+ description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable."
items:
description: ResourceClaim references one entry in PodSpec.ResourceClaims.
properties:
name:
- description: Name must match the name of one entry
- in pod.spec.resourceClaims of the Pod where this
- field is used. It makes that resource available
- inside a container.
+ description: Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
type: string
required:
- name
@@ -2270,8 +1499,7 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute
- resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -2280,236 +1508,121 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Requests describes the minimum amount of compute
- resources required. If Requests is omitted for a container,
- it defaults to Limits if that is explicitly specified,
- otherwise to an implementation-defined value. More info:
- https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
securityContext:
- description: 'SecurityContext defines the security options the
- container should be run with. If set, the fields of SecurityContext
- override the equivalent fields of PodSecurityContext. More
- info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
+ description: 'SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
properties:
allowPrivilegeEscalation:
- description: 'AllowPrivilegeEscalation controls whether
- a process can gain more privileges than its parent process.
- This bool directly controls if the no_new_privs flag will
- be set on the container process. AllowPrivilegeEscalation
- is true always when the container is: 1) run as Privileged
- 2) has CAP_SYS_ADMIN Note that this field cannot be set
- when spec.os.name is windows.'
+ description: 'AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.'
type: boolean
capabilities:
- description: The capabilities to add/drop when running containers.
- Defaults to the default set of capabilities granted by
- the container runtime. Note that this field cannot be
- set when spec.os.name is windows.
+ description: The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.
properties:
add:
description: Added capabilities
items:
- description: Capability represent POSIX capabilities
- type
+ description: Capability represent POSIX capabilities type
type: string
type: array
drop:
description: Removed capabilities
items:
- description: Capability represent POSIX capabilities
- type
+ description: Capability represent POSIX capabilities type
type: string
type: array
type: object
privileged:
- description: Run container in privileged mode. Processes
- in privileged containers are essentially equivalent to
- root on the host. Defaults to false. Note that this field
- cannot be set when spec.os.name is windows.
+ description: Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.
type: boolean
procMount:
- description: procMount denotes the type of proc mount to
- use for the containers. The default is DefaultProcMount
- which uses the container runtime defaults for readonly
- paths and masked paths. This requires the ProcMountType
- feature flag to be enabled. Note that this field cannot
- be set when spec.os.name is windows.
+ description: procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.
type: string
readOnlyRootFilesystem:
- description: Whether this container has a read-only root
- filesystem. Default is false. Note that this field cannot
- be set when spec.os.name is windows.
+ description: Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.
type: boolean
runAsGroup:
- description: The GID to run the entrypoint of the container
- process. Uses runtime default if unset. May also be set
- in PodSecurityContext. If set in both SecurityContext
- and PodSecurityContext, the value specified in SecurityContext
- takes precedence. Note that this field cannot be set when
- spec.os.name is windows.
+ description: The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
format: int64
type: integer
runAsNonRoot:
- description: Indicates that the container must run as a
- non-root user. If true, the Kubelet will validate the
- image at runtime to ensure that it does not run as UID
- 0 (root) and fail to start the container if it does. If
- unset or false, no such validation will be performed.
- May also be set in PodSecurityContext. If set in both
- SecurityContext and PodSecurityContext, the value specified
- in SecurityContext takes precedence.
+ description: Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
type: boolean
runAsUser:
- description: The UID to run the entrypoint of the container
- process. Defaults to user specified in image metadata
- if unspecified. May also be set in PodSecurityContext. If
- set in both SecurityContext and PodSecurityContext, the
- value specified in SecurityContext takes precedence. Note
- that this field cannot be set when spec.os.name is windows.
+ description: The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
format: int64
type: integer
seLinuxOptions:
- description: The SELinux context to be applied to the container.
- If unspecified, the container runtime will allocate a
- random SELinux context for each container. May also be
- set in PodSecurityContext. If set in both SecurityContext
- and PodSecurityContext, the value specified in SecurityContext
- takes precedence. Note that this field cannot be set when
- spec.os.name is windows.
+ description: The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
properties:
level:
- description: Level is SELinux level label that applies
- to the container.
+ description: Level is SELinux level label that applies to the container.
type: string
role:
- description: Role is a SELinux role label that applies
- to the container.
+ description: Role is a SELinux role label that applies to the container.
type: string
type:
- description: Type is a SELinux type label that applies
- to the container.
+ description: Type is a SELinux type label that applies to the container.
type: string
user:
- description: User is a SELinux user label that applies
- to the container.
+ description: User is a SELinux user label that applies to the container.
type: string
type: object
seccompProfile:
- description: The seccomp options to use by this container.
- If seccomp options are provided at both the pod & container
- level, the container options override the pod options.
- Note that this field cannot be set when spec.os.name is
- windows.
+ description: The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
properties:
localhostProfile:
- description: localhostProfile indicates a profile defined
- in a file on the node should be used. The profile
- must be preconfigured on the node to work. Must be
- a descending path, relative to the kubelet's configured
- seccomp profile location. Must only be set if type
- is "Localhost".
+ description: localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost".
type: string
type:
- description: "type indicates which kind of seccomp profile
- will be applied. Valid options are: \n Localhost -
- a profile defined in a file on the node should be
- used. RuntimeDefault - the container runtime default
- profile should be used. Unconfined - no profile should
- be applied."
+ description: "type indicates which kind of seccomp profile will be applied. Valid options are: \n Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied."
type: string
required:
- type
type: object
windowsOptions:
- description: The Windows specific settings applied to all
- containers. If unspecified, the options from the PodSecurityContext
- will be used. If set in both SecurityContext and PodSecurityContext,
- the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is
- linux.
+ description: The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
properties:
gmsaCredentialSpec:
- description: GMSACredentialSpec is where the GMSA admission
- webhook (https://github.com/kubernetes-sigs/windows-gmsa)
- inlines the contents of the GMSA credential spec named
- by the GMSACredentialSpecName field.
+ description: GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.
type: string
gmsaCredentialSpecName:
- description: GMSACredentialSpecName is the name of the
- GMSA credential spec to use.
+ description: GMSACredentialSpecName is the name of the GMSA credential spec to use.
type: string
hostProcess:
- description: HostProcess determines if a container should
- be run as a 'Host Process' container. This field is
- alpha-level and will only be honored by components
- that enable the WindowsHostProcessContainers feature
- flag. Setting this field without the feature flag
- will result in errors when validating the Pod. All
- of a Pod's containers must have the same effective
- HostProcess value (it is not allowed to have a mix
- of HostProcess containers and non-HostProcess containers). In
- addition, if HostProcess is true then HostNetwork
- must also be set to true.
+ description: HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.
type: boolean
runAsUserName:
- description: The UserName in Windows to run the entrypoint
- of the container process. Defaults to the user specified
- in image metadata if unspecified. May also be set
- in PodSecurityContext. If set in both SecurityContext
- and PodSecurityContext, the value specified in SecurityContext
- takes precedence.
+ description: The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
type: string
type: object
type: object
startupProbe:
- description: 'StartupProbe indicates that the Pod has successfully
- initialized. If specified, no other probes are executed until
- this completes successfully. If this probe fails, the Pod
- will be restarted, just as if the livenessProbe failed. This
- can be used to provide different probe parameters at the beginning
- of a Pod''s lifecycle, when it might take a long time to load
- data or warm a cache, than during steady-state operation.
- This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod''s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: Command is the command line to execute
- inside the container, the working directory for the
- command is root ('/') in the container's filesystem.
- The command is simply exec'd, it is not run inside
- a shell, so traditional shell instructions ('|', etc)
- won't work. To use a shell, you need to explicitly
- call out to that shell. Exit status of 0 is treated
- as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe
- to be considered failed after having succeeded. Defaults
- to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
format: int32
type: integer
grpc:
- description: GRPC specifies an action involving a GRPC port.
- This is a beta field and requires enabling GRPCContainerProbe
- feature gate.
+ description: GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.
properties:
port:
- description: Port number of the gRPC service. Number
- must be in the range 1 to 65535.
+ description: Port number of the gRPC service. Number must be in the range 1 to 65535.
format: int32
type: integer
service:
- description: "Service is the name of the service to
- place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
- \n If this is not specified, the default behavior
- is defined by gRPC."
+ description: "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). \n If this is not specified, the default behavior is defined by gRPC."
type: string
required:
- port
@@ -2518,16 +1631,12 @@ spec:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to the
- pod IP. You probably want to set "Host" in httpHeaders
- instead.
+ description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP
- allows repeated headers.
+ description: Custom headers to set in the request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header
- to be used in HTTP probes
+ description: HTTPHeader describes a custom header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -2547,133 +1656,75 @@ spec:
anyOf:
- type: integer
- type: string
- description: Name or number of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: 'Number of seconds after the container has
- started before liveness probes are initiated. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
format: int32
type: integer
successThreshold:
- description: Minimum consecutive successes for the probe
- to be considered successful after having failed. Defaults
- to 1. Must be 1 for liveness and startup. Minimum value
- is 1.
+ description: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
- description: TCPSocket specifies an action involving a TCP
- port.
+ description: TCPSocket specifies an action involving a TCP port.
properties:
host:
- description: 'Optional: Host name to connect to, defaults
- to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: Number or name of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: Optional duration in seconds the pod needs
- to terminate gracefully upon probe failure. The grace
- period is the duration in seconds after the processes
- running in the pod are sent a termination signal and the
- time when the processes are forcibly halted with a kill
- signal. Set this value longer than the expected cleanup
- time for your process. If this value is nil, the pod's
- terminationGracePeriodSeconds will be used. Otherwise,
- this value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates
- stop immediately via the kill signal (no opportunity to
- shut down). This is a beta field and requires enabling
- ProbeTerminationGracePeriod feature gate. Minimum value
- is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: 'Number of seconds after which the probe times
- out. Defaults to 1 second. Minimum value is 1. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
stdin:
- description: Whether this container should allocate a buffer
- for stdin in the container runtime. If this is not set, reads
- from stdin in the container will always result in EOF. Default
- is false.
+ description: Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
type: boolean
stdinOnce:
- description: Whether the container runtime should close the
- stdin channel after it has been opened by a single attach.
- When stdin is true the stdin stream will remain open across
- multiple attach sessions. If stdinOnce is set to true, stdin
- is opened on container start, is empty until the first client
- attaches to stdin, and then remains open and accepts data
- until the client disconnects, at which time stdin is closed
- and remains closed until the container is restarted. If this
- flag is false, a container processes that reads from stdin
- will never receive an EOF. Default is false
+ description: Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
type: boolean
terminationMessagePath:
- description: 'Optional: Path at which the file to which the
- container''s termination message will be written is mounted
- into the container''s filesystem. Message written is intended
- to be brief final status, such as an assertion failure message.
- Will be truncated by the node if greater than 4096 bytes.
- The total message length across all containers will be limited
- to 12kb. Defaults to /dev/termination-log. Cannot be updated.'
+ description: 'Optional: Path at which the file to which the container''s termination message will be written is mounted into the container''s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.'
type: string
terminationMessagePolicy:
- description: Indicate how the termination message should be
- populated. File will use the contents of terminationMessagePath
- to populate the container status message on both success and
- failure. FallbackToLogsOnError will use the last chunk of
- container log output if the termination message file is empty
- and the container exited with an error. The log output is
- limited to 2048 bytes or 80 lines, whichever is smaller. Defaults
- to File. Cannot be updated.
+ description: Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
type: string
tty:
- description: Whether this container should allocate a TTY for
- itself, also requires 'stdin' to be true. Default is false.
+ description: Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
type: boolean
volumeDevices:
- description: volumeDevices is the list of block devices to be
- used by the container.
+ description: volumeDevices is the list of block devices to be used by the container.
items:
- description: volumeDevice describes a mapping of a raw block
- device within a container.
+ description: volumeDevice describes a mapping of a raw block device within a container.
properties:
devicePath:
- description: devicePath is the path inside of the container
- that the device will be mapped to.
+ description: devicePath is the path inside of the container that the device will be mapped to.
type: string
name:
- description: name must match the name of a persistentVolumeClaim
- in the pod
+ description: name must match the name of a persistentVolumeClaim in the pod
type: string
required:
- devicePath
@@ -2681,40 +1732,27 @@ spec:
type: object
type: array
volumeMounts:
- description: Pod volumes to mount into the container's filesystem.
- Cannot be updated.
+ description: Pod volumes to mount into the container's filesystem. Cannot be updated.
items:
- description: VolumeMount describes a mounting of a Volume
- within a container.
+ description: VolumeMount describes a mounting of a Volume within a container.
properties:
mountPath:
- description: Path within the container at which the volume
- should be mounted. Must not contain ':'.
+ description: Path within the container at which the volume should be mounted. Must not contain ':'.
type: string
mountPropagation:
- description: mountPropagation determines how mounts are
- propagated from the host to container and the other
- way around. When not set, MountPropagationNone is used.
- This field is beta in 1.10.
+ description: mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.
type: string
name:
description: This must match the Name of a Volume.
type: string
readOnly:
- description: Mounted read-only if true, read-write otherwise
- (false or unspecified). Defaults to false.
+ description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
type: boolean
subPath:
- description: Path within the volume from which the container's
- volume should be mounted. Defaults to "" (volume's root).
+ description: Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
type: string
subPathExpr:
- description: Expanded path within the volume from which
- the container's volume should be mounted. Behaves similarly
- to SubPath but environment variable references $(VAR_NAME)
- are expanded using the container's environment. Defaults
- to "" (volume's root). SubPathExpr and SubPath are mutually
- exclusive.
+ description: Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.
type: string
required:
- mountPath
@@ -2722,30 +1760,22 @@ spec:
type: object
type: array
workingDir:
- description: Container's working directory. If not specified,
- the container runtime's default will be used, which might
- be configured in the container image. Cannot be updated.
+ description: Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.
type: string
required:
- name
type: object
type: array
externalUrl:
- description: The external URL the Alertmanager instances will be available
- under. This is necessary to generate correct URLs. This is necessary
- if Alertmanager is not served from root of a DNS name.
+ description: The external URL the Alertmanager instances will be available under. This is necessary to generate correct URLs. This is necessary if Alertmanager is not served from root of a DNS name.
type: string
forceEnableClusterMode:
- description: ForceEnableClusterMode ensures Alertmanager does not
- deactivate the cluster mode when running with a single replica.
- Use case is e.g. spanning an Alertmanager cluster across Kubernetes
- clusters with a single replica in each.
+ description: ForceEnableClusterMode ensures Alertmanager does not deactivate the cluster mode when running with a single replica. Use case is e.g. spanning an Alertmanager cluster across Kubernetes clusters with a single replica in each.
type: boolean
hostAliases:
description: Pods' hostAliases configuration
items:
- description: HostAlias holds the mapping between IP and hostnames
- that will be injected as an entry in the pod's hosts file.
+ description: HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.
properties:
hostnames:
description: Hostnames for the above IP address.
@@ -2764,15 +1794,10 @@ spec:
- ip
x-kubernetes-list-type: map
image:
- description: Image if specified has precedence over baseImage, tag
- and sha combinations. Specifying the version is still necessary
- to ensure the Prometheus Operator knows what version of Alertmanager
- is being configured.
+ description: Image if specified has precedence over baseImage, tag and sha combinations. Specifying the version is still necessary to ensure the Prometheus Operator knows what version of Alertmanager is being configured.
type: string
imagePullPolicy:
- description: Image pull policy for the 'alertmanager', 'init-config-reloader'
- and 'config-reloader' containers. See https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy
- for more details.
+ description: Image pull policy for the 'alertmanager', 'init-config-reloader' and 'config-reloader' containers. See https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy for more details.
enum:
- ""
- Always
@@ -2780,89 +1805,44 @@ spec:
- IfNotPresent
type: string
imagePullSecrets:
- description: An optional list of references to secrets in the same
- namespace to use for pulling prometheus and alertmanager images
- from registries see http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod
+ description: An optional list of references to secrets in the same namespace to use for pulling prometheus and alertmanager images from registries see http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod
items:
- description: LocalObjectReference contains enough information to
- let you locate the referenced object inside the same namespace.
+ description: LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
x-kubernetes-map-type: atomic
type: array
initContainers:
- description: 'InitContainers allows adding initContainers to the pod
- definition. Those can be used to e.g. fetch secrets for injection
- into the Alertmanager configuration from external sources. Any errors
- during the execution of an initContainer will lead to a restart
- of the Pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
- InitContainers described here modify an operator generated init
- containers if they share the same name and modifications are done
- via a strategic merge patch. The current init container name is:
- `init-config-reloader`. Overriding init containers is entirely outside
- the scope of what the maintainers will support and by doing so,
- you accept that this behaviour may break at any time without notice.'
+ description: 'InitContainers allows adding initContainers to the pod definition. Those can be used to e.g. fetch secrets for injection into the Alertmanager configuration from external sources. Any errors during the execution of an initContainer will lead to a restart of the Pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ InitContainers described here modify an operator generated init containers if they share the same name and modifications are done via a strategic merge patch. The current init container name is: `init-config-reloader`. Overriding init containers is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice.'
items:
- description: A single application container that you want to run
- within a pod.
+ description: A single application container that you want to run within a pod.
properties:
args:
- description: 'Arguments to the entrypoint. The container image''s
- CMD is used if this is not provided. Variable references $(VAR_NAME)
- are expanded using the container''s environment. If a variable
- cannot be resolved, the reference in the input string will
- be unchanged. Double $$ are reduced to a single $, which allows
- for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references
- will never be expanded, regardless of whether the variable
- exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
+ description: 'Arguments to the entrypoint. The container image''s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container''s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
command:
- description: 'Entrypoint array. Not executed within a shell.
- The container image''s ENTRYPOINT is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container''s
- environment. If a variable cannot be resolved, the reference
- in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax:
- i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
- Escaped references will never be expanded, regardless of whether
- the variable exists or not. Cannot be updated. More info:
- https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
+ description: 'Entrypoint array. Not executed within a shell. The container image''s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container''s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
env:
- description: List of environment variables to set in the container.
- Cannot be updated.
+ description: List of environment variables to set in the container. Cannot be updated.
items:
- description: EnvVar represents an environment variable present
- in a Container.
+ description: EnvVar represents an environment variable present in a Container.
properties:
name:
- description: Name of the environment variable. Must be
- a C_IDENTIFIER.
+ description: Name of the environment variable. Must be a C_IDENTIFIER.
type: string
value:
- description: 'Variable references $(VAR_NAME) are expanded
- using the previously defined environment variables in
- the container and any service environment variables.
- If a variable cannot be resolved, the reference in the
- input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME)
- syntax: i.e. "$$(VAR_NAME)" will produce the string
- literal "$(VAR_NAME)". Escaped references will never
- be expanded, regardless of whether the variable exists
- or not. Defaults to "".'
+ description: 'Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".'
type: string
valueFrom:
- description: Source for the environment variable's value.
- Cannot be used if value is not empty.
+ description: Source for the environment variable's value. Cannot be used if value is not empty.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -2871,55 +1851,39 @@ spec:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or
- its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
fieldRef:
- description: 'Selects a field of the pod: supports
- metadata.name, metadata.namespace, `metadata.labels[''<KEY>'']`,
- `metadata.annotations[''<KEY>'']`, spec.nodeName,
- spec.serviceAccountName, status.hostIP, status.podIP,
- status.podIPs.'
+ description: 'Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels[''<KEY>'']`, `metadata.annotations[''<KEY>'']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.'
properties:
apiVersion:
- description: Version of the schema the FieldPath
- is written in terms of, defaults to "v1".
+ description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
type: string
fieldPath:
- description: Path of the field to select in the
- specified API version.
+ description: Path of the field to select in the specified API version.
type: string
required:
- fieldPath
type: object
x-kubernetes-map-type: atomic
resourceFieldRef:
- description: 'Selects a resource of the container:
- only resources limits and requests (limits.cpu,
- limits.memory, limits.ephemeral-storage, requests.cpu,
- requests.memory and requests.ephemeral-storage)
- are currently supported.'
+ description: 'Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.'
properties:
containerName:
- description: 'Container name: required for volumes,
- optional for env vars'
+ description: 'Container name: required for volumes, optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format of the
- exposed resources, defaults to "1"
+ description: Specifies the output format of the exposed resources, defaults to "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
@@ -2930,22 +1894,16 @@ spec:
type: object
x-kubernetes-map-type: atomic
secretKeyRef:
- description: Selects a key of a secret in the pod's
- namespace
+ description: Selects a key of a secret in the pod's namespace
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its
- key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -2957,42 +1915,29 @@ spec:
type: object
type: array
envFrom:
- description: List of sources to populate environment variables
- in the container. The keys defined within a source must be
- a C_IDENTIFIER. All invalid keys will be reported as an event
- when the container is starting. When a key exists in multiple
- sources, the value associated with the last source will take
- precedence. Values defined by an Env with a duplicate key
- will take precedence. Cannot be updated.
+ description: List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
items:
- description: EnvFromSource represents the source of a set
- of ConfigMaps
+ description: EnvFromSource represents the source of a set of ConfigMaps
properties:
configMapRef:
description: The ConfigMap to select from
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap must be
- defined
+ description: Specify whether the ConfigMap must be defined
type: boolean
type: object
x-kubernetes-map-type: atomic
prefix:
- description: An optional identifier to prepend to each
- key in the ConfigMap. Must be a C_IDENTIFIER.
+ description: An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
type: string
secretRef:
description: The Secret to select from
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
description: Specify whether the Secret must be defined
@@ -3002,40 +1947,22 @@ spec:
type: object
type: array
image:
- description: 'Container image name. More info: https://kubernetes.io/docs/concepts/containers/images
- This field is optional to allow higher level config management
- to default or override container images in workload controllers
- like Deployments and StatefulSets.'
+ description: 'Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.'
type: string
imagePullPolicy:
- description: 'Image pull policy. One of Always, Never, IfNotPresent.
- Defaults to Always if :latest tag is specified, or IfNotPresent
- otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
+ description: 'Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
- description: Actions that the management system should take
- in response to container lifecycle events. Cannot be updated.
+ description: Actions that the management system should take in response to container lifecycle events. Cannot be updated.
properties:
postStart:
- description: 'PostStart is called immediately after a container
- is created. If the handler fails, the container is terminated
- and restarted according to its restart policy. Other management
- of the container blocks until the hook completes. More
- info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
+ description: 'PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: Command is the command line to execute
- inside the container, the working directory for
- the command is root ('/') in the container's
- filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions
- ('|', etc) won't work. To use a shell, you need
- to explicitly call out to that shell. Exit status
- of 0 is treated as live/healthy and non-zero is
- unhealthy.
+ description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
@@ -3044,16 +1971,12 @@ spec:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to
- the pod IP. You probably want to set "Host" in
- httpHeaders instead.
+ description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request.
- HTTP allows repeated headers.
+ description: Custom headers to set in the request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header
- to be used in HTTP probes
+ description: HTTPHeader describes a custom header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -3073,65 +1996,38 @@ spec:
anyOf:
- type: integer
- type: string
- description: Name or number of the port to access
- on the container. Number must be in the range
- 1 to 65535. Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the
- host. Defaults to HTTP.
+ description: Scheme to use for connecting to the host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: Deprecated. TCPSocket is NOT supported
- as a LifecycleHandler and kept for the backward compatibility.
- There are no validation of this field and lifecycle
- hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.
properties:
host:
- description: 'Optional: Host name to connect to,
- defaults to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: Number or name of the port to access
- on the container. Number must be in the range
- 1 to 65535. Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
preStop:
- description: 'PreStop is called immediately before a container
- is terminated due to an API request or management event
- such as liveness/startup probe failure, preemption, resource
- contention, etc. The handler is not called if the container
- crashes or exits. The Pod''s termination grace period
- countdown begins before the PreStop hook is executed.
- Regardless of the outcome of the handler, the container
- will eventually terminate within the Pod''s termination
- grace period (unless delayed by finalizers). Other management
- of the container blocks until the hook completes or until
- the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
+ description: 'PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod''s termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod''s termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: Command is the command line to execute
- inside the container, the working directory for
- the command is root ('/') in the container's
- filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions
- ('|', etc) won't work. To use a shell, you need
- to explicitly call out to that shell. Exit status
- of 0 is treated as live/healthy and non-zero is
- unhealthy.
+ description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
@@ -3140,16 +2036,12 @@ spec:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to
- the pod IP. You probably want to set "Host" in
- httpHeaders instead.
+ description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request.
- HTTP allows repeated headers.
+ description: Custom headers to set in the request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header
- to be used in HTTP probes
+ description: HTTPHeader describes a custom header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -3169,34 +2061,25 @@ spec:
anyOf:
- type: integer
- type: string
- description: Name or number of the port to access
- on the container. Number must be in the range
- 1 to 65535. Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the
- host. Defaults to HTTP.
+ description: Scheme to use for connecting to the host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: Deprecated. TCPSocket is NOT supported
- as a LifecycleHandler and kept for the backward compatibility.
- There are no validation of this field and lifecycle
- hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.
properties:
host:
- description: 'Optional: Host name to connect to,
- defaults to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: Number or name of the port to access
- on the container. Number must be in the range
- 1 to 65535. Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
@@ -3204,47 +2087,30 @@ spec:
type: object
type: object
livenessProbe:
- description: 'Periodic probe of container liveness. Container
- will be restarted if the probe fails. Cannot be updated. More
- info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: Command is the command line to execute
- inside the container, the working directory for the
- command is root ('/') in the container's filesystem.
- The command is simply exec'd, it is not run inside
- a shell, so traditional shell instructions ('|', etc)
- won't work. To use a shell, you need to explicitly
- call out to that shell. Exit status of 0 is treated
- as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe
- to be considered failed after having succeeded. Defaults
- to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
format: int32
type: integer
grpc:
- description: GRPC specifies an action involving a GRPC port.
- This is a beta field and requires enabling GRPCContainerProbe
- feature gate.
+ description: GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.
properties:
port:
- description: Port number of the gRPC service. Number
- must be in the range 1 to 65535.
+ description: Port number of the gRPC service. Number must be in the range 1 to 65535.
format: int32
type: integer
service:
- description: "Service is the name of the service to
- place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
- \n If this is not specified, the default behavior
- is defined by gRPC."
+ description: "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). \n If this is not specified, the default behavior is defined by gRPC."
type: string
required:
- port
@@ -3253,16 +2119,12 @@ spec:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to the
- pod IP. You probably want to set "Host" in httpHeaders
- instead.
+ description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP
- allows repeated headers.
+ description: Custom headers to set in the request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header
- to be used in HTTP probes
+ description: HTTPHeader describes a custom header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -3282,120 +2144,75 @@ spec:
anyOf:
- type: integer
- type: string
- description: Name or number of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: 'Number of seconds after the container has
- started before liveness probes are initiated. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
format: int32
type: integer
successThreshold:
- description: Minimum consecutive successes for the probe
- to be considered successful after having failed. Defaults
- to 1. Must be 1 for liveness and startup. Minimum value
- is 1.
+ description: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
- description: TCPSocket specifies an action involving a TCP
- port.
+ description: TCPSocket specifies an action involving a TCP port.
properties:
host:
- description: 'Optional: Host name to connect to, defaults
- to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: Number or name of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: Optional duration in seconds the pod needs
- to terminate gracefully upon probe failure. The grace
- period is the duration in seconds after the processes
- running in the pod are sent a termination signal and the
- time when the processes are forcibly halted with a kill
- signal. Set this value longer than the expected cleanup
- time for your process. If this value is nil, the pod's
- terminationGracePeriodSeconds will be used. Otherwise,
- this value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates
- stop immediately via the kill signal (no opportunity to
- shut down). This is a beta field and requires enabling
- ProbeTerminationGracePeriod feature gate. Minimum value
- is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: 'Number of seconds after which the probe times
- out. Defaults to 1 second. Minimum value is 1. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
name:
- description: Name of the container specified as a DNS_LABEL.
- Each container in a pod must have a unique name (DNS_LABEL).
- Cannot be updated.
+ description: Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
type: string
ports:
- description: List of ports to expose from the container. Not
- specifying a port here DOES NOT prevent that port from being
- exposed. Any port which is listening on the default "0.0.0.0"
- address inside a container will be accessible from the network.
- Modifying this array with strategic merge patch may corrupt
- the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255.
- Cannot be updated.
+ description: List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.
items:
- description: ContainerPort represents a network port in a
- single container.
+ description: ContainerPort represents a network port in a single container.
properties:
containerPort:
- description: Number of port to expose on the pod's IP
- address. This must be a valid port number, 0 < x < 65536.
+ description: Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
format: int32
type: integer
hostIP:
description: What host IP to bind the external port to.
type: string
hostPort:
- description: Number of port to expose on the host. If
- specified, this must be a valid port number, 0 < x <
- 65536. If HostNetwork is specified, this must match
- ContainerPort. Most containers do not need this.
+ description: Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.
format: int32
type: integer
name:
- description: If specified, this must be an IANA_SVC_NAME
- and unique within the pod. Each named port in a pod
- must have a unique name. Name for the port that can
- be referred to by services.
+ description: If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
type: string
protocol:
default: TCP
- description: Protocol for port. Must be UDP, TCP, or SCTP.
- Defaults to "TCP".
+ description: Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".
type: string
required:
- containerPort
@@ -3406,47 +2223,30 @@ spec:
- protocol
x-kubernetes-list-type: map
readinessProbe:
- description: 'Periodic probe of container service readiness.
- Container will be removed from service endpoints if the probe
- fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: Command is the command line to execute
- inside the container, the working directory for the
- command is root ('/') in the container's filesystem.
- The command is simply exec'd, it is not run inside
- a shell, so traditional shell instructions ('|', etc)
- won't work. To use a shell, you need to explicitly
- call out to that shell. Exit status of 0 is treated
- as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe
- to be considered failed after having succeeded. Defaults
- to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
format: int32
type: integer
grpc:
- description: GRPC specifies an action involving a GRPC port.
- This is a beta field and requires enabling GRPCContainerProbe
- feature gate.
+ description: GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.
properties:
port:
- description: Port number of the gRPC service. Number
- must be in the range 1 to 65535.
+ description: Port number of the gRPC service. Number must be in the range 1 to 65535.
format: int32
type: integer
service:
- description: "Service is the name of the service to
- place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
- \n If this is not specified, the default behavior
- is defined by gRPC."
+ description: "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). \n If this is not specified, the default behavior is defined by gRPC."
type: string
required:
- port
@@ -3455,16 +2255,12 @@ spec:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to the
- pod IP. You probably want to set "Host" in httpHeaders
- instead.
+ description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP
- allows repeated headers.
+ description: Custom headers to set in the request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header
- to be used in HTTP probes
+ description: HTTPHeader describes a custom header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -3484,95 +2280,60 @@ spec:
anyOf:
- type: integer
- type: string
- description: Name or number of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: 'Number of seconds after the container has
- started before liveness probes are initiated. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
format: int32
type: integer
successThreshold:
- description: Minimum consecutive successes for the probe
- to be considered successful after having failed. Defaults
- to 1. Must be 1 for liveness and startup. Minimum value
- is 1.
+ description: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
- description: TCPSocket specifies an action involving a TCP
- port.
+ description: TCPSocket specifies an action involving a TCP port.
properties:
host:
- description: 'Optional: Host name to connect to, defaults
- to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: Number or name of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: Optional duration in seconds the pod needs
- to terminate gracefully upon probe failure. The grace
- period is the duration in seconds after the processes
- running in the pod are sent a termination signal and the
- time when the processes are forcibly halted with a kill
- signal. Set this value longer than the expected cleanup
- time for your process. If this value is nil, the pod's
- terminationGracePeriodSeconds will be used. Otherwise,
- this value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates
- stop immediately via the kill signal (no opportunity to
- shut down). This is a beta field and requires enabling
- ProbeTerminationGracePeriod feature gate. Minimum value
- is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: 'Number of seconds after which the probe times
- out. Defaults to 1 second. Minimum value is 1. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
resources:
- description: 'Compute Resources required by this container.
- Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
properties:
claims:
- description: "Claims lists the names of resources, defined
- in spec.resourceClaims, that are used by this container.
- \n This is an alpha field and requires enabling the DynamicResourceAllocation
- feature gate. \n This field is immutable."
+ description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable."
items:
description: ResourceClaim references one entry in PodSpec.ResourceClaims.
properties:
name:
- description: Name must match the name of one entry
- in pod.spec.resourceClaims of the Pod where this
- field is used. It makes that resource available
- inside a container.
+ description: Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
type: string
required:
- name
@@ -3588,8 +2349,7 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute
- resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -3598,236 +2358,121 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Requests describes the minimum amount of compute
- resources required. If Requests is omitted for a container,
- it defaults to Limits if that is explicitly specified,
- otherwise to an implementation-defined value. More info:
- https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
securityContext:
- description: 'SecurityContext defines the security options the
- container should be run with. If set, the fields of SecurityContext
- override the equivalent fields of PodSecurityContext. More
- info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
+ description: 'SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
properties:
allowPrivilegeEscalation:
- description: 'AllowPrivilegeEscalation controls whether
- a process can gain more privileges than its parent process.
- This bool directly controls if the no_new_privs flag will
- be set on the container process. AllowPrivilegeEscalation
- is true always when the container is: 1) run as Privileged
- 2) has CAP_SYS_ADMIN Note that this field cannot be set
- when spec.os.name is windows.'
+ description: 'AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.'
type: boolean
capabilities:
- description: The capabilities to add/drop when running containers.
- Defaults to the default set of capabilities granted by
- the container runtime. Note that this field cannot be
- set when spec.os.name is windows.
+ description: The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.
properties:
add:
description: Added capabilities
items:
- description: Capability represent POSIX capabilities
- type
+ description: Capability represent POSIX capabilities type
type: string
type: array
drop:
description: Removed capabilities
items:
- description: Capability represent POSIX capabilities
- type
+ description: Capability represent POSIX capabilities type
type: string
type: array
type: object
privileged:
- description: Run container in privileged mode. Processes
- in privileged containers are essentially equivalent to
- root on the host. Defaults to false. Note that this field
- cannot be set when spec.os.name is windows.
+ description: Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.
type: boolean
procMount:
- description: procMount denotes the type of proc mount to
- use for the containers. The default is DefaultProcMount
- which uses the container runtime defaults for readonly
- paths and masked paths. This requires the ProcMountType
- feature flag to be enabled. Note that this field cannot
- be set when spec.os.name is windows.
+ description: procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.
type: string
readOnlyRootFilesystem:
- description: Whether this container has a read-only root
- filesystem. Default is false. Note that this field cannot
- be set when spec.os.name is windows.
+ description: Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.
type: boolean
runAsGroup:
- description: The GID to run the entrypoint of the container
- process. Uses runtime default if unset. May also be set
- in PodSecurityContext. If set in both SecurityContext
- and PodSecurityContext, the value specified in SecurityContext
- takes precedence. Note that this field cannot be set when
- spec.os.name is windows.
+ description: The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
format: int64
type: integer
runAsNonRoot:
- description: Indicates that the container must run as a
- non-root user. If true, the Kubelet will validate the
- image at runtime to ensure that it does not run as UID
- 0 (root) and fail to start the container if it does. If
- unset or false, no such validation will be performed.
- May also be set in PodSecurityContext. If set in both
- SecurityContext and PodSecurityContext, the value specified
- in SecurityContext takes precedence.
+ description: Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
type: boolean
runAsUser:
- description: The UID to run the entrypoint of the container
- process. Defaults to user specified in image metadata
- if unspecified. May also be set in PodSecurityContext. If
- set in both SecurityContext and PodSecurityContext, the
- value specified in SecurityContext takes precedence. Note
- that this field cannot be set when spec.os.name is windows.
+ description: The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
format: int64
type: integer
seLinuxOptions:
- description: The SELinux context to be applied to the container.
- If unspecified, the container runtime will allocate a
- random SELinux context for each container. May also be
- set in PodSecurityContext. If set in both SecurityContext
- and PodSecurityContext, the value specified in SecurityContext
- takes precedence. Note that this field cannot be set when
- spec.os.name is windows.
+ description: The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
properties:
level:
- description: Level is SELinux level label that applies
- to the container.
+ description: Level is SELinux level label that applies to the container.
type: string
role:
- description: Role is a SELinux role label that applies
- to the container.
+ description: Role is a SELinux role label that applies to the container.
type: string
type:
- description: Type is a SELinux type label that applies
- to the container.
+ description: Type is a SELinux type label that applies to the container.
type: string
user:
- description: User is a SELinux user label that applies
- to the container.
+ description: User is a SELinux user label that applies to the container.
type: string
type: object
seccompProfile:
- description: The seccomp options to use by this container.
- If seccomp options are provided at both the pod & container
- level, the container options override the pod options.
- Note that this field cannot be set when spec.os.name is
- windows.
+ description: The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
properties:
localhostProfile:
- description: localhostProfile indicates a profile defined
- in a file on the node should be used. The profile
- must be preconfigured on the node to work. Must be
- a descending path, relative to the kubelet's configured
- seccomp profile location. Must only be set if type
- is "Localhost".
+ description: localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost".
type: string
type:
- description: "type indicates which kind of seccomp profile
- will be applied. Valid options are: \n Localhost -
- a profile defined in a file on the node should be
- used. RuntimeDefault - the container runtime default
- profile should be used. Unconfined - no profile should
- be applied."
+ description: "type indicates which kind of seccomp profile will be applied. Valid options are: \n Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied."
type: string
required:
- type
type: object
windowsOptions:
- description: The Windows specific settings applied to all
- containers. If unspecified, the options from the PodSecurityContext
- will be used. If set in both SecurityContext and PodSecurityContext,
- the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is
- linux.
+ description: The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
properties:
gmsaCredentialSpec:
- description: GMSACredentialSpec is where the GMSA admission
- webhook (https://github.com/kubernetes-sigs/windows-gmsa)
- inlines the contents of the GMSA credential spec named
- by the GMSACredentialSpecName field.
+ description: GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.
type: string
gmsaCredentialSpecName:
- description: GMSACredentialSpecName is the name of the
- GMSA credential spec to use.
+ description: GMSACredentialSpecName is the name of the GMSA credential spec to use.
type: string
hostProcess:
- description: HostProcess determines if a container should
- be run as a 'Host Process' container. This field is
- alpha-level and will only be honored by components
- that enable the WindowsHostProcessContainers feature
- flag. Setting this field without the feature flag
- will result in errors when validating the Pod. All
- of a Pod's containers must have the same effective
- HostProcess value (it is not allowed to have a mix
- of HostProcess containers and non-HostProcess containers). In
- addition, if HostProcess is true then HostNetwork
- must also be set to true.
+ description: HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.
type: boolean
runAsUserName:
- description: The UserName in Windows to run the entrypoint
- of the container process. Defaults to the user specified
- in image metadata if unspecified. May also be set
- in PodSecurityContext. If set in both SecurityContext
- and PodSecurityContext, the value specified in SecurityContext
- takes precedence.
+ description: The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
type: string
type: object
type: object
startupProbe:
- description: 'StartupProbe indicates that the Pod has successfully
- initialized. If specified, no other probes are executed until
- this completes successfully. If this probe fails, the Pod
- will be restarted, just as if the livenessProbe failed. This
- can be used to provide different probe parameters at the beginning
- of a Pod''s lifecycle, when it might take a long time to load
- data or warm a cache, than during steady-state operation.
- This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod''s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: Command is the command line to execute
- inside the container, the working directory for the
- command is root ('/') in the container's filesystem.
- The command is simply exec'd, it is not run inside
- a shell, so traditional shell instructions ('|', etc)
- won't work. To use a shell, you need to explicitly
- call out to that shell. Exit status of 0 is treated
- as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe
- to be considered failed after having succeeded. Defaults
- to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
format: int32
type: integer
grpc:
- description: GRPC specifies an action involving a GRPC port.
- This is a beta field and requires enabling GRPCContainerProbe
- feature gate.
+ description: GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.
properties:
port:
- description: Port number of the gRPC service. Number
- must be in the range 1 to 65535.
+ description: Port number of the gRPC service. Number must be in the range 1 to 65535.
format: int32
type: integer
service:
- description: "Service is the name of the service to
- place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
- \n If this is not specified, the default behavior
- is defined by gRPC."
+ description: "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). \n If this is not specified, the default behavior is defined by gRPC."
type: string
required:
- port
@@ -3836,16 +2481,12 @@ spec:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to the
- pod IP. You probably want to set "Host" in httpHeaders
- instead.
+ description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP
- allows repeated headers.
+ description: Custom headers to set in the request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header
- to be used in HTTP probes
+ description: HTTPHeader describes a custom header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -3865,133 +2506,75 @@ spec:
anyOf:
- type: integer
- type: string
- description: Name or number of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: 'Number of seconds after the container has
- started before liveness probes are initiated. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
format: int32
type: integer
successThreshold:
- description: Minimum consecutive successes for the probe
- to be considered successful after having failed. Defaults
- to 1. Must be 1 for liveness and startup. Minimum value
- is 1.
+ description: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
- description: TCPSocket specifies an action involving a TCP
- port.
+ description: TCPSocket specifies an action involving a TCP port.
properties:
host:
- description: 'Optional: Host name to connect to, defaults
- to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: Number or name of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: Optional duration in seconds the pod needs
- to terminate gracefully upon probe failure. The grace
- period is the duration in seconds after the processes
- running in the pod are sent a termination signal and the
- time when the processes are forcibly halted with a kill
- signal. Set this value longer than the expected cleanup
- time for your process. If this value is nil, the pod's
- terminationGracePeriodSeconds will be used. Otherwise,
- this value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates
- stop immediately via the kill signal (no opportunity to
- shut down). This is a beta field and requires enabling
- ProbeTerminationGracePeriod feature gate. Minimum value
- is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: 'Number of seconds after which the probe times
- out. Defaults to 1 second. Minimum value is 1. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
stdin:
- description: Whether this container should allocate a buffer
- for stdin in the container runtime. If this is not set, reads
- from stdin in the container will always result in EOF. Default
- is false.
+ description: Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
type: boolean
stdinOnce:
- description: Whether the container runtime should close the
- stdin channel after it has been opened by a single attach.
- When stdin is true the stdin stream will remain open across
- multiple attach sessions. If stdinOnce is set to true, stdin
- is opened on container start, is empty until the first client
- attaches to stdin, and then remains open and accepts data
- until the client disconnects, at which time stdin is closed
- and remains closed until the container is restarted. If this
- flag is false, a container processes that reads from stdin
- will never receive an EOF. Default is false
+ description: Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
type: boolean
terminationMessagePath:
- description: 'Optional: Path at which the file to which the
- container''s termination message will be written is mounted
- into the container''s filesystem. Message written is intended
- to be brief final status, such as an assertion failure message.
- Will be truncated by the node if greater than 4096 bytes.
- The total message length across all containers will be limited
- to 12kb. Defaults to /dev/termination-log. Cannot be updated.'
+ description: 'Optional: Path at which the file to which the container''s termination message will be written is mounted into the container''s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.'
type: string
terminationMessagePolicy:
- description: Indicate how the termination message should be
- populated. File will use the contents of terminationMessagePath
- to populate the container status message on both success and
- failure. FallbackToLogsOnError will use the last chunk of
- container log output if the termination message file is empty
- and the container exited with an error. The log output is
- limited to 2048 bytes or 80 lines, whichever is smaller. Defaults
- to File. Cannot be updated.
+ description: Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
type: string
tty:
- description: Whether this container should allocate a TTY for
- itself, also requires 'stdin' to be true. Default is false.
+ description: Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
type: boolean
volumeDevices:
- description: volumeDevices is the list of block devices to be
- used by the container.
+ description: volumeDevices is the list of block devices to be used by the container.
items:
- description: volumeDevice describes a mapping of a raw block
- device within a container.
+ description: volumeDevice describes a mapping of a raw block device within a container.
properties:
devicePath:
- description: devicePath is the path inside of the container
- that the device will be mapped to.
+ description: devicePath is the path inside of the container that the device will be mapped to.
type: string
name:
- description: name must match the name of a persistentVolumeClaim
- in the pod
+ description: name must match the name of a persistentVolumeClaim in the pod
type: string
required:
- devicePath
@@ -3999,40 +2582,27 @@ spec:
type: object
type: array
volumeMounts:
- description: Pod volumes to mount into the container's filesystem.
- Cannot be updated.
+ description: Pod volumes to mount into the container's filesystem. Cannot be updated.
items:
- description: VolumeMount describes a mounting of a Volume
- within a container.
+ description: VolumeMount describes a mounting of a Volume within a container.
properties:
mountPath:
- description: Path within the container at which the volume
- should be mounted. Must not contain ':'.
+ description: Path within the container at which the volume should be mounted. Must not contain ':'.
type: string
mountPropagation:
- description: mountPropagation determines how mounts are
- propagated from the host to container and the other
- way around. When not set, MountPropagationNone is used.
- This field is beta in 1.10.
+ description: mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.
type: string
name:
description: This must match the Name of a Volume.
type: string
readOnly:
- description: Mounted read-only if true, read-write otherwise
- (false or unspecified). Defaults to false.
+ description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
type: boolean
subPath:
- description: Path within the volume from which the container's
- volume should be mounted. Defaults to "" (volume's root).
+ description: Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
type: string
subPathExpr:
- description: Expanded path within the volume from which
- the container's volume should be mounted. Behaves similarly
- to SubPath but environment variable references $(VAR_NAME)
- are expanded using the container's environment. Defaults
- to "" (volume's root). SubPathExpr and SubPath are mutually
- exclusive.
+ description: Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.
type: string
required:
- mountPath
@@ -4040,18 +2610,14 @@ spec:
type: object
type: array
workingDir:
- description: Container's working directory. If not specified,
- the container runtime's default will be used, which might
- be configured in the container image. Cannot be updated.
+ description: Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.
type: string
required:
- name
type: object
type: array
listenLocal:
- description: ListenLocal makes the Alertmanager server listen on loopback,
- so that it does not bind against the Pod IP. Note this is only for
- the Alertmanager UI, not the gossip communication.
+ description: ListenLocal makes the Alertmanager server listen on loopback, so that it does not bind against the Pod IP. Note this is only for the Alertmanager UI, not the gossip communication.
type: boolean
logFormat:
description: Log format for Alertmanager to be configured with.
@@ -4070,12 +2636,7 @@ spec:
- error
type: string
minReadySeconds:
- description: Minimum number of seconds for which a newly created pod
- should be ready without any of its container crashing for it to
- be considered available. Defaults to 0 (pod will be considered available
- as soon as it is ready) This is an alpha field from kubernetes 1.22
- until 1.24 which requires enabling the StatefulSetMinReadySeconds
- feature gate.
+ description: Minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) This is an alpha field from kubernetes 1.22 until 1.24 which requires enabling the StatefulSetMinReadySeconds feature gate.
format: int32
type: integer
nodeSelector:
@@ -4084,66 +2645,46 @@ spec:
description: Define which Nodes the Pods are scheduled on.
type: object
paused:
- description: If set to true all actions on the underlying managed
- objects are not goint to be performed, except for delete actions.
+ description: If set to true all actions on the underlying managed objects are not goint to be performed, except for delete actions.
type: boolean
podMetadata:
- description: PodMetadata configures Labels and Annotations which are
- propagated to the alertmanager pods.
+ description: PodMetadata configures Labels and Annotations which are propagated to the alertmanager pods.
properties:
annotations:
additionalProperties:
type: string
- description: 'Annotations is an unstructured key value map stored
- with a resource that may be set by external tools to store and
- retrieve arbitrary metadata. They are not queryable and should
- be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations'
+ description: 'Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations'
type: object
labels:
additionalProperties:
type: string
- description: 'Map of string keys and values that can be used to
- organize and categorize (scope and select) objects. May match
- selectors of replication controllers and services. More info:
- http://kubernetes.io/docs/user-guide/labels'
+ description: 'Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels'
type: object
name:
- description: 'Name must be unique within a namespace. Is required
- when creating resources, although some resources may allow a
- client to request the generation of an appropriate name automatically.
- Name is primarily intended for creation idempotence and configuration
- definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names'
+ description: 'Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names'
type: string
type: object
portName:
default: web
- description: Port name used for the pods and governing service. Defaults
- to `web`.
+ description: Port name used for the pods and governing service. Defaults to `web`.
type: string
priorityClassName:
description: Priority class assigned to the Pods
type: string
replicas:
- description: Size is the expected size of the alertmanager cluster.
- The controller will eventually make the size of the running cluster
- equal to the expected size.
+ description: Size is the expected size of the alertmanager cluster. The controller will eventually make the size of the running cluster equal to the expected size.
format: int32
type: integer
resources:
description: Define resources requests and limits for single Pods.
properties:
claims:
- description: "Claims lists the names of resources, defined in
- spec.resourceClaims, that are used by this container. \n This
- is an alpha field and requires enabling the DynamicResourceAllocation
- feature gate. \n This field is immutable."
+ description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable."
items:
description: ResourceClaim references one entry in PodSpec.ResourceClaims.
properties:
name:
- description: Name must match the name of one entry in pod.spec.resourceClaims
- of the Pod where this field is used. It makes that resource
- available inside a container.
+ description: Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
type: string
required:
- name
@@ -4159,8 +2700,7 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute resources
- allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -4169,153 +2709,79 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Requests describes the minimum amount of compute
- resources required. If Requests is omitted for a container,
- it defaults to Limits if that is explicitly specified, otherwise
- to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
retention:
default: 120h
- description: Time duration Alertmanager shall retain data for. Default
- is '120h', and must match the regular expression `[0-9]+(ms|s|m|h)`
- (milliseconds seconds minutes hours).
+ description: Time duration Alertmanager shall retain data for. Default is '120h', and must match the regular expression `[0-9]+(ms|s|m|h)` (milliseconds seconds minutes hours).
pattern: ^(0|(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
routePrefix:
- description: The route prefix Alertmanager registers HTTP handlers
- for. This is useful, if using ExternalURL and a proxy is rewriting
- HTTP routes of a request, and the actual ExternalURL is still true,
- but the server serves requests under a different route prefix. For
- example for use with `kubectl proxy`.
+ description: The route prefix Alertmanager registers HTTP handlers for. This is useful, if using ExternalURL and a proxy is rewriting HTTP routes of a request, and the actual ExternalURL is still true, but the server serves requests under a different route prefix. For example for use with `kubectl proxy`.
type: string
secrets:
- description: Secrets is a list of Secrets in the same namespace as
- the Alertmanager object, which shall be mounted into the Alertmanager
- Pods. Each Secret is added to the StatefulSet definition as a volume
- named `secret-<secret-name>`. The Secrets are mounted into `/etc/alertmanager/secrets/<secret-name>`
- in the 'alertmanager' container.
+ description: Secrets is a list of Secrets in the same namespace as the Alertmanager object, which shall be mounted into the Alertmanager Pods. Each Secret is added to the StatefulSet definition as a volume named `secret-<secret-name>`. The Secrets are mounted into `/etc/alertmanager/secrets/<secret-name>` in the 'alertmanager' container.
items:
type: string
type: array
securityContext:
- description: SecurityContext holds pod-level security attributes and
- common container settings. This defaults to the default PodSecurityContext.
+ description: SecurityContext holds pod-level security attributes and common container settings. This defaults to the default PodSecurityContext.
properties:
fsGroup:
- description: "A special supplemental group that applies to all
- containers in a pod. Some volume types allow the Kubelet to
- change the ownership of that volume to be owned by the pod:
- \n 1. The owning GID will be the FSGroup 2. The setgid bit is
- set (new files created in the volume will be owned by FSGroup)
- 3. The permission bits are OR'd with rw-rw---- \n If unset,
- the Kubelet will not modify the ownership and permissions of
- any volume. Note that this field cannot be set when spec.os.name
- is windows."
+ description: "A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: \n 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- \n If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows."
format: int64
type: integer
fsGroupChangePolicy:
- description: 'fsGroupChangePolicy defines behavior of changing
- ownership and permission of the volume before being exposed
- inside Pod. This field will only apply to volume types which
- support fsGroup based ownership(and permissions). It will have
- no effect on ephemeral volume types such as: secret, configmaps
- and emptydir. Valid values are "OnRootMismatch" and "Always".
- If not specified, "Always" is used. Note that this field cannot
- be set when spec.os.name is windows.'
+ description: 'fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. Note that this field cannot be set when spec.os.name is windows.'
type: string
runAsGroup:
- description: The GID to run the entrypoint of the container process.
- Uses runtime default if unset. May also be set in SecurityContext. If
- set in both SecurityContext and PodSecurityContext, the value
- specified in SecurityContext takes precedence for that container.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
format: int64
type: integer
runAsNonRoot:
- description: Indicates that the container must run as a non-root
- user. If true, the Kubelet will validate the image at runtime
- to ensure that it does not run as UID 0 (root) and fail to start
- the container if it does. If unset or false, no such validation
- will be performed. May also be set in SecurityContext. If set
- in both SecurityContext and PodSecurityContext, the value specified
- in SecurityContext takes precedence.
+ description: Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
type: boolean
runAsUser:
- description: The UID to run the entrypoint of the container process.
- Defaults to user specified in image metadata if unspecified.
- May also be set in SecurityContext. If set in both SecurityContext
- and PodSecurityContext, the value specified in SecurityContext
- takes precedence for that container. Note that this field cannot
- be set when spec.os.name is windows.
+ description: The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
format: int64
type: integer
seLinuxOptions:
- description: The SELinux context to be applied to all containers.
- If unspecified, the container runtime will allocate a random
- SELinux context for each container. May also be set in SecurityContext. If
- set in both SecurityContext and PodSecurityContext, the value
- specified in SecurityContext takes precedence for that container.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
properties:
level:
- description: Level is SELinux level label that applies to
- the container.
+ description: Level is SELinux level label that applies to the container.
type: string
role:
- description: Role is a SELinux role label that applies to
- the container.
+ description: Role is a SELinux role label that applies to the container.
type: string
type:
- description: Type is a SELinux type label that applies to
- the container.
+ description: Type is a SELinux type label that applies to the container.
type: string
user:
- description: User is a SELinux user label that applies to
- the container.
+ description: User is a SELinux user label that applies to the container.
type: string
type: object
seccompProfile:
- description: The seccomp options to use by the containers in this
- pod. Note that this field cannot be set when spec.os.name is
- windows.
+ description: The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.
properties:
localhostProfile:
- description: localhostProfile indicates a profile defined
- in a file on the node should be used. The profile must be
- preconfigured on the node to work. Must be a descending
- path, relative to the kubelet's configured seccomp profile
- location. Must only be set if type is "Localhost".
+ description: localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost".
type: string
type:
- description: "type indicates which kind of seccomp profile
- will be applied. Valid options are: \n Localhost - a profile
- defined in a file on the node should be used. RuntimeDefault
- - the container runtime default profile should be used.
- Unconfined - no profile should be applied."
+ description: "type indicates which kind of seccomp profile will be applied. Valid options are: \n Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied."
type: string
required:
- type
type: object
supplementalGroups:
- description: A list of groups applied to the first process run
- in each container, in addition to the container's primary GID,
- the fsGroup (if specified), and group memberships defined in
- the container image for the uid of the container process. If
- unspecified, no additional groups are added to any container.
- Note that group memberships defined in the container image for
- the uid of the container process are still effective, even if
- they are not included in this list. Note that this field cannot
- be set when spec.os.name is windows.
+ description: A list of groups applied to the first process run in each container, in addition to the container's primary GID, the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process. If unspecified, no additional groups are added to any container. Note that group memberships defined in the container image for the uid of the container process are still effective, even if they are not included in this list. Note that this field cannot be set when spec.os.name is windows.
items:
format: int64
type: integer
type: array
sysctls:
- description: Sysctls hold a list of namespaced sysctls used for
- the pod. Pods with unsupported sysctls (by the container runtime)
- might fail to launch. Note that this field cannot be set when
- spec.os.name is windows.
+ description: Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows.
items:
description: Sysctl defines a kernel parameter to be set
properties:
@@ -4331,158 +2797,76 @@ spec:
type: object
type: array
windowsOptions:
- description: The Windows specific settings applied to all containers.
- If unspecified, the options within a container's SecurityContext
- will be used. If set in both SecurityContext and PodSecurityContext,
- the value specified in SecurityContext takes precedence. Note
- that this field cannot be set when spec.os.name is linux.
+ description: The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
properties:
gmsaCredentialSpec:
- description: GMSACredentialSpec is where the GMSA admission
- webhook (https://github.com/kubernetes-sigs/windows-gmsa)
- inlines the contents of the GMSA credential spec named by
- the GMSACredentialSpecName field.
+ description: GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.
type: string
gmsaCredentialSpecName:
- description: GMSACredentialSpecName is the name of the GMSA
- credential spec to use.
+ description: GMSACredentialSpecName is the name of the GMSA credential spec to use.
type: string
hostProcess:
- description: HostProcess determines if a container should
- be run as a 'Host Process' container. This field is alpha-level
- and will only be honored by components that enable the WindowsHostProcessContainers
- feature flag. Setting this field without the feature flag
- will result in errors when validating the Pod. All of a
- Pod's containers must have the same effective HostProcess
- value (it is not allowed to have a mix of HostProcess containers
- and non-HostProcess containers). In addition, if HostProcess
- is true then HostNetwork must also be set to true.
+ description: HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.
type: boolean
runAsUserName:
- description: The UserName in Windows to run the entrypoint
- of the container process. Defaults to the user specified
- in image metadata if unspecified. May also be set in PodSecurityContext.
- If set in both SecurityContext and PodSecurityContext, the
- value specified in SecurityContext takes precedence.
+ description: The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
type: string
type: object
type: object
serviceAccountName:
- description: ServiceAccountName is the name of the ServiceAccount
- to use to run the Prometheus Pods.
+ description: ServiceAccountName is the name of the ServiceAccount to use to run the Prometheus Pods.
type: string
sha:
- description: 'SHA of Alertmanager container image to be deployed.
- Defaults to the value of `version`. Similar to a tag, but the SHA
- explicitly deploys an immutable container image. Version and Tag
- are ignored if SHA is set. Deprecated: use ''image'' instead. The
- image digest can be specified as part of the image URL.'
+ description: 'SHA of Alertmanager container image to be deployed. Defaults to the value of `version`. Similar to a tag, but the SHA explicitly deploys an immutable container image. Version and Tag are ignored if SHA is set. Deprecated: use ''image'' instead. The image digest can be specified as part of the image URL.'
type: string
storage:
- description: Storage is the definition of how storage will be used
- by the Alertmanager instances.
+ description: Storage is the definition of how storage will be used by the Alertmanager instances.
properties:
disableMountSubPath:
- description: 'Deprecated: subPath usage will be disabled by default
- in a future release, this option will become unnecessary. DisableMountSubPath
- allows to remove any subPath usage in volume mounts.'
+ description: 'Deprecated: subPath usage will be disabled by default in a future release, this option will become unnecessary. DisableMountSubPath allows to remove any subPath usage in volume mounts.'
type: boolean
emptyDir:
- description: 'EmptyDirVolumeSource to be used by the StatefulSet.
- If specified, used in place of any volumeClaimTemplate. More
- info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir'
+ description: 'EmptyDirVolumeSource to be used by the StatefulSet. If specified, used in place of any volumeClaimTemplate. More info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir'
properties:
medium:
- description: 'medium represents what type of storage medium
- should back this directory. The default is "" which means
- to use the node''s default medium. Must be an empty string
- (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
+ description: 'medium represents what type of storage medium should back this directory. The default is "" which means to use the node''s default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
type: string
sizeLimit:
anyOf:
- type: integer
- type: string
- description: 'sizeLimit is the total amount of local storage
- required for this EmptyDir volume. The size limit is also
- applicable for memory medium. The maximum usage on memory
- medium EmptyDir would be the minimum value between the SizeLimit
- specified here and the sum of memory limits of all containers
- in a pod. The default is nil which means that the limit
- is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir'
+ description: 'sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir'
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
type: object
ephemeral:
- description: 'EphemeralVolumeSource to be used by the StatefulSet.
- This is a beta field in k8s 1.21, for lower versions, starting
- with k8s 1.19, it requires enabling the GenericEphemeralVolume
- feature gate. More info: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes'
+ description: 'EphemeralVolumeSource to be used by the StatefulSet. This is a beta field in k8s 1.21, for lower versions, starting with k8s 1.19, it requires enabling the GenericEphemeralVolume feature gate. More info: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes'
properties:
volumeClaimTemplate:
- description: "Will be used to create a stand-alone PVC to
- provision the volume. The pod in which this EphemeralVolumeSource
- is embedded will be the owner of the PVC, i.e. the PVC will
- be deleted together with the pod. The name of the PVC will
- be `<pod name>-<volume name>` where `<volume name>` is the
- name from the `PodSpec.Volumes` array entry. Pod validation
- will reject the pod if the concatenated name is not valid
- for a PVC (for example, too long). \n An existing PVC with
- that name that is not owned by the pod will *not* be used
- for the pod to avoid using an unrelated volume by mistake.
- Starting the pod is then blocked until the unrelated PVC
- is removed. If such a pre-created PVC is meant to be used
- by the pod, the PVC has to updated with an owner reference
- to the pod once the pod exists. Normally this should not
- be necessary, but it may be useful when manually reconstructing
- a broken cluster. \n This field is read-only and no changes
- will be made by Kubernetes to the PVC after it has been
- created. \n Required, must not be nil."
+ description: "Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `<pod name>-<volume name>` where `<volume name>` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). \n An existing PVC with that name that is not owned by the pod will *not* be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. \n This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. \n Required, must not be nil."
properties:
metadata:
- description: May contain labels and annotations that will
- be copied into the PVC when creating it. No other fields
- are allowed and will be rejected during validation.
+ description: May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.
type: object
spec:
- description: The specification for the PersistentVolumeClaim.
- The entire content is copied unchanged into the PVC
- that gets created from this template. The same fields
- as in a PersistentVolumeClaim are also valid here.
+ description: The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
properties:
accessModes:
- description: 'accessModes contains the desired access
- modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
+ description: 'accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
items:
type: string
type: array
dataSource:
- description: 'dataSource field can be used to specify
- either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
- * An existing PVC (PersistentVolumeClaim) If the
- provisioner or an external controller can support
- the specified data source, it will create a new
- volume based on the contents of the specified data
- source. When the AnyVolumeDataSource feature gate
- is enabled, dataSource contents will be copied to
- dataSourceRef, and dataSourceRef contents will be
- copied to dataSource when dataSourceRef.namespace
- is not specified. If the namespace is specified,
- then dataSourceRef will not be copied to dataSource.'
+ description: 'dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.'
properties:
apiGroup:
- description: APIGroup is the group for the resource
- being referenced. If APIGroup is not specified,
- the specified Kind must be in the core API group.
- For any other third-party types, APIGroup is
- required.
+ description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
type: string
kind:
- description: Kind is the type of resource being
- referenced
+ description: Kind is the type of resource being referenced
type: string
name:
- description: Name is the name of resource being
- referenced
+ description: Name is the name of resource being referenced
type: string
required:
- kind
@@ -4490,89 +2874,34 @@ spec:
type: object
x-kubernetes-map-type: atomic
dataSourceRef:
- description: 'dataSourceRef specifies the object from
- which to populate the volume with data, if a non-empty
- volume is desired. This may be any object from a
- non-empty API group (non core object) or a PersistentVolumeClaim
- object. When this field is specified, volume binding
- will only succeed if the type of the specified object
- matches some installed volume populator or dynamic
- provisioner. This field will replace the functionality
- of the dataSource field and as such if both fields
- are non-empty, they must have the same value. For
- backwards compatibility, when namespace isn''t specified
- in dataSourceRef, both fields (dataSource and dataSourceRef)
- will be set to the same value automatically if one
- of them is empty and the other is non-empty. When
- namespace is specified in dataSourceRef, dataSource
- isn''t set to the same value and must be empty.
- There are three important differences between dataSource
- and dataSourceRef: * While dataSource only allows
- two specific types of objects, dataSourceRef allows
- any non-core object, as well as PersistentVolumeClaim
- objects. * While dataSource ignores disallowed values
- (dropping them), dataSourceRef preserves all values,
- and generates an error if a disallowed value is
- specified. * While dataSource only allows local
- objects, dataSourceRef allows objects in any namespaces.
- (Beta) Using this field requires the AnyVolumeDataSource
- feature gate to be enabled. (Alpha) Using the namespace
- field of dataSourceRef requires the CrossNamespaceVolumeDataSource
- feature gate to be enabled.'
+ description: 'dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn''t specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn''t set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.'
properties:
apiGroup:
- description: APIGroup is the group for the resource
- being referenced. If APIGroup is not specified,
- the specified Kind must be in the core API group.
- For any other third-party types, APIGroup is
- required.
+ description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
type: string
kind:
- description: Kind is the type of resource being
- referenced
+ description: Kind is the type of resource being referenced
type: string
name:
- description: Name is the name of resource being
- referenced
+ description: Name is the name of resource being referenced
type: string
namespace:
- description: Namespace is the namespace of resource
- being referenced Note that when a namespace
- is specified, a gateway.networking.k8s.io/ReferenceGrant
- object is required in the referent namespace
- to allow that namespace's owner to accept the
- reference. See the ReferenceGrant documentation
- for details. (Alpha) This field requires the
- CrossNamespaceVolumeDataSource feature gate
- to be enabled.
+ description: Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
type: string
required:
- kind
- name
type: object
resources:
- description: 'resources represents the minimum resources
- the volume should have. If RecoverVolumeExpansionFailure
- feature is enabled users are allowed to specify
- resource requirements that are lower than previous
- value but must still be higher than capacity recorded
- in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
+ description: 'resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
properties:
claims:
- description: "Claims lists the names of resources,
- defined in spec.resourceClaims, that are used
- by this container. \n This is an alpha field
- and requires enabling the DynamicResourceAllocation
- feature gate. \n This field is immutable."
+ description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable."
items:
- description: ResourceClaim references one entry
- in PodSpec.ResourceClaims.
+ description: ResourceClaim references one entry in PodSpec.ResourceClaims.
properties:
name:
- description: Name must match the name of
- one entry in pod.spec.resourceClaims of
- the Pod where this field is used. It makes
- that resource available inside a container.
+ description: Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
type: string
required:
- name
@@ -4588,8 +2917,7 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount
- of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -4598,43 +2926,25 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Requests describes the minimum amount
- of compute resources required. If Requests is
- omitted for a container, it defaults to Limits
- if that is explicitly specified, otherwise to
- an implementation-defined value. More info:
- https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
selector:
- description: selector is a label query over volumes
- to consider for binding.
+ description: selector is a label query over volumes to consider for binding.
properties:
matchExpressions:
- description: matchExpressions is a list of label
- selector requirements. The requirements are
- ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is
- a selector that contains values, a key, and
- an operator that relates the key and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the
- selector applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's
- relationship to a set of values. Valid
- operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string
- values. If the operator is In or NotIn,
- the values array must be non-empty. If
- the operator is Exists or DoesNotExist,
- the values array must be empty. This array
- is replaced during a strategic merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -4646,27 +2956,18 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value}
- pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions,
- whose key field is "key", the operator is "In",
- and the values array contains only "value".
- The requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
storageClassName:
- description: 'storageClassName is the name of the
- StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
+ description: 'storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
type: string
volumeMode:
- description: volumeMode defines what type of volume
- is required by the claim. Value of Filesystem is
- implied when not included in claim spec.
+ description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
type: string
volumeName:
- description: volumeName is the binding reference to
- the PersistentVolume backing this claim.
+ description: volumeName is the binding reference to the PersistentVolume backing this claim.
type: string
type: object
required:
@@ -4674,81 +2975,44 @@ spec:
type: object
type: object
volumeClaimTemplate:
- description: A PVC spec to be used by the StatefulSet. The easiest
- way to use a volume that cannot be automatically provisioned
- (for whatever reason) is to use a label selector alongside manually
- created PersistentVolumes.
+ description: A PVC spec to be used by the StatefulSet. The easiest way to use a volume that cannot be automatically provisioned (for whatever reason) is to use a label selector alongside manually created PersistentVolumes.
properties:
apiVersion:
- description: 'APIVersion defines the versioned schema of this
- representation of an object. Servers should convert recognized
- schemas to the latest internal value, and may reject unrecognized
- values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+ description: 'APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: 'Kind is a string value representing the REST
- resource this object represents. Servers may infer this
- from the endpoint the client submits requests to. Cannot
- be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+ description: 'Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
- description: EmbeddedMetadata contains metadata relevant to
- an EmbeddedResource.
+ description: EmbeddedMetadata contains metadata relevant to an EmbeddedResource.
properties:
annotations:
additionalProperties:
type: string
- description: 'Annotations is an unstructured key value
- map stored with a resource that may be set by external
- tools to store and retrieve arbitrary metadata. They
- are not queryable and should be preserved when modifying
- objects. More info: http://kubernetes.io/docs/user-guide/annotations'
+ description: 'Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations'
type: object
labels:
additionalProperties:
type: string
- description: 'Map of string keys and values that can be
- used to organize and categorize (scope and select) objects.
- May match selectors of replication controllers and services.
- More info: http://kubernetes.io/docs/user-guide/labels'
+ description: 'Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels'
type: object
name:
- description: 'Name must be unique within a namespace.
- Is required when creating resources, although some resources
- may allow a client to request the generation of an appropriate
- name automatically. Name is primarily intended for creation
- idempotence and configuration definition. Cannot be
- updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names'
+ description: 'Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names'
type: string
type: object
spec:
- description: 'Spec defines the desired characteristics of
- a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
+ description: 'Spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
properties:
accessModes:
- description: 'accessModes contains the desired access
- modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
+ description: 'accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
items:
type: string
type: array
dataSource:
- description: 'dataSource field can be used to specify
- either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
- * An existing PVC (PersistentVolumeClaim) If the provisioner
- or an external controller can support the specified
- data source, it will create a new volume based on the
- contents of the specified data source. When the AnyVolumeDataSource
- feature gate is enabled, dataSource contents will be
- copied to dataSourceRef, and dataSourceRef contents
- will be copied to dataSource when dataSourceRef.namespace
- is not specified. If the namespace is specified, then
- dataSourceRef will not be copied to dataSource.'
+ description: 'dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.'
properties:
apiGroup:
- description: APIGroup is the group for the resource
- being referenced. If APIGroup is not specified,
- the specified Kind must be in the core API group.
- For any other third-party types, APIGroup is required.
+ description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
type: string
kind:
description: Kind is the type of resource being referenced
@@ -4762,40 +3026,10 @@ spec:
type: object
x-kubernetes-map-type: atomic
dataSourceRef:
- description: 'dataSourceRef specifies the object from
- which to populate the volume with data, if a non-empty
- volume is desired. This may be any object from a non-empty
- API group (non core object) or a PersistentVolumeClaim
- object. When this field is specified, volume binding
- will only succeed if the type of the specified object
- matches some installed volume populator or dynamic provisioner.
- This field will replace the functionality of the dataSource
- field and as such if both fields are non-empty, they
- must have the same value. For backwards compatibility,
- when namespace isn''t specified in dataSourceRef, both
- fields (dataSource and dataSourceRef) will be set to
- the same value automatically if one of them is empty
- and the other is non-empty. When namespace is specified
- in dataSourceRef, dataSource isn''t set to the same
- value and must be empty. There are three important differences
- between dataSource and dataSourceRef: * While dataSource
- only allows two specific types of objects, dataSourceRef
- allows any non-core object, as well as PersistentVolumeClaim
- objects. * While dataSource ignores disallowed values
- (dropping them), dataSourceRef preserves all values,
- and generates an error if a disallowed value is specified.
- * While dataSource only allows local objects, dataSourceRef
- allows objects in any namespaces. (Beta) Using this
- field requires the AnyVolumeDataSource feature gate
- to be enabled. (Alpha) Using the namespace field of
- dataSourceRef requires the CrossNamespaceVolumeDataSource
- feature gate to be enabled.'
+ description: 'dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn''t specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn''t set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.'
properties:
apiGroup:
- description: APIGroup is the group for the resource
- being referenced. If APIGroup is not specified,
- the specified Kind must be in the core API group.
- For any other third-party types, APIGroup is required.
+ description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
type: string
kind:
description: Kind is the type of resource being referenced
@@ -4804,42 +3038,22 @@ spec:
description: Name is the name of resource being referenced
type: string
namespace:
- description: Namespace is the namespace of resource
- being referenced Note that when a namespace is specified,
- a gateway.networking.k8s.io/ReferenceGrant object
- is required in the referent namespace to allow that
- namespace's owner to accept the reference. See the
- ReferenceGrant documentation for details. (Alpha)
- This field requires the CrossNamespaceVolumeDataSource
- feature gate to be enabled.
+ description: Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
type: string
required:
- kind
- name
type: object
resources:
- description: 'resources represents the minimum resources
- the volume should have. If RecoverVolumeExpansionFailure
- feature is enabled users are allowed to specify resource
- requirements that are lower than previous value but
- must still be higher than capacity recorded in the status
- field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
+ description: 'resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
properties:
claims:
- description: "Claims lists the names of resources,
- defined in spec.resourceClaims, that are used by
- this container. \n This is an alpha field and requires
- enabling the DynamicResourceAllocation feature gate.
- \n This field is immutable."
+ description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable."
items:
- description: ResourceClaim references one entry
- in PodSpec.ResourceClaims.
+ description: ResourceClaim references one entry in PodSpec.ResourceClaims.
properties:
name:
- description: Name must match the name of one
- entry in pod.spec.resourceClaims of the Pod
- where this field is used. It makes that resource
- available inside a container.
+ description: Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
type: string
required:
- name
@@ -4855,8 +3069,7 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount
- of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -4865,41 +3078,25 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Requests describes the minimum amount
- of compute resources required. If Requests is omitted
- for a container, it defaults to Limits if that is
- explicitly specified, otherwise to an implementation-defined
- value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
selector:
- description: selector is a label query over volumes to
- consider for binding.
+ description: selector is a label query over volumes to consider for binding.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector
- requirements. The requirements are ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a selector
- that contains values, a key, and an operator that
- relates the key and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the selector
- applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship
- to a set of values. Valid operators are In,
- NotIn, Exists and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string values.
- If the operator is In or NotIn, the values
- array must be non-empty. If the operator is
- Exists or DoesNotExist, the values array must
- be empty. This array is replaced during a
- strategic merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -4911,35 +3108,25 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value} pairs.
- A single {key,value} in the matchLabels map is equivalent
- to an element of matchExpressions, whose key field
- is "key", the operator is "In", and the values array
- contains only "value". The requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
storageClassName:
- description: 'storageClassName is the name of the StorageClass
- required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
+ description: 'storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
type: string
volumeMode:
- description: volumeMode defines what type of volume is
- required by the claim. Value of Filesystem is implied
- when not included in claim spec.
+ description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
type: string
volumeName:
- description: volumeName is the binding reference to the
- PersistentVolume backing this claim.
+ description: volumeName is the binding reference to the PersistentVolume backing this claim.
type: string
type: object
status:
- description: 'Status represents the current information/status
- of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
+ description: 'Status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
properties:
accessModes:
- description: 'accessModes contains the actual access modes
- the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
+ description: 'accessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
items:
type: string
type: array
@@ -4950,19 +3137,7 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: allocatedResources is the storage resource
- within AllocatedResources tracks the capacity allocated
- to a PVC. It may be larger than the actual capacity
- when a volume expansion operation is requested. For
- storage quota, the larger value from allocatedResources
- and PVC.spec.resources is used. If allocatedResources
- is not set, PVC.spec.resources alone is used for quota
- calculation. If a volume expansion capacity request
- is lowered, allocatedResources is only lowered if there
- are no expansion operations in progress and if the actual
- volume capacity is equal or lower than the requested
- capacity. This is an alpha field and requires enabling
- RecoverVolumeExpansionFailure feature.
+ description: allocatedResources is the storage resource within AllocatedResources tracks the capacity allocated to a PVC. It may be larger than the actual capacity when a volume expansion operation is requested. For storage quota, the larger value from allocatedResources and PVC.spec.resources is used. If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation. If a volume expansion capacity request is lowered, allocatedResources is only lowered if there are no expansion operations in progress and if the actual volume capacity is equal or lower than the requested capacity. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
type: object
capacity:
additionalProperties:
@@ -4971,43 +3146,31 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: capacity represents the actual resources
- of the underlying volume.
+ description: capacity represents the actual resources of the underlying volume.
type: object
conditions:
- description: conditions is the current Condition of persistent
- volume claim. If underlying persistent volume is being
- resized then the Condition will be set to 'ResizeStarted'.
+ description: conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'.
items:
- description: PersistentVolumeClaimCondition contails
- details about state of pvc
+ description: PersistentVolumeClaimCondition contails details about state of pvc
properties:
lastProbeTime:
- description: lastProbeTime is the time we probed
- the condition.
+ description: lastProbeTime is the time we probed the condition.
format: date-time
type: string
lastTransitionTime:
- description: lastTransitionTime is the time the
- condition transitioned from one status to another.
+ description: lastTransitionTime is the time the condition transitioned from one status to another.
format: date-time
type: string
message:
- description: message is the human-readable message
- indicating details about last transition.
+ description: message is the human-readable message indicating details about last transition.
type: string
reason:
- description: reason is a unique, this should be
- a short, machine understandable string that gives
- the reason for condition's last transition. If
- it reports "ResizeStarted" that means the underlying
- persistent volume is being resized.
+ description: reason is a unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "ResizeStarted" that means the underlying persistent volume is being resized.
type: string
status:
type: string
type:
- description: PersistentVolumeClaimConditionType
- is a valid value of PersistentVolumeClaimCondition.Type
+ description: PersistentVolumeClaimConditionType is a valid value of PersistentVolumeClaimCondition.Type
type: string
required:
- status
@@ -5018,95 +3181,58 @@ spec:
description: phase represents the current phase of PersistentVolumeClaim.
type: string
resizeStatus:
- description: resizeStatus stores status of resize operation.
- ResizeStatus is not set by default but when expansion
- is complete resizeStatus is set to empty string by resize
- controller or kubelet. This is an alpha field and requires
- enabling RecoverVolumeExpansionFailure feature.
+ description: resizeStatus stores status of resize operation. ResizeStatus is not set by default but when expansion is complete resizeStatus is set to empty string by resize controller or kubelet. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
type: string
type: object
type: object
type: object
tag:
- description: 'Tag of Alertmanager container image to be deployed.
- Defaults to the value of `version`. Version is ignored if Tag is
- set. Deprecated: use ''image'' instead. The image tag can be specified
- as part of the image URL.'
+ description: 'Tag of Alertmanager container image to be deployed. Defaults to the value of `version`. Version is ignored if Tag is set. Deprecated: use ''image'' instead. The image tag can be specified as part of the image URL.'
type: string
tolerations:
description: If specified, the pod's tolerations.
items:
- description: The pod this Toleration is attached to tolerates any
- taint that matches the triple <key,value,effect> using the matching
- operator <operator>.
+ description: The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
properties:
effect:
- description: Effect indicates the taint effect to match. Empty
- means match all taint effects. When specified, allowed values
- are NoSchedule, PreferNoSchedule and NoExecute.
+ description: Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
type: string
key:
- description: Key is the taint key that the toleration applies
- to. Empty means match all taint keys. If the key is empty,
- operator must be Exists; this combination means to match all
- values and all keys.
+ description: Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
type: string
operator:
- description: Operator represents a key's relationship to the
- value. Valid operators are Exists and Equal. Defaults to Equal.
- Exists is equivalent to wildcard for value, so that a pod
- can tolerate all taints of a particular category.
+ description: Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
type: string
tolerationSeconds:
- description: TolerationSeconds represents the period of time
- the toleration (which must be of effect NoExecute, otherwise
- this field is ignored) tolerates the taint. By default, it
- is not set, which means tolerate the taint forever (do not
- evict). Zero and negative values will be treated as 0 (evict
- immediately) by the system.
+ description: TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
format: int64
type: integer
value:
- description: Value is the taint value the toleration matches
- to. If the operator is Exists, the value should be empty,
- otherwise just a regular string.
+ description: Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
type: string
type: object
type: array
topologySpreadConstraints:
description: If specified, the pod's topology spread constraints.
items:
- description: TopologySpreadConstraint specifies how to spread matching
- pods among the given topology.
+ description: TopologySpreadConstraint specifies how to spread matching pods among the given topology.
properties:
labelSelector:
- description: LabelSelector is used to find matching pods. Pods
- that match this label selector are counted to determine the
- number of pods in their corresponding topology domain.
+ description: LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector
- requirements. The requirements are ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a selector
- that contains values, a key, and an operator that relates
- the key and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the selector
- applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship
- to a set of values. Valid operators are In, NotIn,
- Exists and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string values.
- If the operator is In or NotIn, the values array
- must be non-empty. If the operator is Exists or
- DoesNotExist, the values array must be empty. This
- array is replaced during a strategic merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -5118,122 +3244,35 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value} pairs.
- A single {key,value} in the matchLabels map is equivalent
- to an element of matchExpressions, whose key field is
- "key", the operator is "In", and the values array contains
- only "value". The requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
matchLabelKeys:
- description: MatchLabelKeys is a set of pod label keys to select
- the pods over which spreading will be calculated. The keys
- are used to lookup values from the incoming pod labels, those
- key-value labels are ANDed with labelSelector to select the
- group of existing pods over which spreading will be calculated
- for the incoming pod. Keys that don't exist in the incoming
- pod labels will be ignored. A null or empty list means only
- match against labelSelector.
+ description: MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated. The keys are used to lookup values from the incoming pod labels, those key-value labels are ANDed with labelSelector to select the group of existing pods over which spreading will be calculated for the incoming pod. Keys that don't exist in the incoming pod labels will be ignored. A null or empty list means only match against labelSelector.
items:
type: string
type: array
x-kubernetes-list-type: atomic
maxSkew:
- description: 'MaxSkew describes the degree to which pods may
- be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`,
- it is the maximum permitted difference between the number
- of matching pods in the target topology and the global minimum.
- The global minimum is the minimum number of matching pods
- in an eligible domain or zero if the number of eligible domains
- is less than MinDomains. For example, in a 3-zone cluster,
- MaxSkew is set to 1, and pods with the same labelSelector
- spread as 2/2/1: In this case, the global minimum is 1. |
- zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew
- is 1, incoming pod can only be scheduled to zone3 to become
- 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1)
- on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming
- pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`,
- it is used to give higher precedence to topologies that satisfy
- it. It''s a required field. Default value is 1 and 0 is not
- allowed.'
+ description: 'MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It''s a required field. Default value is 1 and 0 is not allowed.'
format: int32
type: integer
minDomains:
- description: "MinDomains indicates a minimum number of eligible
- domains. When the number of eligible domains with matching
- topology keys is less than minDomains, Pod Topology Spread
- treats \"global minimum\" as 0, and then the calculation of
- Skew is performed. And when the number of eligible domains
- with matching topology keys equals or greater than minDomains,
- this value has no effect on scheduling. As a result, when
- the number of eligible domains is less than minDomains, scheduler
- won't schedule more than maxSkew Pods to those domains. If
- value is nil, the constraint behaves as if MinDomains is equal
- to 1. Valid values are integers greater than 0. When value
- is not nil, WhenUnsatisfiable must be DoNotSchedule. \n For
- example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains
- is set to 5 and pods with the same labelSelector spread as
- 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P |
- The number of domains is less than 5(MinDomains), so \"global
- minimum\" is treated as 0. In this situation, new pod with
- the same labelSelector cannot be scheduled, because computed
- skew will be 3(3 - 0) if new Pod is scheduled to any of the
- three zones, it will violate MaxSkew. \n This is a beta field
- and requires the MinDomainsInPodTopologySpread feature gate
- to be enabled (enabled by default)."
+ description: "MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats \"global minimum\" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule. \n For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so \"global minimum\" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew. \n This is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default)."
format: int32
type: integer
nodeAffinityPolicy:
- description: "NodeAffinityPolicy indicates how we will treat
- Pod's nodeAffinity/nodeSelector when calculating pod topology
- spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector
- are included in the calculations. - Ignore: nodeAffinity/nodeSelector
- are ignored. All nodes are included in the calculations. \n
- If this value is nil, the behavior is equivalent to the Honor
- policy. This is a beta-level feature default enabled by the
- NodeInclusionPolicyInPodTopologySpread feature flag."
+ description: "NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations. \n If this value is nil, the behavior is equivalent to the Honor policy. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag."
type: string
nodeTaintsPolicy:
- description: "NodeTaintsPolicy indicates how we will treat node
- taints when calculating pod topology spread skew. Options
- are: - Honor: nodes without taints, along with tainted nodes
- for which the incoming pod has a toleration, are included.
- - Ignore: node taints are ignored. All nodes are included.
- \n If this value is nil, the behavior is equivalent to the
- Ignore policy. This is a beta-level feature default enabled
- by the NodeInclusionPolicyInPodTopologySpread feature flag."
+ description: "NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included. \n If this value is nil, the behavior is equivalent to the Ignore policy. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag."
type: string
topologyKey:
- description: TopologyKey is the key of node labels. Nodes that
- have a label with this key and identical values are considered
- to be in the same topology. We consider each <key, value>
- as a "bucket", and try to put balanced number of pods into
- each bucket. We define a domain as a particular instance of
- a topology. Also, we define an eligible domain as a domain
- whose nodes meet the requirements of nodeAffinityPolicy and
- nodeTaintsPolicy. e.g. If TopologyKey is "kubernetes.io/hostname",
- each Node is a domain of that topology. And, if TopologyKey
- is "topology.kubernetes.io/zone", each zone is a domain of
- that topology. It's a required field.
+ description: TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a "bucket", and try to put balanced number of pods into each bucket. We define a domain as a particular instance of a topology. Also, we define an eligible domain as a domain whose nodes meet the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. It's a required field.
type: string
whenUnsatisfiable:
- description: 'WhenUnsatisfiable indicates how to deal with a
- pod if it doesn''t satisfy the spread constraint. - DoNotSchedule
- (default) tells the scheduler not to schedule it. - ScheduleAnyway
- tells the scheduler to schedule the pod in any location, but
- giving higher precedence to topologies that would help reduce
- the skew. A constraint is considered "Unsatisfiable" for an
- incoming pod if and only if every possible node assignment
- for that pod would violate "MaxSkew" on some topology. For
- example, in a 3-zone cluster, MaxSkew is set to 1, and pods
- with the same labelSelector spread as 3/1/1: | zone1 | zone2
- | zone3 | | P P P | P | P | If WhenUnsatisfiable is
- set to DoNotSchedule, incoming pod can only be scheduled to
- zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on
- zone2(zone3) satisfies MaxSkew(1). In other words, the cluster
- can still be imbalanced, but scheduler won''t make it *more*
- imbalanced. It''s a required field.'
+ description: 'WhenUnsatisfiable indicates how to deal with a pod if it doesn''t satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won''t make it *more* imbalanced. It''s a required field.'
type: string
required:
- maxSkew
@@ -5245,41 +3284,27 @@ spec:
description: Version the cluster should be on.
type: string
volumeMounts:
- description: VolumeMounts allows configuration of additional VolumeMounts
- on the output StatefulSet definition. VolumeMounts specified will
- be appended to other VolumeMounts in the alertmanager container,
- that are generated as a result of StorageSpec objects.
+ description: VolumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition. VolumeMounts specified will be appended to other VolumeMounts in the alertmanager container, that are generated as a result of StorageSpec objects.
items:
- description: VolumeMount describes a mounting of a Volume within
- a container.
+ description: VolumeMount describes a mounting of a Volume within a container.
properties:
mountPath:
- description: Path within the container at which the volume should
- be mounted. Must not contain ':'.
+ description: Path within the container at which the volume should be mounted. Must not contain ':'.
type: string
mountPropagation:
- description: mountPropagation determines how mounts are propagated
- from the host to container and the other way around. When
- not set, MountPropagationNone is used. This field is beta
- in 1.10.
+ description: mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.
type: string
name:
description: This must match the Name of a Volume.
type: string
readOnly:
- description: Mounted read-only if true, read-write otherwise
- (false or unspecified). Defaults to false.
+ description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
type: boolean
subPath:
- description: Path within the volume from which the container's
- volume should be mounted. Defaults to "" (volume's root).
+ description: Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
type: string
subPathExpr:
- description: Expanded path within the volume from which the
- container's volume should be mounted. Behaves similarly to
- SubPath but environment variable references $(VAR_NAME) are
- expanded using the container's environment. Defaults to ""
- (volume's root). SubPathExpr and SubPath are mutually exclusive.
+ description: Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.
type: string
required:
- mountPath
@@ -5287,93 +3312,62 @@ spec:
type: object
type: array
volumes:
- description: Volumes allows configuration of additional volumes on
- the output StatefulSet definition. Volumes specified will be appended
- to other volumes that are generated as a result of StorageSpec objects.
+ description: Volumes allows configuration of additional volumes on the output StatefulSet definition. Volumes specified will be appended to other volumes that are generated as a result of StorageSpec objects.
items:
- description: Volume represents a named volume in a pod that may
- be accessed by any container in the pod.
+ description: Volume represents a named volume in a pod that may be accessed by any container in the pod.
properties:
awsElasticBlockStore:
- description: 'awsElasticBlockStore represents an AWS Disk resource
- that is attached to a kubelet''s host machine and then exposed
- to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
+ description: 'awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet''s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
properties:
fsType:
- description: 'fsType is the filesystem type of the volume
- that you want to mount. Tip: Ensure that the filesystem
- type is supported by the host operating system. Examples:
- "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4"
- if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
- TODO: how do we prevent errors in the filesystem from
- compromising the machine'
+ description: 'fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine'
type: string
partition:
- description: 'partition is the partition in the volume that
- you want to mount. If omitted, the default is to mount
- by volume name. Examples: For volume /dev/sda1, you specify
- the partition as "1". Similarly, the volume partition
- for /dev/sda is "0" (or you can leave the property empty).'
+ description: 'partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).'
format: int32
type: integer
readOnly:
- description: 'readOnly value true will force the readOnly
- setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
+ description: 'readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
type: boolean
volumeID:
- description: 'volumeID is unique ID of the persistent disk
- resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
+ description: 'volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
type: string
required:
- volumeID
type: object
azureDisk:
- description: azureDisk represents an Azure Data Disk mount on
- the host and bind mount to the pod.
+ description: azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
properties:
cachingMode:
- description: 'cachingMode is the Host Caching mode: None,
- Read Only, Read Write.'
+ description: 'cachingMode is the Host Caching mode: None, Read Only, Read Write.'
type: string
diskName:
- description: diskName is the Name of the data disk in the
- blob storage
+ description: diskName is the Name of the data disk in the blob storage
type: string
diskURI:
- description: diskURI is the URI of data disk in the blob
- storage
+ description: diskURI is the URI of data disk in the blob storage
type: string
fsType:
- description: fsType is Filesystem type to mount. Must be
- a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4"
- if unspecified.
+ description: fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
type: string
kind:
- description: 'kind expected values are Shared: multiple
- blob disks per storage account Dedicated: single blob
- disk per storage account Managed: azure managed data
- disk (only in managed availability set). defaults to shared'
+ description: 'kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared'
type: string
readOnly:
- description: readOnly Defaults to false (read/write). ReadOnly
- here will force the ReadOnly setting in VolumeMounts.
+ description: readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
type: boolean
required:
- diskName
- diskURI
type: object
azureFile:
- description: azureFile represents an Azure File Service mount
- on the host and bind mount to the pod.
+ description: azureFile represents an Azure File Service mount on the host and bind mount to the pod.
properties:
readOnly:
- description: readOnly defaults to false (read/write). ReadOnly
- here will force the ReadOnly setting in VolumeMounts.
+ description: readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
type: boolean
secretName:
- description: secretName is the name of secret that contains
- Azure Storage Account Name and Key
+ description: secretName is the name of secret that contains Azure Storage Account Name and Key
type: string
shareName:
description: shareName is the azure share Name
@@ -5383,105 +3377,68 @@ spec:
- shareName
type: object
cephfs:
- description: cephFS represents a Ceph FS mount on the host that
- shares a pod's lifetime
+ description: cephFS represents a Ceph FS mount on the host that shares a pod's lifetime
properties:
monitors:
- description: 'monitors is Required: Monitors is a collection
- of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
+ description: 'monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
items:
type: string
type: array
path:
- description: 'path is Optional: Used as the mounted root,
- rather than the full Ceph tree, default is /'
+ description: 'path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /'
type: string
readOnly:
- description: 'readOnly is Optional: Defaults to false (read/write).
- ReadOnly here will force the ReadOnly setting in VolumeMounts.
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
+ description: 'readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
type: boolean
secretFile:
- description: 'secretFile is Optional: SecretFile is the
- path to key ring for User, default is /etc/ceph/user.secret
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
+ description: 'secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
type: string
secretRef:
- description: 'secretRef is Optional: SecretRef is reference
- to the authentication secret for User, default is empty.
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
+ description: 'secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
x-kubernetes-map-type: atomic
user:
- description: 'user is optional: User is the rados user name,
- default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
+ description: 'user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
type: string
required:
- monitors
type: object
cinder:
- description: 'cinder represents a cinder volume attached and
- mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
+ description: 'cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
properties:
fsType:
- description: 'fsType is the filesystem type to mount. Must
- be a filesystem type supported by the host operating system.
- Examples: "ext4", "xfs", "ntfs". Implicitly inferred to
- be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
+ description: 'fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
type: string
readOnly:
- description: 'readOnly defaults to false (read/write). ReadOnly
- here will force the ReadOnly setting in VolumeMounts.
- More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
+ description: 'readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
type: boolean
secretRef:
- description: 'secretRef is optional: points to a secret
- object containing parameters used to connect to OpenStack.'
+ description: 'secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
x-kubernetes-map-type: atomic
volumeID:
- description: 'volumeID used to identify the volume in cinder.
- More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
+ description: 'volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
type: string
required:
- volumeID
type: object
configMap:
- description: configMap represents a configMap that should populate
- this volume
+ description: configMap represents a configMap that should populate this volume
properties:
defaultMode:
- description: 'defaultMode is optional: mode bits used to
- set permissions on created files by default. Must be an
- octal value between 0000 and 0777 or a decimal value between
- 0 and 511. YAML accepts both octal and decimal values,
- JSON requires decimal values for mode bits. Defaults to
- 0644. Directories within the path are not affected by
- this setting. This might be in conflict with other options
- that affect the file mode, like fsGroup, and the result
- can be other mode bits set.'
+ description: 'defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
format: int32
type: integer
items:
- description: items if unspecified, each key-value pair in
- the Data field of the referenced ConfigMap will be projected
- into the volume as a file whose name is the key and content
- is the value. If specified, the listed keys will be projected
- into the specified paths, and unlisted keys will not be
- present. If a key is specified which is not present in
- the ConfigMap, the volume setup will error unless it is
- marked optional. Paths must be relative and may not contain
- the '..' path or start with '..'.
+ description: items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
items:
description: Maps a string key to a path within a volume.
properties:
@@ -5489,22 +3446,11 @@ spec:
description: key is the key to project.
type: string
mode:
- description: 'mode is Optional: mode bits used to
- set permissions on this file. Must be an octal value
- between 0000 and 0777 or a decimal value between
- 0 and 511. YAML accepts both octal and decimal values,
- JSON requires decimal values for mode bits. If not
- specified, the volume defaultMode will be used.
- This might be in conflict with other options that
- affect the file mode, like fsGroup, and the result
- can be other mode bits set.'
+ description: 'mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
format: int32
type: integer
path:
- description: path is the relative path of the file
- to map the key to. May not be an absolute path.
- May not contain the path element '..'. May not start
- with the string '..'.
+ description: path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
type: string
required:
- key
@@ -5512,135 +3458,84 @@ spec:
type: object
type: array
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: optional specify whether the ConfigMap or its
- keys must be defined
+ description: optional specify whether the ConfigMap or its keys must be defined
type: boolean
type: object
x-kubernetes-map-type: atomic
csi:
- description: csi (Container Storage Interface) represents ephemeral
- storage that is handled by certain external CSI drivers (Beta
- feature).
+ description: csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
properties:
driver:
- description: driver is the name of the CSI driver that handles
- this volume. Consult with your admin for the correct name
- as registered in the cluster.
+ description: driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.
type: string
fsType:
- description: fsType to mount. Ex. "ext4", "xfs", "ntfs".
- If not provided, the empty value is passed to the associated
- CSI driver which will determine the default filesystem
- to apply.
+ description: fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.
type: string
nodePublishSecretRef:
- description: nodePublishSecretRef is a reference to the
- secret object containing sensitive information to pass
- to the CSI driver to complete the CSI NodePublishVolume
- and NodeUnpublishVolume calls. This field is optional,
- and may be empty if no secret is required. If the secret
- object contains more than one secret, all secret references
- are passed.
+ description: nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
x-kubernetes-map-type: atomic
readOnly:
- description: readOnly specifies a read-only configuration
- for the volume. Defaults to false (read/write).
+ description: readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).
type: boolean
volumeAttributes:
additionalProperties:
type: string
- description: volumeAttributes stores driver-specific properties
- that are passed to the CSI driver. Consult your driver's
- documentation for supported values.
+ description: volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.
type: object
required:
- driver
type: object
downwardAPI:
- description: downwardAPI represents downward API about the pod
- that should populate this volume
+ description: downwardAPI represents downward API about the pod that should populate this volume
properties:
defaultMode:
- description: 'Optional: mode bits to use on created files
- by default. Must be a Optional: mode bits used to set
- permissions on created files by default. Must be an octal
- value between 0000 and 0777 or a decimal value between
- 0 and 511. YAML accepts both octal and decimal values,
- JSON requires decimal values for mode bits. Defaults to
- 0644. Directories within the path are not affected by
- this setting. This might be in conflict with other options
- that affect the file mode, like fsGroup, and the result
- can be other mode bits set.'
+ description: 'Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
format: int32
type: integer
items:
description: Items is a list of downward API volume file
items:
- description: DownwardAPIVolumeFile represents information
- to create the file containing the pod field
+ description: DownwardAPIVolumeFile represents information to create the file containing the pod field
properties:
fieldRef:
- description: 'Required: Selects a field of the pod:
- only annotations, labels, name and namespace are
- supported.'
+ description: 'Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.'
properties:
apiVersion:
- description: Version of the schema the FieldPath
- is written in terms of, defaults to "v1".
+ description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
type: string
fieldPath:
- description: Path of the field to select in the
- specified API version.
+ description: Path of the field to select in the specified API version.
type: string
required:
- fieldPath
type: object
x-kubernetes-map-type: atomic
mode:
- description: 'Optional: mode bits used to set permissions
- on this file, must be an octal value between 0000
- and 0777 or a decimal value between 0 and 511. YAML
- accepts both octal and decimal values, JSON requires
- decimal values for mode bits. If not specified,
- the volume defaultMode will be used. This might
- be in conflict with other options that affect the
- file mode, like fsGroup, and the result can be other
- mode bits set.'
+ description: 'Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
format: int32
type: integer
path:
- description: 'Required: Path is the relative path
- name of the file to be created. Must not be absolute
- or contain the ''..'' path. Must be utf-8 encoded.
- The first item of the relative path must not start
- with ''..'''
+ description: 'Required: Path is the relative path name of the file to be created. Must not be absolute or contain the ''..'' path. Must be utf-8 encoded. The first item of the relative path must not start with ''..'''
type: string
resourceFieldRef:
- description: 'Selects a resource of the container:
- only resources limits and requests (limits.cpu,
- limits.memory, requests.cpu and requests.memory)
- are currently supported.'
+ description: 'Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.'
properties:
containerName:
- description: 'Container name: required for volumes,
- optional for env vars'
+ description: 'Container name: required for volumes, optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format of the
- exposed resources, defaults to "1"
+ description: Specifies the output format of the exposed resources, defaults to "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
@@ -5656,114 +3551,47 @@ spec:
type: array
type: object
emptyDir:
- description: 'emptyDir represents a temporary directory that
- shares a pod''s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
+ description: 'emptyDir represents a temporary directory that shares a pod''s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
properties:
medium:
- description: 'medium represents what type of storage medium
- should back this directory. The default is "" which means
- to use the node''s default medium. Must be an empty string
- (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
+ description: 'medium represents what type of storage medium should back this directory. The default is "" which means to use the node''s default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
type: string
sizeLimit:
anyOf:
- type: integer
- type: string
- description: 'sizeLimit is the total amount of local storage
- required for this EmptyDir volume. The size limit is also
- applicable for memory medium. The maximum usage on memory
- medium EmptyDir would be the minimum value between the
- SizeLimit specified here and the sum of memory limits
- of all containers in a pod. The default is nil which means
- that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir'
+ description: 'sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir'
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
type: object
ephemeral:
- description: "ephemeral represents a volume that is handled
- by a cluster storage driver. The volume's lifecycle is tied
- to the pod that defines it - it will be created before the
- pod starts, and deleted when the pod is removed. \n Use this
- if: a) the volume is only needed while the pod runs, b) features
- of normal volumes like restoring from snapshot or capacity
- tracking are needed, c) the storage driver is specified through
- a storage class, and d) the storage driver supports dynamic
- volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource
- for more information on the connection between this volume
- type and PersistentVolumeClaim). \n Use PersistentVolumeClaim
- or one of the vendor-specific APIs for volumes that persist
- for longer than the lifecycle of an individual pod. \n Use
- CSI for light-weight local ephemeral volumes if the CSI driver
- is meant to be used that way - see the documentation of the
- driver for more information. \n A pod can use both types of
- ephemeral volumes and persistent volumes at the same time."
+ description: "ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. \n Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). \n Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. \n Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. \n A pod can use both types of ephemeral volumes and persistent volumes at the same time."
properties:
volumeClaimTemplate:
- description: "Will be used to create a stand-alone PVC to
- provision the volume. The pod in which this EphemeralVolumeSource
- is embedded will be the owner of the PVC, i.e. the PVC
- will be deleted together with the pod. The name of the
- PVC will be `<pod name>-<volume name>` where `<volume
- name>` is the name from the `PodSpec.Volumes` array entry.
- Pod validation will reject the pod if the concatenated
- name is not valid for a PVC (for example, too long). \n
- An existing PVC with that name that is not owned by the
- pod will *not* be used for the pod to avoid using an unrelated
- volume by mistake. Starting the pod is then blocked until
- the unrelated PVC is removed. If such a pre-created PVC
- is meant to be used by the pod, the PVC has to updated
- with an owner reference to the pod once the pod exists.
- Normally this should not be necessary, but it may be useful
- when manually reconstructing a broken cluster. \n This
- field is read-only and no changes will be made by Kubernetes
- to the PVC after it has been created. \n Required, must
- not be nil."
+ description: "Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `<pod name>-<volume name>` where `<volume name>` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). \n An existing PVC with that name that is not owned by the pod will *not* be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. \n This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. \n Required, must not be nil."
properties:
metadata:
- description: May contain labels and annotations that
- will be copied into the PVC when creating it. No other
- fields are allowed and will be rejected during validation.
+ description: May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.
type: object
spec:
- description: The specification for the PersistentVolumeClaim.
- The entire content is copied unchanged into the PVC
- that gets created from this template. The same fields
- as in a PersistentVolumeClaim are also valid here.
+ description: The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
properties:
accessModes:
- description: 'accessModes contains the desired access
- modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
+ description: 'accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
items:
type: string
type: array
dataSource:
- description: 'dataSource field can be used to specify
- either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
- * An existing PVC (PersistentVolumeClaim) If the
- provisioner or an external controller can support
- the specified data source, it will create a new
- volume based on the contents of the specified
- data source. When the AnyVolumeDataSource feature
- gate is enabled, dataSource contents will be copied
- to dataSourceRef, and dataSourceRef contents will
- be copied to dataSource when dataSourceRef.namespace
- is not specified. If the namespace is specified,
- then dataSourceRef will not be copied to dataSource.'
+ description: 'dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.'
properties:
apiGroup:
- description: APIGroup is the group for the resource
- being referenced. If APIGroup is not specified,
- the specified Kind must be in the core API
- group. For any other third-party types, APIGroup
- is required.
+ description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
type: string
kind:
- description: Kind is the type of resource being
- referenced
+ description: Kind is the type of resource being referenced
type: string
name:
- description: Name is the name of resource being
- referenced
+ description: Name is the name of resource being referenced
type: string
required:
- kind
@@ -5771,93 +3599,34 @@ spec:
type: object
x-kubernetes-map-type: atomic
dataSourceRef:
- description: 'dataSourceRef specifies the object
- from which to populate the volume with data, if
- a non-empty volume is desired. This may be any
- object from a non-empty API group (non core object)
- or a PersistentVolumeClaim object. When this field
- is specified, volume binding will only succeed
- if the type of the specified object matches some
- installed volume populator or dynamic provisioner.
- This field will replace the functionality of the
- dataSource field and as such if both fields are
- non-empty, they must have the same value. For
- backwards compatibility, when namespace isn''t
- specified in dataSourceRef, both fields (dataSource
- and dataSourceRef) will be set to the same value
- automatically if one of them is empty and the
- other is non-empty. When namespace is specified
- in dataSourceRef, dataSource isn''t set to the
- same value and must be empty. There are three
- important differences between dataSource and dataSourceRef:
- * While dataSource only allows two specific types
- of objects, dataSourceRef allows any non-core
- object, as well as PersistentVolumeClaim objects.
- * While dataSource ignores disallowed values (dropping
- them), dataSourceRef preserves all values, and
- generates an error if a disallowed value is specified.
- * While dataSource only allows local objects,
- dataSourceRef allows objects in any namespaces.
- (Beta) Using this field requires the AnyVolumeDataSource
- feature gate to be enabled. (Alpha) Using the
- namespace field of dataSourceRef requires the
- CrossNamespaceVolumeDataSource feature gate to
- be enabled.'
+ description: 'dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn''t specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn''t set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.'
properties:
apiGroup:
- description: APIGroup is the group for the resource
- being referenced. If APIGroup is not specified,
- the specified Kind must be in the core API
- group. For any other third-party types, APIGroup
- is required.
+ description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
type: string
kind:
- description: Kind is the type of resource being
- referenced
+ description: Kind is the type of resource being referenced
type: string
name:
- description: Name is the name of resource being
- referenced
+ description: Name is the name of resource being referenced
type: string
namespace:
- description: Namespace is the namespace of resource
- being referenced Note that when a namespace
- is specified, a gateway.networking.k8s.io/ReferenceGrant
- object is required in the referent namespace
- to allow that namespace's owner to accept
- the reference. See the ReferenceGrant documentation
- for details. (Alpha) This field requires the
- CrossNamespaceVolumeDataSource feature gate
- to be enabled.
+ description: Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
type: string
required:
- kind
- name
type: object
resources:
- description: 'resources represents the minimum resources
- the volume should have. If RecoverVolumeExpansionFailure
- feature is enabled users are allowed to specify
- resource requirements that are lower than previous
- value but must still be higher than capacity recorded
- in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
+ description: 'resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
properties:
claims:
- description: "Claims lists the names of resources,
- defined in spec.resourceClaims, that are used
- by this container. \n This is an alpha field
- and requires enabling the DynamicResourceAllocation
- feature gate. \n This field is immutable."
+ description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable."
items:
- description: ResourceClaim references one
- entry in PodSpec.ResourceClaims.
+ description: ResourceClaim references one entry in PodSpec.ResourceClaims.
properties:
name:
- description: Name must match the name
- of one entry in pod.spec.resourceClaims
- of the Pod where this field is used.
- It makes that resource available inside
- a container.
+ description: Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
type: string
required:
- name
@@ -5873,8 +3642,7 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount
- of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -5883,46 +3651,25 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Requests describes the minimum
- amount of compute resources required. If Requests
- is omitted for a container, it defaults to
- Limits if that is explicitly specified, otherwise
- to an implementation-defined value. More info:
- https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
selector:
- description: selector is a label query over volumes
- to consider for binding.
+ description: selector is a label query over volumes to consider for binding.
properties:
matchExpressions:
- description: matchExpressions is a list of label
- selector requirements. The requirements are
- ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement
- is a selector that contains values, a key,
- and an operator that relates the key and
- values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that
- the selector applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's
- relationship to a set of values. Valid
- operators are In, NotIn, Exists and
- DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string
- values. If the operator is In or NotIn,
- the values array must be non-empty.
- If the operator is Exists or DoesNotExist,
- the values array must be empty. This
- array is replaced during a strategic
- merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -5934,28 +3681,18 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value}
- pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions,
- whose key field is "key", the operator is
- "In", and the values array contains only "value".
- The requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
storageClassName:
- description: 'storageClassName is the name of the
- StorageClass required by the claim. More info:
- https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
+ description: 'storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
type: string
volumeMode:
- description: volumeMode defines what type of volume
- is required by the claim. Value of Filesystem
- is implied when not included in claim spec.
+ description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
type: string
volumeName:
- description: volumeName is the binding reference
- to the PersistentVolume backing this claim.
+ description: volumeName is the binding reference to the PersistentVolume backing this claim.
type: string
type: object
required:
@@ -5963,74 +3700,51 @@ spec:
type: object
type: object
fc:
- description: fc represents a Fibre Channel resource that is
- attached to a kubelet's host machine and then exposed to the
- pod.
+ description: fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
properties:
fsType:
- description: 'fsType is the filesystem type to mount. Must
- be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4"
- if unspecified. TODO: how do we prevent errors in the
- filesystem from compromising the machine'
+ description: 'fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine'
type: string
lun:
description: 'lun is Optional: FC target lun number'
format: int32
type: integer
readOnly:
- description: 'readOnly is Optional: Defaults to false (read/write).
- ReadOnly here will force the ReadOnly setting in VolumeMounts.'
+ description: 'readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.'
type: boolean
targetWWNs:
- description: 'targetWWNs is Optional: FC target worldwide
- names (WWNs)'
+ description: 'targetWWNs is Optional: FC target worldwide names (WWNs)'
items:
type: string
type: array
wwids:
- description: 'wwids Optional: FC volume world wide identifiers
- (wwids) Either wwids or combination of targetWWNs and
- lun must be set, but not both simultaneously.'
+ description: 'wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.'
items:
type: string
type: array
type: object
flexVolume:
- description: flexVolume represents a generic volume resource
- that is provisioned/attached using an exec based plugin.
+ description: flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
properties:
driver:
- description: driver is the name of the driver to use for
- this volume.
+ description: driver is the name of the driver to use for this volume.
type: string
fsType:
- description: fsType is the filesystem type to mount. Must
- be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". The default filesystem depends
- on FlexVolume script.
+ description: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
type: string
options:
additionalProperties:
type: string
- description: 'options is Optional: this field holds extra
- command options if any.'
+ description: 'options is Optional: this field holds extra command options if any.'
type: object
readOnly:
- description: 'readOnly is Optional: defaults to false (read/write).
- ReadOnly here will force the ReadOnly setting in VolumeMounts.'
+ description: 'readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.'
type: boolean
secretRef:
- description: 'secretRef is Optional: secretRef is reference
- to the secret object containing sensitive information
- to pass to the plugin scripts. This may be empty if no
- secret object is specified. If the secret object contains
- more than one secret, all secrets are passed to the plugin
- scripts.'
+ description: 'secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
x-kubernetes-map-type: atomic
@@ -6038,184 +3752,120 @@ spec:
- driver
type: object
flocker:
- description: flocker represents a Flocker volume attached to
- a kubelet's host machine. This depends on the Flocker control
- service being running
+ description: flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
properties:
datasetName:
- description: datasetName is Name of the dataset stored as
- metadata -> name on the dataset for Flocker should be
- considered as deprecated
+ description: datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
type: string
datasetUUID:
- description: datasetUUID is the UUID of the dataset. This
- is unique identifier of a Flocker dataset
+ description: datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
type: string
type: object
gcePersistentDisk:
- description: 'gcePersistentDisk represents a GCE Disk resource
- that is attached to a kubelet''s host machine and then exposed
- to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
+ description: 'gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet''s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
properties:
fsType:
- description: 'fsType is filesystem type of the volume that
- you want to mount. Tip: Ensure that the filesystem type
- is supported by the host operating system. Examples: "ext4",
- "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
- TODO: how do we prevent errors in the filesystem from
- compromising the machine'
+ description: 'fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine'
type: string
partition:
- description: 'partition is the partition in the volume that
- you want to mount. If omitted, the default is to mount
- by volume name. Examples: For volume /dev/sda1, you specify
- the partition as "1". Similarly, the volume partition
- for /dev/sda is "0" (or you can leave the property empty).
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
+ description: 'partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
format: int32
type: integer
pdName:
- description: 'pdName is unique name of the PD resource in
- GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
+ description: 'pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
type: string
readOnly:
- description: 'readOnly here will force the ReadOnly setting
- in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
+ description: 'readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
type: boolean
required:
- pdName
type: object
gitRepo:
- description: 'gitRepo represents a git repository at a particular
- revision. DEPRECATED: GitRepo is deprecated. To provision
- a container with a git repo, mount an EmptyDir into an InitContainer
- that clones the repo using git, then mount the EmptyDir into
- the Pod''s container.'
+ description: 'gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod''s container.'
properties:
directory:
- description: directory is the target directory name. Must
- not contain or start with '..'. If '.' is supplied, the
- volume directory will be the git repository. Otherwise,
- if specified, the volume will contain the git repository
- in the subdirectory with the given name.
+ description: directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.
type: string
repository:
description: repository is the URL
type: string
revision:
- description: revision is the commit hash for the specified
- revision.
+ description: revision is the commit hash for the specified revision.
type: string
required:
- repository
type: object
glusterfs:
- description: 'glusterfs represents a Glusterfs mount on the
- host that shares a pod''s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md'
+ description: 'glusterfs represents a Glusterfs mount on the host that shares a pod''s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md'
properties:
endpoints:
- description: 'endpoints is the endpoint name that details
- Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
+ description: 'endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: string
path:
- description: 'path is the Glusterfs volume path. More info:
- https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
+ description: 'path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: string
readOnly:
- description: 'readOnly here will force the Glusterfs volume
- to be mounted with read-only permissions. Defaults to
- false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
+ description: 'readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: boolean
required:
- endpoints
- path
type: object
hostPath:
- description: 'hostPath represents a pre-existing file or directory
- on the host machine that is directly exposed to the container.
- This is generally used for system agents or other privileged
- things that are allowed to see the host machine. Most containers
- will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
- --- TODO(jonesdl) We need to restrict who can use host directory
- mounts and who can/can not mount host directories as read/write.'
+ description: 'hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.'
properties:
path:
- description: 'path of the directory on the host. If the
- path is a symlink, it will follow the link to the real
- path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
+ description: 'path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
type: string
type:
- description: 'type for HostPath Volume Defaults to "" More
- info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
+ description: 'type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
type: string
required:
- path
type: object
iscsi:
- description: 'iscsi represents an ISCSI Disk resource that is
- attached to a kubelet''s host machine and then exposed to
- the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md'
+ description: 'iscsi represents an ISCSI Disk resource that is attached to a kubelet''s host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md'
properties:
chapAuthDiscovery:
- description: chapAuthDiscovery defines whether support iSCSI
- Discovery CHAP authentication
+ description: chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
type: boolean
chapAuthSession:
- description: chapAuthSession defines whether support iSCSI
- Session CHAP authentication
+ description: chapAuthSession defines whether support iSCSI Session CHAP authentication
type: boolean
fsType:
- description: 'fsType is the filesystem type of the volume
- that you want to mount. Tip: Ensure that the filesystem
- type is supported by the host operating system. Examples:
- "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4"
- if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
- TODO: how do we prevent errors in the filesystem from
- compromising the machine'
+ description: 'fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine'
type: string
initiatorName:
- description: initiatorName is the custom iSCSI Initiator
- Name. If initiatorName is specified with iscsiInterface
- simultaneously, new iSCSI interface <target portal>:<volume
- name> will be created for the connection.
+ description: initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.
type: string
iqn:
description: iqn is the target iSCSI Qualified Name.
type: string
iscsiInterface:
- description: iscsiInterface is the interface Name that uses
- an iSCSI transport. Defaults to 'default' (tcp).
+ description: iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
type: string
lun:
description: lun represents iSCSI Target Lun number.
format: int32
type: integer
portals:
- description: portals is the iSCSI Target Portal List. The
- portal is either an IP or ip_addr:port if the port is
- other than default (typically TCP ports 860 and 3260).
+ description: portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
items:
type: string
type: array
readOnly:
- description: readOnly here will force the ReadOnly setting
- in VolumeMounts. Defaults to false.
+ description: readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
type: boolean
secretRef:
- description: secretRef is the CHAP Secret for iSCSI target
- and initiator authentication
+ description: secretRef is the CHAP Secret for iSCSI target and initiator authentication
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
x-kubernetes-map-type: atomic
targetPortal:
- description: targetPortal is iSCSI Target Portal. The Portal
- is either an IP or ip_addr:port if the port is other than
- default (typically TCP ports 860 and 3260).
+ description: targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
type: string
required:
- iqn
@@ -6223,77 +3873,56 @@ spec:
- targetPortal
type: object
name:
- description: 'name of the volume. Must be a DNS_LABEL and unique
- within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+ description: 'name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
type: string
nfs:
- description: 'nfs represents an NFS mount on the host that shares
- a pod''s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
+ description: 'nfs represents an NFS mount on the host that shares a pod''s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
properties:
path:
- description: 'path that is exported by the NFS server. More
- info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
+ description: 'path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: string
readOnly:
- description: 'readOnly here will force the NFS export to
- be mounted with read-only permissions. Defaults to false.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
+ description: 'readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: boolean
server:
- description: 'server is the hostname or IP address of the
- NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
+ description: 'server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: string
required:
- path
- server
type: object
persistentVolumeClaim:
- description: 'persistentVolumeClaimVolumeSource represents a
- reference to a PersistentVolumeClaim in the same namespace.
- More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
+ description: 'persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
properties:
claimName:
- description: 'claimName is the name of a PersistentVolumeClaim
- in the same namespace as the pod using this volume. More
- info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
+ description: 'claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
type: string
readOnly:
- description: readOnly Will force the ReadOnly setting in
- VolumeMounts. Default false.
+ description: readOnly Will force the ReadOnly setting in VolumeMounts. Default false.
type: boolean
required:
- claimName
type: object
photonPersistentDisk:
- description: photonPersistentDisk represents a PhotonController
- persistent disk attached and mounted on kubelets host machine
+ description: photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
properties:
fsType:
- description: fsType is the filesystem type to mount. Must
- be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4"
- if unspecified.
+ description: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
type: string
pdID:
- description: pdID is the ID that identifies Photon Controller
- persistent disk
+ description: pdID is the ID that identifies Photon Controller persistent disk
type: string
required:
- pdID
type: object
portworxVolume:
- description: portworxVolume represents a portworx volume attached
- and mounted on kubelets host machine
+ description: portworxVolume represents a portworx volume attached and mounted on kubelets host machine
properties:
fsType:
- description: fSType represents the filesystem type to mount
- Must be a filesystem type supported by the host operating
- system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4"
- if unspecified.
+ description: fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
type: string
readOnly:
- description: readOnly defaults to false (read/write). ReadOnly
- here will force the ReadOnly setting in VolumeMounts.
+ description: readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
type: boolean
volumeID:
description: volumeID uniquely identifies a Portworx volume
@@ -6302,69 +3931,34 @@ spec:
- volumeID
type: object
projected:
- description: projected items for all in one resources secrets,
- configmaps, and downward API
+ description: projected items for all in one resources secrets, configmaps, and downward API
properties:
defaultMode:
- description: defaultMode are the mode bits used to set permissions
- on created files by default. Must be an octal value between
- 0000 and 0777 or a decimal value between 0 and 511. YAML
- accepts both octal and decimal values, JSON requires decimal
- values for mode bits. Directories within the path are
- not affected by this setting. This might be in conflict
- with other options that affect the file mode, like fsGroup,
- and the result can be other mode bits set.
+ description: defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
format: int32
type: integer
sources:
description: sources is the list of volume projections
items:
- description: Projection that may be projected along with
- other supported volume types
+ description: Projection that may be projected along with other supported volume types
properties:
configMap:
- description: configMap information about the configMap
- data to project
+ description: configMap information about the configMap data to project
properties:
items:
- description: items if unspecified, each key-value
- pair in the Data field of the referenced ConfigMap
- will be projected into the volume as a file
- whose name is the key and content is the value.
- If specified, the listed keys will be projected
- into the specified paths, and unlisted keys
- will not be present. If a key is specified which
- is not present in the ConfigMap, the volume
- setup will error unless it is marked optional.
- Paths must be relative and may not contain the
- '..' path or start with '..'.
+ description: items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
items:
- description: Maps a string key to a path within
- a volume.
+ description: Maps a string key to a path within a volume.
properties:
key:
description: key is the key to project.
type: string
mode:
- description: 'mode is Optional: mode bits
- used to set permissions on this file.
- Must be an octal value between 0000 and
- 0777 or a decimal value between 0 and
- 511. YAML accepts both octal and decimal
- values, JSON requires decimal values for
- mode bits. If not specified, the volume
- defaultMode will be used. This might be
- in conflict with other options that affect
- the file mode, like fsGroup, and the result
- can be other mode bits set.'
+ description: 'mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
format: int32
type: integer
path:
- description: path is the relative path of
- the file to map the key to. May not be
- an absolute path. May not contain the
- path element '..'. May not start with
- the string '..'.
+ description: path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
type: string
required:
- key
@@ -6372,91 +3966,56 @@ spec:
type: object
type: array
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: optional specify whether the ConfigMap
- or its keys must be defined
+ description: optional specify whether the ConfigMap or its keys must be defined
type: boolean
type: object
x-kubernetes-map-type: atomic
downwardAPI:
- description: downwardAPI information about the downwardAPI
- data to project
+ description: downwardAPI information about the downwardAPI data to project
properties:
items:
- description: Items is a list of DownwardAPIVolume
- file
+ description: Items is a list of DownwardAPIVolume file
items:
- description: DownwardAPIVolumeFile represents
- information to create the file containing
- the pod field
+ description: DownwardAPIVolumeFile represents information to create the file containing the pod field
properties:
fieldRef:
- description: 'Required: Selects a field
- of the pod: only annotations, labels,
- name and namespace are supported.'
+ description: 'Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.'
properties:
apiVersion:
- description: Version of the schema the
- FieldPath is written in terms of,
- defaults to "v1".
+ description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
type: string
fieldPath:
- description: Path of the field to select
- in the specified API version.
+ description: Path of the field to select in the specified API version.
type: string
required:
- fieldPath
type: object
x-kubernetes-map-type: atomic
mode:
- description: 'Optional: mode bits used to
- set permissions on this file, must be
- an octal value between 0000 and 0777 or
- a decimal value between 0 and 511. YAML
- accepts both octal and decimal values,
- JSON requires decimal values for mode
- bits. If not specified, the volume defaultMode
- will be used. This might be in conflict
- with other options that affect the file
- mode, like fsGroup, and the result can
- be other mode bits set.'
+ description: 'Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
format: int32
type: integer
path:
- description: 'Required: Path is the relative
- path name of the file to be created. Must
- not be absolute or contain the ''..''
- path. Must be utf-8 encoded. The first
- item of the relative path must not start
- with ''..'''
+ description: 'Required: Path is the relative path name of the file to be created. Must not be absolute or contain the ''..'' path. Must be utf-8 encoded. The first item of the relative path must not start with ''..'''
type: string
resourceFieldRef:
- description: 'Selects a resource of the
- container: only resources limits and requests
- (limits.cpu, limits.memory, requests.cpu
- and requests.memory) are currently supported.'
+ description: 'Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.'
properties:
containerName:
- description: 'Container name: required
- for volumes, optional for env vars'
+ description: 'Container name: required for volumes, optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format
- of the exposed resources, defaults
- to "1"
+ description: Specifies the output format of the exposed resources, defaults to "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
- description: 'Required: resource to
- select'
+ description: 'Required: resource to select'
type: string
required:
- resource
@@ -6468,48 +4027,22 @@ spec:
type: array
type: object
secret:
- description: secret information about the secret data
- to project
+ description: secret information about the secret data to project
properties:
items:
- description: items if unspecified, each key-value
- pair in the Data field of the referenced Secret
- will be projected into the volume as a file
- whose name is the key and content is the value.
- If specified, the listed keys will be projected
- into the specified paths, and unlisted keys
- will not be present. If a key is specified which
- is not present in the Secret, the volume setup
- will error unless it is marked optional. Paths
- must be relative and may not contain the '..'
- path or start with '..'.
+ description: items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
items:
- description: Maps a string key to a path within
- a volume.
+ description: Maps a string key to a path within a volume.
properties:
key:
description: key is the key to project.
type: string
mode:
- description: 'mode is Optional: mode bits
- used to set permissions on this file.
- Must be an octal value between 0000 and
- 0777 or a decimal value between 0 and
- 511. YAML accepts both octal and decimal
- values, JSON requires decimal values for
- mode bits. If not specified, the volume
- defaultMode will be used. This might be
- in conflict with other options that affect
- the file mode, like fsGroup, and the result
- can be other mode bits set.'
+ description: 'mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
format: int32
type: integer
path:
- description: path is the relative path of
- the file to map the key to. May not be
- an absolute path. May not contain the
- path element '..'. May not start with
- the string '..'.
+ description: path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
type: string
required:
- key
@@ -6517,45 +4050,25 @@ spec:
type: object
type: array
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: optional field specify whether the
- Secret or its key must be defined
+ description: optional field specify whether the Secret or its key must be defined
type: boolean
type: object
x-kubernetes-map-type: atomic
serviceAccountToken:
- description: serviceAccountToken is information about
- the serviceAccountToken data to project
+ description: serviceAccountToken is information about the serviceAccountToken data to project
properties:
audience:
- description: audience is the intended audience
- of the token. A recipient of a token must identify
- itself with an identifier specified in the audience
- of the token, and otherwise should reject the
- token. The audience defaults to the identifier
- of the apiserver.
+ description: audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.
type: string
expirationSeconds:
- description: expirationSeconds is the requested
- duration of validity of the service account
- token. As the token approaches expiration, the
- kubelet volume plugin will proactively rotate
- the service account token. The kubelet will
- start trying to rotate the token if the token
- is older than 80 percent of its time to live
- or if the token is older than 24 hours.Defaults
- to 1 hour and must be at least 10 minutes.
+ description: expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.
format: int64
type: integer
path:
- description: path is the path relative to the
- mount point of the file to project the token
- into.
+ description: path is the path relative to the mount point of the file to project the token into.
type: string
required:
- path
@@ -6564,148 +4077,105 @@ spec:
type: array
type: object
quobyte:
- description: quobyte represents a Quobyte mount on the host
- that shares a pod's lifetime
+ description: quobyte represents a Quobyte mount on the host that shares a pod's lifetime
properties:
group:
- description: group to map volume access to Default is no
- group
+ description: group to map volume access to Default is no group
type: string
readOnly:
- description: readOnly here will force the Quobyte volume
- to be mounted with read-only permissions. Defaults to
- false.
+ description: readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
type: boolean
registry:
- description: registry represents a single or multiple Quobyte
- Registry services specified as a string as host:port pair
- (multiple entries are separated with commas) which acts
- as the central registry for volumes
+ description: registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes
type: string
tenant:
- description: tenant owning the given Quobyte volume in the
- Backend Used with dynamically provisioned Quobyte volumes,
- value is set by the plugin
+ description: tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
type: string
user:
- description: user to map volume access to Defaults to serivceaccount
- user
+ description: user to map volume access to Defaults to serivceaccount user
type: string
volume:
- description: volume is a string that references an already
- created Quobyte volume by name.
+ description: volume is a string that references an already created Quobyte volume by name.
type: string
required:
- registry
- volume
type: object
rbd:
- description: 'rbd represents a Rados Block Device mount on the
- host that shares a pod''s lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md'
+ description: 'rbd represents a Rados Block Device mount on the host that shares a pod''s lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md'
properties:
fsType:
- description: 'fsType is the filesystem type of the volume
- that you want to mount. Tip: Ensure that the filesystem
- type is supported by the host operating system. Examples:
- "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4"
- if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd
- TODO: how do we prevent errors in the filesystem from
- compromising the machine'
+ description: 'fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine'
type: string
image:
- description: 'image is the rados image name. More info:
- https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
keyring:
- description: 'keyring is the path to key ring for RBDUser.
- Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
monitors:
- description: 'monitors is a collection of Ceph monitors.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
items:
type: string
type: array
pool:
- description: 'pool is the rados pool name. Default is rbd.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
readOnly:
- description: 'readOnly here will force the ReadOnly setting
- in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: boolean
secretRef:
- description: 'secretRef is name of the authentication secret
- for RBDUser. If provided overrides keyring. Default is
- nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
x-kubernetes-map-type: atomic
user:
- description: 'user is the rados user name. Default is admin.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
required:
- image
- monitors
type: object
scaleIO:
- description: scaleIO represents a ScaleIO persistent volume
- attached and mounted on Kubernetes nodes.
+ description: scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
properties:
fsType:
- description: fsType is the filesystem type to mount. Must
- be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Default is "xfs".
+ description: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".
type: string
gateway:
- description: gateway is the host address of the ScaleIO
- API Gateway.
+ description: gateway is the host address of the ScaleIO API Gateway.
type: string
protectionDomain:
- description: protectionDomain is the name of the ScaleIO
- Protection Domain for the configured storage.
+ description: protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
type: string
readOnly:
- description: readOnly Defaults to false (read/write). ReadOnly
- here will force the ReadOnly setting in VolumeMounts.
+ description: readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
type: boolean
secretRef:
- description: secretRef references to the secret for ScaleIO
- user and other sensitive information. If this is not provided,
- Login operation will fail.
+ description: secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
x-kubernetes-map-type: atomic
sslEnabled:
- description: sslEnabled Flag enable/disable SSL communication
- with Gateway, default false
+ description: sslEnabled Flag enable/disable SSL communication with Gateway, default false
type: boolean
storageMode:
- description: storageMode indicates whether the storage for
- a volume should be ThickProvisioned or ThinProvisioned.
- Default is ThinProvisioned.
+ description: storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
type: string
storagePool:
- description: storagePool is the ScaleIO Storage Pool associated
- with the protection domain.
+ description: storagePool is the ScaleIO Storage Pool associated with the protection domain.
type: string
system:
- description: system is the name of the storage system as
- configured in ScaleIO.
+ description: system is the name of the storage system as configured in ScaleIO.
type: string
volumeName:
- description: volumeName is the name of a volume already
- created in the ScaleIO system that is associated with
- this volume source.
+ description: volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.
type: string
required:
- gateway
@@ -6713,31 +4183,14 @@ spec:
- system
type: object
secret:
- description: 'secret represents a secret that should populate
- this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
+ description: 'secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
properties:
defaultMode:
- description: 'defaultMode is Optional: mode bits used to
- set permissions on created files by default. Must be an
- octal value between 0000 and 0777 or a decimal value between
- 0 and 511. YAML accepts both octal and decimal values,
- JSON requires decimal values for mode bits. Defaults to
- 0644. Directories within the path are not affected by
- this setting. This might be in conflict with other options
- that affect the file mode, like fsGroup, and the result
- can be other mode bits set.'
+ description: 'defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
format: int32
type: integer
items:
- description: items If unspecified, each key-value pair in
- the Data field of the referenced Secret will be projected
- into the volume as a file whose name is the key and content
- is the value. If specified, the listed keys will be projected
- into the specified paths, and unlisted keys will not be
- present. If a key is specified which is not present in
- the Secret, the volume setup will error unless it is marked
- optional. Paths must be relative and may not contain the
- '..' path or start with '..'.
+ description: items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
items:
description: Maps a string key to a path within a volume.
properties:
@@ -6745,22 +4198,11 @@ spec:
description: key is the key to project.
type: string
mode:
- description: 'mode is Optional: mode bits used to
- set permissions on this file. Must be an octal value
- between 0000 and 0777 or a decimal value between
- 0 and 511. YAML accepts both octal and decimal values,
- JSON requires decimal values for mode bits. If not
- specified, the volume defaultMode will be used.
- This might be in conflict with other options that
- affect the file mode, like fsGroup, and the result
- can be other mode bits set.'
+ description: 'mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
format: int32
type: integer
path:
- description: path is the relative path of the file
- to map the key to. May not be an absolute path.
- May not contain the path element '..'. May not start
- with the string '..'.
+ description: path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
type: string
required:
- key
@@ -6768,76 +4210,50 @@ spec:
type: object
type: array
optional:
- description: optional field specify whether the Secret or
- its keys must be defined
+ description: optional field specify whether the Secret or its keys must be defined
type: boolean
secretName:
- description: 'secretName is the name of the secret in the
- pod''s namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
+ description: 'secretName is the name of the secret in the pod''s namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
type: string
type: object
storageos:
- description: storageOS represents a StorageOS volume attached
- and mounted on Kubernetes nodes.
+ description: storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
properties:
fsType:
- description: fsType is the filesystem type to mount. Must
- be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4"
- if unspecified.
+ description: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
type: string
readOnly:
- description: readOnly defaults to false (read/write). ReadOnly
- here will force the ReadOnly setting in VolumeMounts.
+ description: readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
type: boolean
secretRef:
- description: secretRef specifies the secret to use for obtaining
- the StorageOS API credentials. If not specified, default
- values will be attempted.
+ description: secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
x-kubernetes-map-type: atomic
volumeName:
- description: volumeName is the human-readable name of the
- StorageOS volume. Volume names are only unique within
- a namespace.
+ description: volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
type: string
volumeNamespace:
- description: volumeNamespace specifies the scope of the
- volume within StorageOS. If no namespace is specified
- then the Pod's namespace will be used. This allows the
- Kubernetes name scoping to be mirrored within StorageOS
- for tighter integration. Set VolumeName to any name to
- override the default behaviour. Set to "default" if you
- are not using namespaces within StorageOS. Namespaces
- that do not pre-exist within StorageOS will be created.
+ description: volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.
type: string
type: object
vsphereVolume:
- description: vsphereVolume represents a vSphere volume attached
- and mounted on kubelets host machine
+ description: vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
properties:
fsType:
- description: fsType is filesystem type to mount. Must be
- a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4"
- if unspecified.
+ description: fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
type: string
storagePolicyID:
- description: storagePolicyID is the storage Policy Based
- Management (SPBM) profile ID associated with the StoragePolicyName.
+ description: storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
type: string
storagePolicyName:
- description: storagePolicyName is the storage Policy Based
- Management (SPBM) profile name.
+ description: storagePolicyName is the storage Policy Based Management (SPBM) profile name.
type: string
volumePath:
- description: volumePath is the path that identifies vSphere
- volume vmdk
+ description: volumePath is the path that identifies vSphere volume vmdk
type: string
required:
- volumePath
@@ -6856,44 +4272,30 @@ spec:
description: List of headers that can be added to HTTP responses.
properties:
contentSecurityPolicy:
- description: Set the Content-Security-Policy header to
- HTTP responses. Unset if blank.
+ description: Set the Content-Security-Policy header to HTTP responses. Unset if blank.
type: string
strictTransportSecurity:
- description: Set the Strict-Transport-Security header
- to HTTP responses. Unset if blank. Please make sure
- that you use this with care as this header might force
- browsers to load Prometheus and the other applications
- hosted on the same domain and subdomains over HTTPS.
- https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security
+ description: Set the Strict-Transport-Security header to HTTP responses. Unset if blank. Please make sure that you use this with care as this header might force browsers to load Prometheus and the other applications hosted on the same domain and subdomains over HTTPS. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security
type: string
xContentTypeOptions:
- description: Set the X-Content-Type-Options header to
- HTTP responses. Unset if blank. Accepted value is nosniff.
- https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options
+ description: Set the X-Content-Type-Options header to HTTP responses. Unset if blank. Accepted value is nosniff. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options
enum:
- ""
- NoSniff
type: string
xFrameOptions:
- description: Set the X-Frame-Options header to HTTP responses.
- Unset if blank. Accepted values are deny and sameorigin.
- https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options
+ description: Set the X-Frame-Options header to HTTP responses. Unset if blank. Accepted values are deny and sameorigin. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options
enum:
- ""
- Deny
- SameOrigin
type: string
xXSSProtection:
- description: Set the X-XSS-Protection header to all responses.
- Unset if blank. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection
+ description: Set the X-XSS-Protection header to all responses. Unset if blank. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection
type: string
type: object
http2:
- description: Enable HTTP/2 support. Note that HTTP/2 is only
- supported with TLS. When TLSConfig is not configured, HTTP/2
- will be disabled. Whenever the value of the field changes,
- a rolling update will be triggered.
+ description: Enable HTTP/2 support. Note that HTTP/2 is only supported with TLS. When TLSConfig is not configured, HTTP/2 will be disabled. Whenever the value of the field changes, a rolling update will be triggered.
type: boolean
type: object
tlsConfig:
@@ -6903,20 +4305,16 @@ spec:
description: Contains the TLS certificate for the server.
properties:
configMap:
- description: ConfigMap containing data to use for the
- targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its
- key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
@@ -6926,17 +4324,13 @@ spec:
description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -6944,32 +4338,24 @@ spec:
x-kubernetes-map-type: atomic
type: object
cipherSuites:
- description: 'List of supported cipher suites for TLS versions
- up to TLS 1.2. If empty, Go default cipher suites are used.
- Available cipher suites are documented in the go documentation:
- https://golang.org/pkg/crypto/tls/#pkg-constants'
+ description: 'List of supported cipher suites for TLS versions up to TLS 1.2. If empty, Go default cipher suites are used. Available cipher suites are documented in the go documentation: https://golang.org/pkg/crypto/tls/#pkg-constants'
items:
type: string
type: array
client_ca:
- description: Contains the CA certificate for client certificate
- authentication to the server.
+ description: Contains the CA certificate for client certificate authentication to the server.
properties:
configMap:
- description: ConfigMap containing data to use for the
- targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its
- key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
@@ -6979,17 +4365,13 @@ spec:
description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -6997,14 +4379,10 @@ spec:
x-kubernetes-map-type: atomic
type: object
clientAuthType:
- description: 'Server policy for client authentication. Maps
- to ClientAuth Policies. For more detail on clientAuth options:
- https://golang.org/pkg/crypto/tls/#ClientAuthType'
+ description: 'Server policy for client authentication. Maps to ClientAuth Policies. For more detail on clientAuth options: https://golang.org/pkg/crypto/tls/#ClientAuthType'
type: string
curvePreferences:
- description: 'Elliptic curves that will be used in an ECDHE
- handshake, in preference order. Available curves are documented
- in the go documentation: https://golang.org/pkg/crypto/tls/#CurveID'
+ description: 'Elliptic curves that will be used in an ECDHE handshake, in preference order. Available curves are documented in the go documentation: https://golang.org/pkg/crypto/tls/#CurveID'
items:
type: string
type: array
@@ -7012,34 +4390,26 @@ spec:
description: Secret containing the TLS key for the server.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
maxVersion:
- description: Maximum TLS version that is acceptable. Defaults
- to TLS13.
+ description: Maximum TLS version that is acceptable. Defaults to TLS13.
type: string
minVersion:
- description: Minimum TLS version that is acceptable. Defaults
- to TLS12.
+ description: Minimum TLS version that is acceptable. Defaults to TLS12.
type: string
preferServerCipherSuites:
- description: Controls whether the server selects the client's
- most preferred cipher suite, or the server's most preferred
- cipher suite. If true then the server's preference, as expressed
- in the order of elements in cipherSuites, is used.
+ description: Controls whether the server selects the client's most preferred cipher suite, or the server's most preferred cipher suite. If true then the server's preference, as expressed in the order of elements in cipherSuites, is used.
type: boolean
required:
- cert
@@ -7048,35 +4418,26 @@ spec:
type: object
type: object
status:
- description: 'Most recent observed status of the Alertmanager cluster.
- Read-only. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status'
+ description: 'Most recent observed status of the Alertmanager cluster. Read-only. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status'
properties:
availableReplicas:
- description: Total number of available pods (ready for at least minReadySeconds)
- targeted by this Alertmanager cluster.
+ description: Total number of available pods (ready for at least minReadySeconds) targeted by this Alertmanager cluster.
format: int32
type: integer
conditions:
description: The current state of the Alertmanager object.
items:
- description: Condition represents the state of the resources associated
- with the Prometheus or Alertmanager resource.
+ description: Condition represents the state of the resources associated with the Prometheus or Alertmanager resource.
properties:
lastTransitionTime:
- description: lastTransitionTime is the time of the last update
- to the current status property.
+ description: lastTransitionTime is the time of the last update to the current status property.
format: date-time
type: string
message:
- description: Human-readable message indicating details for the
- condition's last transition.
+ description: Human-readable message indicating details for the condition's last transition.
type: string
observedGeneration:
- description: ObservedGeneration represents the .metadata.generation
- that the condition was set based upon. For instance, if `.metadata.generation`
- is currently 12, but the `.status.conditions[].observedGeneration`
- is 9, the condition is out of date with respect to the current
- state of the instance.
+ description: ObservedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if `.metadata.generation` is currently 12, but the `.status.conditions[].observedGeneration` is 9, the condition is out of date with respect to the current state of the instance.
format: int64
type: integer
reason:
@@ -7098,22 +4459,18 @@ spec:
- type
x-kubernetes-list-type: map
paused:
- description: Represents whether any actions on the underlying managed
- objects are being performed. Only delete actions will be performed.
+ description: Represents whether any actions on the underlying managed objects are being performed. Only delete actions will be performed.
type: boolean
replicas:
- description: Total number of non-terminated pods targeted by this
- Alertmanager object (their labels match the selector).
+ description: Total number of non-terminated pods targeted by this Alertmanager object (their labels match the selector).
format: int32
type: integer
unavailableReplicas:
- description: Total number of unavailable pods targeted by this Alertmanager
- object.
+ description: Total number of unavailable pods targeted by this Alertmanager object.
format: int32
type: integer
updatedReplicas:
- description: Total number of non-terminated pods targeted by this
- Alertmanager object that have the desired version spec.
+ description: Total number of non-terminated pods targeted by this Alertmanager object that have the desired version spec.
format: int32
type: integer
required:
diff --git a/manifests/setup/0podmonitorCustomResourceDefinition.yaml b/manifests/setup/0podmonitorCustomResourceDefinition.yaml
index 1afb2735d47d2766d7cb47cfe43065f8ed06b998..372cbbba924712263e078d89f7837c3c257e366a 100644
--- a/manifests/setup/0podmonitorCustomResourceDefinition.yaml
+++ b/manifests/setup/0podmonitorCustomResourceDefinition.yaml
@@ -24,57 +24,43 @@ spec:
description: PodMonitor defines monitoring for a set of pods.
properties:
apiVersion:
- description: 'APIVersion defines the versioned schema of this representation
- of an object. Servers should convert recognized schemas to the latest
- internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+ description: 'APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: 'Kind is a string value representing the REST resource this
- object represents. Servers may infer this from the endpoint the client
- submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+ description: 'Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
spec:
- description: Specification of desired Pod selection for target discovery
- by Prometheus.
+ description: Specification of desired Pod selection for target discovery by Prometheus.
properties:
attachMetadata:
- description: Attaches node metadata to discovered targets. Requires
- Prometheus v2.35.0 and above.
+ description: Attaches node metadata to discovered targets. Requires Prometheus v2.35.0 and above.
properties:
node:
- description: When set to true, Prometheus must have permissions
- to get Nodes.
+ description: When set to true, Prometheus must have permissions to get Nodes.
type: boolean
type: object
jobLabel:
description: The label to use to retrieve the job name from.
type: string
labelLimit:
- description: Per-scrape limit on number of labels that will be accepted
- for a sample. Only valid in Prometheus versions 2.27.0 and newer.
+ description: Per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.
format: int64
type: integer
labelNameLengthLimit:
- description: Per-scrape limit on length of labels name that will be
- accepted for a sample. Only valid in Prometheus versions 2.27.0
- and newer.
+ description: Per-scrape limit on length of labels name that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.
format: int64
type: integer
labelValueLengthLimit:
- description: Per-scrape limit on length of labels value that will
- be accepted for a sample. Only valid in Prometheus versions 2.27.0
- and newer.
+ description: Per-scrape limit on length of labels value that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.
format: int64
type: integer
namespaceSelector:
- description: Selector to select which namespaces the Endpoints objects
- are discovered from.
+ description: Selector to select which namespaces the Endpoints objects are discovered from.
properties:
any:
- description: Boolean describing whether all namespaces are selected
- in contrast to a list restricting them.
+ description: Boolean describing whether all namespaces are selected in contrast to a list restricting them.
type: boolean
matchNames:
description: List of namespace names to select from.
@@ -85,76 +71,61 @@ spec:
podMetricsEndpoints:
description: A list of endpoints allowed as part of this PodMonitor.
items:
- description: PodMetricsEndpoint defines a scrapeable endpoint of
- a Kubernetes Pod serving Prometheus metrics.
+ description: PodMetricsEndpoint defines a scrapeable endpoint of a Kubernetes Pod serving Prometheus metrics.
properties:
authorization:
description: Authorization section for this endpoint
properties:
credentials:
- description: The secret's key that contains the credentials
- of the request
+ description: The secret's key that contains the credentials of the request
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
type:
- description: Set the authentication type. Defaults to Bearer,
- Basic will cause an error
+ description: Set the authentication type. Defaults to Bearer, Basic will cause an error
type: string
type: object
basicAuth:
- description: 'BasicAuth allow an endpoint to authenticate over
- basic authentication. More info: https://prometheus.io/docs/operating/configuration/#endpoint'
+ description: 'BasicAuth allow an endpoint to authenticate over basic authentication. More info: https://prometheus.io/docs/operating/configuration/#endpoint'
properties:
password:
- description: The secret in the service monitor namespace
- that contains the password for authentication.
+ description: The secret in the service monitor namespace that contains the password for authentication.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
username:
- description: The secret in the service monitor namespace
- that contains the username for authentication.
+ description: The secret in the service monitor namespace that contains the username for authentication.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -162,21 +133,16 @@ spec:
x-kubernetes-map-type: atomic
type: object
bearerTokenSecret:
- description: Secret to mount to read bearer token for scraping
- targets. The secret needs to be in the same namespace as the
- pod monitor and accessible by the Prometheus Operator.
+ description: Secret to mount to read bearer token for scraping targets. The secret needs to be in the same namespace as the pod monitor and accessible by the Prometheus Operator.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -186,40 +152,29 @@ spec:
description: Whether to enable HTTP2.
type: boolean
filterRunning:
- description: 'Drop pods that are not running. (Failed, Succeeded).
- Enabled by default. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase'
+ description: 'Drop pods that are not running. (Failed, Succeeded). Enabled by default. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase'
type: boolean
followRedirects:
- description: FollowRedirects configures whether scrape requests
- follow HTTP 3xx redirects.
+ description: FollowRedirects configures whether scrape requests follow HTTP 3xx redirects.
type: boolean
honorLabels:
- description: HonorLabels chooses the metric's labels on collisions
- with target labels.
+ description: HonorLabels chooses the metric's labels on collisions with target labels.
type: boolean
honorTimestamps:
- description: HonorTimestamps controls whether Prometheus respects
- the timestamps present in scraped data.
+ description: HonorTimestamps controls whether Prometheus respects the timestamps present in scraped data.
type: boolean
interval:
- description: Interval at which metrics should be scraped If
- not specified Prometheus' global scrape interval is used.
+ description: Interval at which metrics should be scraped If not specified Prometheus' global scrape interval is used.
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
metricRelabelings:
- description: MetricRelabelConfigs to apply to samples before
- ingestion.
+ description: MetricRelabelConfigs to apply to samples before ingestion.
items:
- description: 'RelabelConfig allows dynamic rewriting of the
- label set, being applied to samples before ingestion. It
- defines `<metric_relabel_configs>`-section of Prometheus
- configuration. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs'
+ description: 'RelabelConfig allows dynamic rewriting of the label set, being applied to samples before ingestion. It defines `<metric_relabel_configs>`-section of Prometheus configuration. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs'
properties:
action:
default: replace
- description: Action to perform based on regex matching.
- Default is 'replace'. uppercase and lowercase actions
- require Prometheus >= 2.36.
+ description: Action to perform based on regex matching. Default is 'replace'. uppercase and lowercase actions require Prometheus >= 2.36.
enum:
- replace
- Replace
@@ -245,65 +200,47 @@ spec:
- DropEqual
type: string
modulus:
- description: Modulus to take of the hash of the source
- label values.
+ description: Modulus to take of the hash of the source label values.
format: int64
type: integer
regex:
- description: Regular expression against which the extracted
- value is matched. Default is '(.*)'
+ description: Regular expression against which the extracted value is matched. Default is '(.*)'
type: string
replacement:
- description: Replacement value against which a regex replace
- is performed if the regular expression matches. Regex
- capture groups are available. Default is '$1'
+ description: Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Default is '$1'
type: string
separator:
- description: Separator placed between concatenated source
- label values. default is ';'.
+ description: Separator placed between concatenated source label values. default is ';'.
type: string
sourceLabels:
- description: The source labels select values from existing
- labels. Their content is concatenated using the configured
- separator and matched against the configured regular
- expression for the replace, keep, and drop actions.
+ description: The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions.
items:
- description: LabelName is a valid Prometheus label name
- which may only contain ASCII letters, numbers, as
- well as underscores.
+ description: LabelName is a valid Prometheus label name which may only contain ASCII letters, numbers, as well as underscores.
pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$
type: string
type: array
targetLabel:
- description: Label to which the resulting value is written
- in a replace action. It is mandatory for replace actions.
- Regex capture groups are available.
+ description: Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available.
type: string
type: object
type: array
oauth2:
- description: OAuth2 for the URL. Only valid in Prometheus versions
- 2.27.0 and newer.
+ description: OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer.
properties:
clientId:
- description: The secret or configmap containing the OAuth2
- client id
+ description: The secret or configmap containing the OAuth2 client id
properties:
configMap:
- description: ConfigMap containing data to use for the
- targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its
- key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
@@ -313,17 +250,13 @@ spec:
description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -334,16 +267,13 @@ spec:
description: The secret containing the OAuth2 client secret
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -376,34 +306,22 @@ spec:
description: Optional HTTP URL parameters
type: object
path:
- description: HTTP path to scrape for metrics. If empty, Prometheus
- uses the default value (e.g. `/metrics`).
+ description: HTTP path to scrape for metrics. If empty, Prometheus uses the default value (e.g. `/metrics`).
type: string
port:
- description: Name of the pod port this endpoint refers to. Mutually
- exclusive with targetPort.
+ description: Name of the pod port this endpoint refers to. Mutually exclusive with targetPort.
type: string
proxyUrl:
- description: ProxyURL eg http://proxyserver:2195 Directs scrapes
- to proxy through this endpoint.
+ description: ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint.
type: string
relabelings:
- description: 'RelabelConfigs to apply to samples before scraping.
- Prometheus Operator automatically adds relabelings for a few
- standard Kubernetes fields. The original scrape job''s name
- is available via the `__tmp_prometheus_job_name` label. More
- info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config'
+ description: 'RelabelConfigs to apply to samples before scraping. Prometheus Operator automatically adds relabelings for a few standard Kubernetes fields. The original scrape job''s name is available via the `__tmp_prometheus_job_name` label. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config'
items:
- description: 'RelabelConfig allows dynamic rewriting of the
- label set, being applied to samples before ingestion. It
- defines `<metric_relabel_configs>`-section of Prometheus
- configuration. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs'
+ description: 'RelabelConfig allows dynamic rewriting of the label set, being applied to samples before ingestion. It defines `<metric_relabel_configs>`-section of Prometheus configuration. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs'
properties:
action:
default: replace
- description: Action to perform based on regex matching.
- Default is 'replace'. uppercase and lowercase actions
- require Prometheus >= 2.36.
+ description: Action to perform based on regex matching. Default is 'replace'. uppercase and lowercase actions require Prometheus >= 2.36.
enum:
- replace
- Replace
@@ -429,39 +347,27 @@ spec:
- DropEqual
type: string
modulus:
- description: Modulus to take of the hash of the source
- label values.
+ description: Modulus to take of the hash of the source label values.
format: int64
type: integer
regex:
- description: Regular expression against which the extracted
- value is matched. Default is '(.*)'
+ description: Regular expression against which the extracted value is matched. Default is '(.*)'
type: string
replacement:
- description: Replacement value against which a regex replace
- is performed if the regular expression matches. Regex
- capture groups are available. Default is '$1'
+ description: Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Default is '$1'
type: string
separator:
- description: Separator placed between concatenated source
- label values. default is ';'.
+ description: Separator placed between concatenated source label values. default is ';'.
type: string
sourceLabels:
- description: The source labels select values from existing
- labels. Their content is concatenated using the configured
- separator and matched against the configured regular
- expression for the replace, keep, and drop actions.
+ description: The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions.
items:
- description: LabelName is a valid Prometheus label name
- which may only contain ASCII letters, numbers, as
- well as underscores.
+ description: LabelName is a valid Prometheus label name which may only contain ASCII letters, numbers, as well as underscores.
pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$
type: string
type: array
targetLabel:
- description: Label to which the resulting value is written
- in a replace action. It is mandatory for replace actions.
- Regex capture groups are available.
+ description: Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available.
type: string
type: object
type: array
@@ -469,8 +375,7 @@ spec:
description: HTTP scheme to use for scraping.
type: string
scrapeTimeout:
- description: Timeout after which the scrape is ended If not
- specified, the Prometheus global scrape interval is used.
+ description: Timeout after which the scrape is ended If not specified, the Prometheus global scrape interval is used.
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
targetPort:
@@ -483,24 +388,19 @@ spec:
description: TLS configuration to use when scraping the endpoint.
properties:
ca:
- description: Certificate authority used when verifying server
- certificates.
+ description: Certificate authority used when verifying server certificates.
properties:
configMap:
- description: ConfigMap containing data to use for the
- targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its
- key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
@@ -510,17 +410,13 @@ spec:
description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -531,20 +427,16 @@ spec:
description: Client certificate to present when doing client-authentication.
properties:
configMap:
- description: ConfigMap containing data to use for the
- targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its
- key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
@@ -554,17 +446,13 @@ spec:
description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -575,20 +463,16 @@ spec:
description: Disable target certificate validation.
type: boolean
keySecret:
- description: Secret containing the client key file for the
- targets.
+ description: Secret containing the client key file for the targets.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -601,42 +485,30 @@ spec:
type: object
type: array
podTargetLabels:
- description: PodTargetLabels transfers labels on the Kubernetes Pod
- onto the target.
+ description: PodTargetLabels transfers labels on the Kubernetes Pod onto the target.
items:
type: string
type: array
sampleLimit:
- description: SampleLimit defines per-scrape limit on number of scraped
- samples that will be accepted.
+ description: SampleLimit defines per-scrape limit on number of scraped samples that will be accepted.
format: int64
type: integer
selector:
description: Selector to select Pod objects.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements.
- The requirements are ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a selector that
- contains values, a key, and an operator that relates the key
- and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the selector applies
- to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship to
- a set of values. Valid operators are In, NotIn, Exists
- and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string values. If the
- operator is In or NotIn, the values array must be non-empty.
- If the operator is Exists or DoesNotExist, the values
- array must be empty. This array is replaced during a strategic
- merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -648,17 +520,12 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value} pairs. A single
- {key,value} in the matchLabels map is equivalent to an element
- of matchExpressions, whose key field is "key", the operator
- is "In", and the values array contains only "value". The requirements
- are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
targetLimit:
- description: TargetLimit defines a limit on the number of scraped
- targets that will be accepted.
+ description: TargetLimit defines a limit on the number of scraped targets that will be accepted.
format: int64
type: integer
required:
diff --git a/manifests/setup/0probeCustomResourceDefinition.yaml b/manifests/setup/0probeCustomResourceDefinition.yaml
index 46b36baa480b9a345fefbf7e01253fed1e407530..d19c22588d687246cf265ecdaf96c24f6e88efd6 100644
--- a/manifests/setup/0probeCustomResourceDefinition.yaml
+++ b/manifests/setup/0probeCustomResourceDefinition.yaml
@@ -24,88 +24,69 @@ spec:
description: Probe defines monitoring for a set of static targets or ingresses.
properties:
apiVersion:
- description: 'APIVersion defines the versioned schema of this representation
- of an object. Servers should convert recognized schemas to the latest
- internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+ description: 'APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: 'Kind is a string value representing the REST resource this
- object represents. Servers may infer this from the endpoint the client
- submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+ description: 'Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
spec:
- description: Specification of desired Ingress selection for target discovery
- by Prometheus.
+ description: Specification of desired Ingress selection for target discovery by Prometheus.
properties:
authorization:
description: Authorization section for this endpoint
properties:
credentials:
- description: The secret's key that contains the credentials of
- the request
+ description: The secret's key that contains the credentials of the request
properties:
key:
- description: The key of the secret to select from. Must be
- a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be
- defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
type:
- description: Set the authentication type. Defaults to Bearer,
- Basic will cause an error
+ description: Set the authentication type. Defaults to Bearer, Basic will cause an error
type: string
type: object
basicAuth:
- description: 'BasicAuth allow an endpoint to authenticate over basic
- authentication. More info: https://prometheus.io/docs/operating/configuration/#endpoint'
+ description: 'BasicAuth allow an endpoint to authenticate over basic authentication. More info: https://prometheus.io/docs/operating/configuration/#endpoint'
properties:
password:
- description: The secret in the service monitor namespace that
- contains the password for authentication.
+ description: The secret in the service monitor namespace that contains the password for authentication.
properties:
key:
- description: The key of the secret to select from. Must be
- a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be
- defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
username:
- description: The secret in the service monitor namespace that
- contains the username for authentication.
+ description: The secret in the service monitor namespace that contains the username for authentication.
properties:
key:
- description: The key of the secret to select from. Must be
- a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be
- defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -113,17 +94,13 @@ spec:
x-kubernetes-map-type: atomic
type: object
bearerTokenSecret:
- description: Secret to mount to read bearer token for scraping targets.
- The secret needs to be in the same namespace as the probe and accessible
- by the Prometheus Operator.
+ description: Secret to mount to read bearer token for scraping targets. The secret needs to be in the same namespace as the probe and accessible by the Prometheus Operator.
properties:
key:
- description: The key of the secret to select from. Must be a
- valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
description: Specify whether the Secret or its key must be defined
@@ -133,42 +110,32 @@ spec:
type: object
x-kubernetes-map-type: atomic
interval:
- description: Interval at which targets are probed using the configured
- prober. If not specified Prometheus' global scrape interval is used.
+ description: Interval at which targets are probed using the configured prober. If not specified Prometheus' global scrape interval is used.
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
jobName:
description: The job name assigned to scraped metrics by default.
type: string
labelLimit:
- description: Per-scrape limit on number of labels that will be accepted
- for a sample. Only valid in Prometheus versions 2.27.0 and newer.
+ description: Per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.
format: int64
type: integer
labelNameLengthLimit:
- description: Per-scrape limit on length of labels name that will be
- accepted for a sample. Only valid in Prometheus versions 2.27.0
- and newer.
+ description: Per-scrape limit on length of labels name that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.
format: int64
type: integer
labelValueLengthLimit:
- description: Per-scrape limit on length of labels value that will
- be accepted for a sample. Only valid in Prometheus versions 2.27.0
- and newer.
+ description: Per-scrape limit on length of labels value that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.
format: int64
type: integer
metricRelabelings:
description: MetricRelabelConfigs to apply to samples before ingestion.
items:
- description: 'RelabelConfig allows dynamic rewriting of the label
- set, being applied to samples before ingestion. It defines `<metric_relabel_configs>`-section
- of Prometheus configuration. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs'
+ description: 'RelabelConfig allows dynamic rewriting of the label set, being applied to samples before ingestion. It defines `<metric_relabel_configs>`-section of Prometheus configuration. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs'
properties:
action:
default: replace
- description: Action to perform based on regex matching. Default
- is 'replace'. uppercase and lowercase actions require Prometheus
- >= 2.36.
+ description: Action to perform based on regex matching. Default is 'replace'. uppercase and lowercase actions require Prometheus >= 2.36.
enum:
- replace
- Replace
@@ -194,53 +161,38 @@ spec:
- DropEqual
type: string
modulus:
- description: Modulus to take of the hash of the source label
- values.
+ description: Modulus to take of the hash of the source label values.
format: int64
type: integer
regex:
- description: Regular expression against which the extracted
- value is matched. Default is '(.*)'
+ description: Regular expression against which the extracted value is matched. Default is '(.*)'
type: string
replacement:
- description: Replacement value against which a regex replace
- is performed if the regular expression matches. Regex capture
- groups are available. Default is '$1'
+ description: Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Default is '$1'
type: string
separator:
- description: Separator placed between concatenated source label
- values. default is ';'.
+ description: Separator placed between concatenated source label values. default is ';'.
type: string
sourceLabels:
- description: The source labels select values from existing labels.
- Their content is concatenated using the configured separator
- and matched against the configured regular expression for
- the replace, keep, and drop actions.
+ description: The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions.
items:
- description: LabelName is a valid Prometheus label name which
- may only contain ASCII letters, numbers, as well as underscores.
+ description: LabelName is a valid Prometheus label name which may only contain ASCII letters, numbers, as well as underscores.
pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$
type: string
type: array
targetLabel:
- description: Label to which the resulting value is written in
- a replace action. It is mandatory for replace actions. Regex
- capture groups are available.
+ description: Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available.
type: string
type: object
type: array
module:
- description: 'The module to use for probing specifying how to probe
- the target. Example module configuring in the blackbox exporter:
- https://github.com/prometheus/blackbox_exporter/blob/master/example.yml'
+ description: 'The module to use for probing specifying how to probe the target. Example module configuring in the blackbox exporter: https://github.com/prometheus/blackbox_exporter/blob/master/example.yml'
type: string
oauth2:
- description: OAuth2 for the URL. Only valid in Prometheus versions
- 2.27.0 and newer.
+ description: OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer.
properties:
clientId:
- description: The secret or configmap containing the OAuth2 client
- id
+ description: The secret or configmap containing the OAuth2 client id
properties:
configMap:
description: ConfigMap containing data to use for the targets.
@@ -249,12 +201,10 @@ spec:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its key
- must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
@@ -264,16 +214,13 @@ spec:
description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -284,16 +231,13 @@ spec:
description: The secret containing the OAuth2 client secret
properties:
key:
- description: The key of the secret to select from. Must be
- a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be
- defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -319,9 +263,7 @@ spec:
- tokenUrl
type: object
prober:
- description: Specification for the prober to use for probing targets.
- The prober.URL parameter is required. Targets cannot be probed if
- left empty.
+ description: Specification for the prober to use for probing targets. The prober.URL parameter is required. Targets cannot be probed if left empty.
properties:
path:
default: /probe
@@ -340,35 +282,28 @@ spec:
- url
type: object
sampleLimit:
- description: SampleLimit defines per-scrape limit on number of scraped
- samples that will be accepted.
+ description: SampleLimit defines per-scrape limit on number of scraped samples that will be accepted.
format: int64
type: integer
scrapeTimeout:
- description: Timeout for scraping metrics from the Prometheus exporter.
- If not specified, the Prometheus global scrape interval is used.
+ description: Timeout for scraping metrics from the Prometheus exporter. If not specified, the Prometheus global scrape interval is used.
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
targetLimit:
- description: TargetLimit defines a limit on the number of scraped
- targets that will be accepted.
+ description: TargetLimit defines a limit on the number of scraped targets that will be accepted.
format: int64
type: integer
targets:
- description: Targets defines a set of static or dynamically discovered
- targets to probe.
+ description: Targets defines a set of static or dynamically discovered targets to probe.
properties:
ingress:
- description: ingress defines the Ingress objects to probe and
- the relabeling configuration. If `staticConfig` is also defined,
- `staticConfig` takes precedence.
+ description: ingress defines the Ingress objects to probe and the relabeling configuration. If `staticConfig` is also defined, `staticConfig` takes precedence.
properties:
namespaceSelector:
description: From which namespaces to select Ingress objects.
properties:
any:
- description: Boolean describing whether all namespaces
- are selected in contrast to a list restricting them.
+ description: Boolean describing whether all namespaces are selected in contrast to a list restricting them.
type: boolean
matchNames:
description: List of namespace names to select from.
@@ -377,23 +312,13 @@ spec:
type: array
type: object
relabelingConfigs:
- description: 'RelabelConfigs to apply to the label set of
- the target before it gets scraped. The original ingress
- address is available via the `__tmp_prometheus_ingress_address`
- label. It can be used to customize the probed URL. The original
- scrape job''s name is available via the `__tmp_prometheus_job_name`
- label. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config'
+ description: 'RelabelConfigs to apply to the label set of the target before it gets scraped. The original ingress address is available via the `__tmp_prometheus_ingress_address` label. It can be used to customize the probed URL. The original scrape job''s name is available via the `__tmp_prometheus_job_name` label. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config'
items:
- description: 'RelabelConfig allows dynamic rewriting of
- the label set, being applied to samples before ingestion.
- It defines `<metric_relabel_configs>`-section of Prometheus
- configuration. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs'
+ description: 'RelabelConfig allows dynamic rewriting of the label set, being applied to samples before ingestion. It defines `<metric_relabel_configs>`-section of Prometheus configuration. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs'
properties:
action:
default: replace
- description: Action to perform based on regex matching.
- Default is 'replace'. uppercase and lowercase actions
- require Prometheus >= 2.36.
+ description: Action to perform based on regex matching. Default is 'replace'. uppercase and lowercase actions require Prometheus >= 2.36.
enum:
- replace
- Replace
@@ -419,39 +344,27 @@ spec:
- DropEqual
type: string
modulus:
- description: Modulus to take of the hash of the source
- label values.
+ description: Modulus to take of the hash of the source label values.
format: int64
type: integer
regex:
- description: Regular expression against which the extracted
- value is matched. Default is '(.*)'
+ description: Regular expression against which the extracted value is matched. Default is '(.*)'
type: string
replacement:
- description: Replacement value against which a regex
- replace is performed if the regular expression matches.
- Regex capture groups are available. Default is '$1'
+ description: Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Default is '$1'
type: string
separator:
- description: Separator placed between concatenated source
- label values. default is ';'.
+ description: Separator placed between concatenated source label values. default is ';'.
type: string
sourceLabels:
- description: The source labels select values from existing
- labels. Their content is concatenated using the configured
- separator and matched against the configured regular
- expression for the replace, keep, and drop actions.
+ description: The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions.
items:
- description: LabelName is a valid Prometheus label
- name which may only contain ASCII letters, numbers,
- as well as underscores.
+ description: LabelName is a valid Prometheus label name which may only contain ASCII letters, numbers, as well as underscores.
pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$
type: string
type: array
targetLabel:
- description: Label to which the resulting value is written
- in a replace action. It is mandatory for replace actions.
- Regex capture groups are available.
+ description: Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available.
type: string
type: object
type: array
@@ -459,29 +372,18 @@ spec:
description: Selector to select the Ingress objects.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector
- requirements. The requirements are ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a selector
- that contains values, a key, and an operator that
- relates the key and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the selector
- applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship
- to a set of values. Valid operators are In, NotIn,
- Exists and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string values.
- If the operator is In or NotIn, the values array
- must be non-empty. If the operator is Exists or
- DoesNotExist, the values array must be empty.
- This array is replaced during a strategic merge
- patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -493,40 +395,27 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value} pairs.
- A single {key,value} in the matchLabels map is equivalent
- to an element of matchExpressions, whose key field is
- "key", the operator is "In", and the values array contains
- only "value". The requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
type: object
staticConfig:
- description: 'staticConfig defines the static list of targets
- to probe and the relabeling configuration. If `ingress` is also
- defined, `staticConfig` takes precedence. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#static_config.'
+ description: 'staticConfig defines the static list of targets to probe and the relabeling configuration. If `ingress` is also defined, `staticConfig` takes precedence. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#static_config.'
properties:
labels:
additionalProperties:
type: string
- description: Labels assigned to all metrics scraped from the
- targets.
+ description: Labels assigned to all metrics scraped from the targets.
type: object
relabelingConfigs:
- description: 'RelabelConfigs to apply to the label set of
- the targets before it gets scraped. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config'
+ description: 'RelabelConfigs to apply to the label set of the targets before it gets scraped. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config'
items:
- description: 'RelabelConfig allows dynamic rewriting of
- the label set, being applied to samples before ingestion.
- It defines `<metric_relabel_configs>`-section of Prometheus
- configuration. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs'
+ description: 'RelabelConfig allows dynamic rewriting of the label set, being applied to samples before ingestion. It defines `<metric_relabel_configs>`-section of Prometheus configuration. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs'
properties:
action:
default: replace
- description: Action to perform based on regex matching.
- Default is 'replace'. uppercase and lowercase actions
- require Prometheus >= 2.36.
+ description: Action to perform based on regex matching. Default is 'replace'. uppercase and lowercase actions require Prometheus >= 2.36.
enum:
- replace
- Replace
@@ -552,39 +441,27 @@ spec:
- DropEqual
type: string
modulus:
- description: Modulus to take of the hash of the source
- label values.
+ description: Modulus to take of the hash of the source label values.
format: int64
type: integer
regex:
- description: Regular expression against which the extracted
- value is matched. Default is '(.*)'
+ description: Regular expression against which the extracted value is matched. Default is '(.*)'
type: string
replacement:
- description: Replacement value against which a regex
- replace is performed if the regular expression matches.
- Regex capture groups are available. Default is '$1'
+ description: Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Default is '$1'
type: string
separator:
- description: Separator placed between concatenated source
- label values. default is ';'.
+ description: Separator placed between concatenated source label values. default is ';'.
type: string
sourceLabels:
- description: The source labels select values from existing
- labels. Their content is concatenated using the configured
- separator and matched against the configured regular
- expression for the replace, keep, and drop actions.
+ description: The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions.
items:
- description: LabelName is a valid Prometheus label
- name which may only contain ASCII letters, numbers,
- as well as underscores.
+ description: LabelName is a valid Prometheus label name which may only contain ASCII letters, numbers, as well as underscores.
pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$
type: string
type: array
targetLabel:
- description: Label to which the resulting value is written
- in a replace action. It is mandatory for replace actions.
- Regex capture groups are available.
+ description: Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available.
type: string
type: object
type: array
@@ -599,8 +476,7 @@ spec:
description: TLS configuration to use when scraping the endpoint.
properties:
ca:
- description: Certificate authority used when verifying server
- certificates.
+ description: Certificate authority used when verifying server certificates.
properties:
configMap:
description: ConfigMap containing data to use for the targets.
@@ -609,12 +485,10 @@ spec:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its key
- must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
@@ -624,16 +498,13 @@ spec:
description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -650,12 +521,10 @@ spec:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its key
- must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
@@ -665,16 +534,13 @@ spec:
description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -688,16 +554,13 @@ spec:
description: Secret containing the client key file for the targets.
properties:
key:
- description: The key of the secret to select from. Must be
- a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be
- defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
diff --git a/manifests/setup/0prometheusCustomResourceDefinition.yaml b/manifests/setup/0prometheusCustomResourceDefinition.yaml
index f2ec156af8abbdc7ea6db20d264d9b2be03dba5b..82dc108e850c0703b9fad346b05baaf12532b85d 100644
--- a/manifests/setup/0prometheusCustomResourceDefinition.yaml
+++ b/manifests/setup/0prometheusCustomResourceDefinition.yaml
@@ -51,41 +51,24 @@ spec:
description: Prometheus defines a Prometheus deployment.
properties:
apiVersion:
- description: 'APIVersion defines the versioned schema of this representation
- of an object. Servers should convert recognized schemas to the latest
- internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+ description: 'APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: 'Kind is a string value representing the REST resource this
- object represents. Servers may infer this from the endpoint the client
- submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+ description: 'Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
spec:
- description: 'Specification of the desired behavior of the Prometheus
- cluster. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status'
+ description: 'Specification of the desired behavior of the Prometheus cluster. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status'
properties:
additionalAlertManagerConfigs:
- description: 'AdditionalAlertManagerConfigs allows specifying a key
- of a Secret containing additional Prometheus AlertManager configurations.
- AlertManager configurations specified are appended to the configurations
- generated by the Prometheus Operator. Job configurations specified
- must have the form as specified in the official Prometheus documentation:
- https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alertmanager_config.
- As AlertManager configs are appended, the user is responsible to
- make sure it is valid. Note that using this feature may expose the
- possibility to break upgrades of Prometheus. It is advised to review
- Prometheus release notes to ensure that no incompatible AlertManager
- configs are going to break Prometheus after the upgrade.'
+ description: 'AdditionalAlertManagerConfigs allows specifying a key of a Secret containing additional Prometheus AlertManager configurations. AlertManager configurations specified are appended to the configurations generated by the Prometheus Operator. Job configurations specified must have the form as specified in the official Prometheus documentation: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alertmanager_config. As AlertManager configs are appended, the user is responsible to make sure it is valid. Note that using this feature may expose the possibility to break upgrades of Prometheus. It is advised to review Prometheus release notes to ensure that no incompatible AlertManager configs are going to break Prometheus after the upgrade.'
properties:
key:
- description: The key of the secret to select from. Must be a
- valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
description: Specify whether the Secret or its key must be defined
@@ -95,25 +78,13 @@ spec:
type: object
x-kubernetes-map-type: atomic
additionalAlertRelabelConfigs:
- description: 'AdditionalAlertRelabelConfigs allows specifying a key
- of a Secret containing additional Prometheus alert relabel configurations.
- Alert relabel configurations specified are appended to the configurations
- generated by the Prometheus Operator. Alert relabel configurations
- specified must have the form as specified in the official Prometheus
- documentation: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs.
- As alert relabel configs are appended, the user is responsible to
- make sure it is valid. Note that using this feature may expose the
- possibility to break upgrades of Prometheus. It is advised to review
- Prometheus release notes to ensure that no incompatible alert relabel
- configs are going to break Prometheus after the upgrade.'
+ description: 'AdditionalAlertRelabelConfigs allows specifying a key of a Secret containing additional Prometheus alert relabel configurations. Alert relabel configurations specified are appended to the configurations generated by the Prometheus Operator. Alert relabel configurations specified must have the form as specified in the official Prometheus documentation: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs. As alert relabel configs are appended, the user is responsible to make sure it is valid. Note that using this feature may expose the possibility to break upgrades of Prometheus. It is advised to review Prometheus release notes to ensure that no incompatible alert relabel configs are going to break Prometheus after the upgrade.'
properties:
key:
- description: The key of the secret to select from. Must be a
- valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
description: Specify whether the Secret or its key must be defined
@@ -123,15 +94,7 @@ spec:
type: object
x-kubernetes-map-type: atomic
additionalArgs:
- description: AdditionalArgs allows setting additional arguments for
- the Prometheus container. It is intended for e.g. activating hidden
- flags which are not supported by the dedicated configuration options
- yet. The arguments are passed as-is to the Prometheus container
- which may cause issues if they are invalid or not supported by the
- given Prometheus version. In case of an argument conflict (e.g.
- an argument which is already set by the operator itself) or when
- providing an invalid argument the reconciliation will fail and an
- error will be logged.
+ description: AdditionalArgs allows setting additional arguments for the Prometheus container. It is intended for e.g. activating hidden flags which are not supported by the dedicated configuration options yet. The arguments are passed as-is to the Prometheus container which may cause issues if they are invalid or not supported by the given Prometheus version. In case of an argument conflict (e.g. an argument which is already set by the operator itself) or when providing an invalid argument the reconciliation will fail and an error will be logged.
items:
description: Argument as part of the AdditionalArgs list.
properties:
@@ -140,33 +103,20 @@ spec:
minLength: 1
type: string
value:
- description: Argument value, e.g. 30s. Can be empty for name-only
- arguments (e.g. --storage.tsdb.no-lockfile)
+ description: Argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile)
type: string
required:
- name
type: object
type: array
additionalScrapeConfigs:
- description: 'AdditionalScrapeConfigs allows specifying a key of a
- Secret containing additional Prometheus scrape configurations. Scrape
- configurations specified are appended to the configurations generated
- by the Prometheus Operator. Job configurations specified must have
- the form as specified in the official Prometheus documentation:
- https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config.
- As scrape configs are appended, the user is responsible to make
- sure it is valid. Note that using this feature may expose the possibility
- to break upgrades of Prometheus. It is advised to review Prometheus
- release notes to ensure that no incompatible scrape configs are
- going to break Prometheus after the upgrade.'
+ description: 'AdditionalScrapeConfigs allows specifying a key of a Secret containing additional Prometheus scrape configurations. Scrape configurations specified are appended to the configurations generated by the Prometheus Operator. Job configurations specified must have the form as specified in the official Prometheus documentation: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config. As scrape configs are appended, the user is responsible to make sure it is valid. Note that using this feature may expose the possibility to break upgrades of Prometheus. It is advised to review Prometheus release notes to ensure that no incompatible scrape configs are going to break Prometheus after the upgrade.'
properties:
key:
- description: The key of the secret to select from. Must be a
- valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
description: Specify whether the Secret or its key must be defined
@@ -179,59 +129,29 @@ spec:
description: If specified, the pod's scheduling constraints.
properties:
nodeAffinity:
- description: Describes node affinity scheduling rules for the
- pod.
+ description: Describes node affinity scheduling rules for the pod.
properties:
preferredDuringSchedulingIgnoredDuringExecution:
- description: The scheduler will prefer to schedule pods to
- nodes that satisfy the affinity expressions specified by
- this field, but it may choose a node that violates one or
- more of the expressions. The node that is most preferred
- is the one with the greatest sum of weights, i.e. for each
- node that meets all of the scheduling requirements (resource
- request, requiredDuringScheduling affinity expressions,
- etc.), compute a sum by iterating through the elements of
- this field and adding "weight" to the sum if the node matches
- the corresponding matchExpressions; the node(s) with the
- highest sum are the most preferred.
+ description: The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.
items:
- description: An empty preferred scheduling term matches
- all objects with implicit weight 0 (i.e. it's a no-op).
- A null preferred scheduling term matches no objects (i.e.
- is also a no-op).
+ description: An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
properties:
preference:
- description: A node selector term, associated with the
- corresponding weight.
+ description: A node selector term, associated with the corresponding weight.
properties:
matchExpressions:
- description: A list of node selector requirements
- by node's labels.
+ description: A list of node selector requirements by node's labels.
items:
- description: A node selector requirement is a
- selector that contains values, a key, and an
- operator that relates the key and values.
+ description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: The label key that the selector
- applies to.
+ description: The label key that the selector applies to.
type: string
operator:
- description: Represents a key's relationship
- to a set of values. Valid operators are
- In, NotIn, Exists, DoesNotExist. Gt, and
- Lt.
+ description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
type: string
values:
- description: An array of string values. If
- the operator is In or NotIn, the values
- array must be non-empty. If the operator
- is Exists or DoesNotExist, the values array
- must be empty. If the operator is Gt or
- Lt, the values array must have a single
- element, which will be interpreted as an
- integer. This array is replaced during a
- strategic merge patch.
+ description: An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -241,33 +161,18 @@ spec:
type: object
type: array
matchFields:
- description: A list of node selector requirements
- by node's fields.
+ description: A list of node selector requirements by node's fields.
items:
- description: A node selector requirement is a
- selector that contains values, a key, and an
- operator that relates the key and values.
+ description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: The label key that the selector
- applies to.
+ description: The label key that the selector applies to.
type: string
operator:
- description: Represents a key's relationship
- to a set of values. Valid operators are
- In, NotIn, Exists, DoesNotExist. Gt, and
- Lt.
+ description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
type: string
values:
- description: An array of string values. If
- the operator is In or NotIn, the values
- array must be non-empty. If the operator
- is Exists or DoesNotExist, the values array
- must be empty. If the operator is Gt or
- Lt, the values array must have a single
- element, which will be interpreted as an
- integer. This array is replaced during a
- strategic merge patch.
+ description: An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -279,8 +184,7 @@ spec:
type: object
x-kubernetes-map-type: atomic
weight:
- description: Weight associated with matching the corresponding
- nodeSelectorTerm, in the range 1-100.
+ description: Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
format: int32
type: integer
required:
@@ -289,50 +193,26 @@ spec:
type: object
type: array
requiredDuringSchedulingIgnoredDuringExecution:
- description: If the affinity requirements specified by this
- field are not met at scheduling time, the pod will not be
- scheduled onto the node. If the affinity requirements specified
- by this field cease to be met at some point during pod execution
- (e.g. due to an update), the system may or may not try to
- eventually evict the pod from its node.
+ description: If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.
properties:
nodeSelectorTerms:
- description: Required. A list of node selector terms.
- The terms are ORed.
+ description: Required. A list of node selector terms. The terms are ORed.
items:
- description: A null or empty node selector term matches
- no objects. The requirements of them are ANDed. The
- TopologySelectorTerm type implements a subset of the
- NodeSelectorTerm.
+ description: A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
properties:
matchExpressions:
- description: A list of node selector requirements
- by node's labels.
+ description: A list of node selector requirements by node's labels.
items:
- description: A node selector requirement is a
- selector that contains values, a key, and an
- operator that relates the key and values.
+ description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: The label key that the selector
- applies to.
+ description: The label key that the selector applies to.
type: string
operator:
- description: Represents a key's relationship
- to a set of values. Valid operators are
- In, NotIn, Exists, DoesNotExist. Gt, and
- Lt.
+ description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
type: string
values:
- description: An array of string values. If
- the operator is In or NotIn, the values
- array must be non-empty. If the operator
- is Exists or DoesNotExist, the values array
- must be empty. If the operator is Gt or
- Lt, the values array must have a single
- element, which will be interpreted as an
- integer. This array is replaced during a
- strategic merge patch.
+ description: An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -342,33 +222,18 @@ spec:
type: object
type: array
matchFields:
- description: A list of node selector requirements
- by node's fields.
+ description: A list of node selector requirements by node's fields.
items:
- description: A node selector requirement is a
- selector that contains values, a key, and an
- operator that relates the key and values.
+ description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: The label key that the selector
- applies to.
+ description: The label key that the selector applies to.
type: string
operator:
- description: Represents a key's relationship
- to a set of values. Valid operators are
- In, NotIn, Exists, DoesNotExist. Gt, and
- Lt.
+ description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
type: string
values:
- description: An array of string values. If
- the operator is In or NotIn, the values
- array must be non-empty. If the operator
- is Exists or DoesNotExist, the values array
- must be empty. If the operator is Gt or
- Lt, the values array must have a single
- element, which will be interpreted as an
- integer. This array is replaced during a
- strategic merge patch.
+ description: An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -386,61 +251,32 @@ spec:
x-kubernetes-map-type: atomic
type: object
podAffinity:
- description: Describes pod affinity scheduling rules (e.g. co-locate
- this pod in the same node, zone, etc. as some other pod(s)).
+ description: Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
properties:
preferredDuringSchedulingIgnoredDuringExecution:
- description: The scheduler will prefer to schedule pods to
- nodes that satisfy the affinity expressions specified by
- this field, but it may choose a node that violates one or
- more of the expressions. The node that is most preferred
- is the one with the greatest sum of weights, i.e. for each
- node that meets all of the scheduling requirements (resource
- request, requiredDuringScheduling affinity expressions,
- etc.), compute a sum by iterating through the elements of
- this field and adding "weight" to the sum if the node has
- pods which matches the corresponding podAffinityTerm; the
- node(s) with the highest sum are the most preferred.
+ description: The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
items:
- description: The weights of all of the matched WeightedPodAffinityTerm
- fields are added per-node to find the most preferred node(s)
+ description: The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
properties:
podAffinityTerm:
- description: Required. A pod affinity term, associated
- with the corresponding weight.
+ description: Required. A pod affinity term, associated with the corresponding weight.
properties:
labelSelector:
- description: A label query over a set of resources,
- in this case pods.
+ description: A label query over a set of resources, in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label
- selector requirements. The requirements are
- ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement
- is a selector that contains values, a key,
- and an operator that relates the key and
- values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that
- the selector applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's
- relationship to a set of values. Valid
- operators are In, NotIn, Exists and
- DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string
- values. If the operator is In or NotIn,
- the values array must be non-empty.
- If the operator is Exists or DoesNotExist,
- the values array must be empty. This
- array is replaced during a strategic
- merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -452,52 +288,26 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value}
- pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions,
- whose key field is "key", the operator is
- "In", and the values array contains only "value".
- The requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
namespaceSelector:
- description: A label query over the set of namespaces
- that the term applies to. The term is applied
- to the union of the namespaces selected by this
- field and the ones listed in the namespaces field.
- null selector and null or empty namespaces list
- means "this pod's namespace". An empty selector
- ({}) matches all namespaces.
+ description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
properties:
matchExpressions:
- description: matchExpressions is a list of label
- selector requirements. The requirements are
- ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement
- is a selector that contains values, a key,
- and an operator that relates the key and
- values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that
- the selector applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's
- relationship to a set of values. Valid
- operators are In, NotIn, Exists and
- DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string
- values. If the operator is In or NotIn,
- the values array must be non-empty.
- If the operator is Exists or DoesNotExist,
- the values array must be empty. This
- array is replaced during a strategic
- merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -509,40 +319,23 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value}
- pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions,
- whose key field is "key", the operator is
- "In", and the values array contains only "value".
- The requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
namespaces:
- description: namespaces specifies a static list
- of namespace names that the term applies to. The
- term is applied to the union of the namespaces
- listed in this field and the ones selected by
- namespaceSelector. null or empty namespaces list
- and null namespaceSelector means "this pod's namespace".
+ description: namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity)
- or not co-located (anti-affinity) with the pods
- matching the labelSelector in the specified namespaces,
- where co-located is defined as running on a node
- whose value of the label with key topologyKey
- matches that of any node on which any of the selected
- pods is running. Empty topologyKey is not allowed.
+ description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
type: string
required:
- topologyKey
type: object
weight:
- description: weight associated with matching the corresponding
- podAffinityTerm, in the range 1-100.
+ description: weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
format: int32
type: integer
required:
@@ -551,52 +344,26 @@ spec:
type: object
type: array
requiredDuringSchedulingIgnoredDuringExecution:
- description: If the affinity requirements specified by this
- field are not met at scheduling time, the pod will not be
- scheduled onto the node. If the affinity requirements specified
- by this field cease to be met at some point during pod execution
- (e.g. due to a pod label update), the system may or may
- not try to eventually evict the pod from its node. When
- there are multiple elements, the lists of nodes corresponding
- to each podAffinityTerm are intersected, i.e. all terms
- must be satisfied.
+ description: If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
items:
- description: Defines a set of pods (namely those matching
- the labelSelector relative to the given namespace(s))
- that this pod should be co-located (affinity) or not co-located
- (anti-affinity) with, where co-located is defined as running
- on a node whose value of the label with key <topologyKey>
- matches that of any node on which a pod of the set of
- pods is running
+ description: Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
properties:
labelSelector:
- description: A label query over a set of resources,
- in this case pods.
+ description: A label query over a set of resources, in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label
- selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a
- selector that contains values, a key, and an
- operator that relates the key and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the
- selector applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship
- to a set of values. Valid operators are
- In, NotIn, Exists and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string
- values. If the operator is In or NotIn,
- the values array must be non-empty. If the
- operator is Exists or DoesNotExist, the
- values array must be empty. This array is
- replaced during a strategic merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -608,47 +375,26 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value}
- pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions,
- whose key field is "key", the operator is "In",
- and the values array contains only "value". The
- requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
namespaceSelector:
- description: A label query over the set of namespaces
- that the term applies to. The term is applied to the
- union of the namespaces selected by this field and
- the ones listed in the namespaces field. null selector
- and null or empty namespaces list means "this pod's
- namespace". An empty selector ({}) matches all namespaces.
+ description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
properties:
matchExpressions:
- description: matchExpressions is a list of label
- selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a
- selector that contains values, a key, and an
- operator that relates the key and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the
- selector applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship
- to a set of values. Valid operators are
- In, NotIn, Exists and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string
- values. If the operator is In or NotIn,
- the values array must be non-empty. If the
- operator is Exists or DoesNotExist, the
- values array must be empty. This array is
- replaced during a strategic merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -660,33 +406,17 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value}
- pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions,
- whose key field is "key", the operator is "In",
- and the values array contains only "value". The
- requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
namespaces:
- description: namespaces specifies a static list of namespace
- names that the term applies to. The term is applied
- to the union of the namespaces listed in this field
- and the ones selected by namespaceSelector. null or
- empty namespaces list and null namespaceSelector means
- "this pod's namespace".
+ description: namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity)
- or not co-located (anti-affinity) with the pods matching
- the labelSelector in the specified namespaces, where
- co-located is defined as running on a node whose value
- of the label with key topologyKey matches that of
- any node on which any of the selected pods is running.
- Empty topologyKey is not allowed.
+ description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
type: string
required:
- topologyKey
@@ -694,62 +424,32 @@ spec:
type: array
type: object
podAntiAffinity:
- description: Describes pod anti-affinity scheduling rules (e.g.
- avoid putting this pod in the same node, zone, etc. as some
- other pod(s)).
+ description: Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
properties:
preferredDuringSchedulingIgnoredDuringExecution:
- description: The scheduler will prefer to schedule pods to
- nodes that satisfy the anti-affinity expressions specified
- by this field, but it may choose a node that violates one
- or more of the expressions. The node that is most preferred
- is the one with the greatest sum of weights, i.e. for each
- node that meets all of the scheduling requirements (resource
- request, requiredDuringScheduling anti-affinity expressions,
- etc.), compute a sum by iterating through the elements of
- this field and adding "weight" to the sum if the node has
- pods which matches the corresponding podAffinityTerm; the
- node(s) with the highest sum are the most preferred.
+ description: The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
items:
- description: The weights of all of the matched WeightedPodAffinityTerm
- fields are added per-node to find the most preferred node(s)
+ description: The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
properties:
podAffinityTerm:
- description: Required. A pod affinity term, associated
- with the corresponding weight.
+ description: Required. A pod affinity term, associated with the corresponding weight.
properties:
labelSelector:
- description: A label query over a set of resources,
- in this case pods.
+ description: A label query over a set of resources, in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label
- selector requirements. The requirements are
- ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement
- is a selector that contains values, a key,
- and an operator that relates the key and
- values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that
- the selector applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's
- relationship to a set of values. Valid
- operators are In, NotIn, Exists and
- DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string
- values. If the operator is In or NotIn,
- the values array must be non-empty.
- If the operator is Exists or DoesNotExist,
- the values array must be empty. This
- array is replaced during a strategic
- merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -761,52 +461,26 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value}
- pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions,
- whose key field is "key", the operator is
- "In", and the values array contains only "value".
- The requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
namespaceSelector:
- description: A label query over the set of namespaces
- that the term applies to. The term is applied
- to the union of the namespaces selected by this
- field and the ones listed in the namespaces field.
- null selector and null or empty namespaces list
- means "this pod's namespace". An empty selector
- ({}) matches all namespaces.
+ description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
properties:
matchExpressions:
- description: matchExpressions is a list of label
- selector requirements. The requirements are
- ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement
- is a selector that contains values, a key,
- and an operator that relates the key and
- values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that
- the selector applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's
- relationship to a set of values. Valid
- operators are In, NotIn, Exists and
- DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string
- values. If the operator is In or NotIn,
- the values array must be non-empty.
- If the operator is Exists or DoesNotExist,
- the values array must be empty. This
- array is replaced during a strategic
- merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -818,40 +492,23 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value}
- pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions,
- whose key field is "key", the operator is
- "In", and the values array contains only "value".
- The requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
namespaces:
- description: namespaces specifies a static list
- of namespace names that the term applies to. The
- term is applied to the union of the namespaces
- listed in this field and the ones selected by
- namespaceSelector. null or empty namespaces list
- and null namespaceSelector means "this pod's namespace".
+ description: namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity)
- or not co-located (anti-affinity) with the pods
- matching the labelSelector in the specified namespaces,
- where co-located is defined as running on a node
- whose value of the label with key topologyKey
- matches that of any node on which any of the selected
- pods is running. Empty topologyKey is not allowed.
+ description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
type: string
required:
- topologyKey
type: object
weight:
- description: weight associated with matching the corresponding
- podAffinityTerm, in the range 1-100.
+ description: weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
format: int32
type: integer
required:
@@ -860,52 +517,26 @@ spec:
type: object
type: array
requiredDuringSchedulingIgnoredDuringExecution:
- description: If the anti-affinity requirements specified by
- this field are not met at scheduling time, the pod will
- not be scheduled onto the node. If the anti-affinity requirements
- specified by this field cease to be met at some point during
- pod execution (e.g. due to a pod label update), the system
- may or may not try to eventually evict the pod from its
- node. When there are multiple elements, the lists of nodes
- corresponding to each podAffinityTerm are intersected, i.e.
- all terms must be satisfied.
+ description: If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
items:
- description: Defines a set of pods (namely those matching
- the labelSelector relative to the given namespace(s))
- that this pod should be co-located (affinity) or not co-located
- (anti-affinity) with, where co-located is defined as running
- on a node whose value of the label with key <topologyKey>
- matches that of any node on which a pod of the set of
- pods is running
+ description: Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
properties:
labelSelector:
- description: A label query over a set of resources,
- in this case pods.
+ description: A label query over a set of resources, in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label
- selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a
- selector that contains values, a key, and an
- operator that relates the key and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the
- selector applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship
- to a set of values. Valid operators are
- In, NotIn, Exists and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string
- values. If the operator is In or NotIn,
- the values array must be non-empty. If the
- operator is Exists or DoesNotExist, the
- values array must be empty. This array is
- replaced during a strategic merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -917,47 +548,26 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value}
- pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions,
- whose key field is "key", the operator is "In",
- and the values array contains only "value". The
- requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
namespaceSelector:
- description: A label query over the set of namespaces
- that the term applies to. The term is applied to the
- union of the namespaces selected by this field and
- the ones listed in the namespaces field. null selector
- and null or empty namespaces list means "this pod's
- namespace". An empty selector ({}) matches all namespaces.
+ description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
properties:
matchExpressions:
- description: matchExpressions is a list of label
- selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a
- selector that contains values, a key, and an
- operator that relates the key and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the
- selector applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship
- to a set of values. Valid operators are
- In, NotIn, Exists and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string
- values. If the operator is In or NotIn,
- the values array must be non-empty. If the
- operator is Exists or DoesNotExist, the
- values array must be empty. This array is
- replaced during a strategic merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -969,33 +579,17 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value}
- pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions,
- whose key field is "key", the operator is "In",
- and the values array contains only "value". The
- requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
namespaces:
- description: namespaces specifies a static list of namespace
- names that the term applies to. The term is applied
- to the union of the namespaces listed in this field
- and the ones selected by namespaceSelector. null or
- empty namespaces list and null namespaceSelector means
- "this pod's namespace".
+ description: namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity)
- or not co-located (anti-affinity) with the pods matching
- the labelSelector in the specified namespaces, where
- co-located is defined as running on a node whose value
- of the label with key topologyKey matches that of
- any node on which any of the selected pods is running.
- Empty topologyKey is not allowed.
+ description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
type: string
required:
- topologyKey
@@ -1007,88 +601,66 @@ spec:
description: Define details regarding alerting.
properties:
alertmanagers:
- description: AlertmanagerEndpoints Prometheus should fire alerts
- against.
+ description: AlertmanagerEndpoints Prometheus should fire alerts against.
items:
- description: AlertmanagerEndpoints defines a selection of a
- single Endpoints object containing alertmanager IPs to fire
- alerts against.
+ description: AlertmanagerEndpoints defines a selection of a single Endpoints object containing alertmanager IPs to fire alerts against.
properties:
apiVersion:
- description: Version of the Alertmanager API that Prometheus
- uses to send alerts. It can be "v1" or "v2".
+ description: Version of the Alertmanager API that Prometheus uses to send alerts. It can be "v1" or "v2".
type: string
authorization:
- description: Authorization section for this alertmanager
- endpoint
+ description: Authorization section for this alertmanager endpoint
properties:
credentials:
- description: The secret's key that contains the credentials
- of the request
+ description: The secret's key that contains the credentials of the request
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
type:
- description: Set the authentication type. Defaults to
- Bearer, Basic will cause an error
+ description: Set the authentication type. Defaults to Bearer, Basic will cause an error
type: string
type: object
basicAuth:
- description: BasicAuth allow an endpoint to authenticate
- over basic authentication
+ description: BasicAuth allow an endpoint to authenticate over basic authentication
properties:
password:
- description: The secret in the service monitor namespace
- that contains the password for authentication.
+ description: The secret in the service monitor namespace that contains the password for authentication.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
username:
- description: The secret in the service monitor namespace
- that contains the username for authentication.
+ description: The secret in the service monitor namespace that contains the username for authentication.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -1096,8 +668,7 @@ spec:
x-kubernetes-map-type: atomic
type: object
bearerTokenFile:
- description: BearerTokenFile to read from filesystem to
- use when authenticating to Alertmanager.
+ description: BearerTokenFile to read from filesystem to use when authenticating to Alertmanager.
type: string
enableHttp2:
description: Whether to enable HTTP2.
@@ -1109,8 +680,7 @@ spec:
description: Namespace of Endpoints object.
type: string
pathPrefix:
- description: Prefix for the HTTP path alerts are pushed
- to.
+ description: Prefix for the HTTP path alerts are pushed to.
type: string
port:
anyOf:
@@ -1122,55 +692,42 @@ spec:
description: Scheme to use when firing alerts.
type: string
timeout:
- description: Timeout is a per-target Alertmanager timeout
- when pushing alerts.
+ description: Timeout is a per-target Alertmanager timeout when pushing alerts.
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
tlsConfig:
description: TLS Config to use for alertmanager connection.
properties:
ca:
- description: Certificate authority used when verifying
- server certificates.
+ description: Certificate authority used when verifying server certificates.
properties:
configMap:
- description: ConfigMap containing data to use for
- the targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or
- its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
secret:
- description: Secret containing data to use for the
- targets.
+ description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its
- key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -1178,51 +735,38 @@ spec:
x-kubernetes-map-type: atomic
type: object
caFile:
- description: Path to the CA cert in the Prometheus container
- to use for the targets.
+ description: Path to the CA cert in the Prometheus container to use for the targets.
type: string
cert:
- description: Client certificate to present when doing
- client-authentication.
+ description: Client certificate to present when doing client-authentication.
properties:
configMap:
- description: ConfigMap containing data to use for
- the targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or
- its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
secret:
- description: Secret containing data to use for the
- targets.
+ description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to select
- from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion,
- kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its
- key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -1230,32 +774,25 @@ spec:
x-kubernetes-map-type: atomic
type: object
certFile:
- description: Path to the client cert file in the Prometheus
- container for the targets.
+ description: Path to the client cert file in the Prometheus container for the targets.
type: string
insecureSkipVerify:
description: Disable target certificate validation.
type: boolean
keyFile:
- description: Path to the client key file in the Prometheus
- container for the targets.
+ description: Path to the client key file in the Prometheus container for the targets.
type: string
keySecret:
- description: Secret containing the client key file for
- the targets.
+ description: Secret containing the client key file for the targets.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -1275,87 +812,67 @@ spec:
- alertmanagers
type: object
allowOverlappingBlocks:
- description: AllowOverlappingBlocks enables vertical compaction and
- vertical query merge in Prometheus. This is still experimental in
- Prometheus so it may change in any upcoming release.
+ description: AllowOverlappingBlocks enables vertical compaction and vertical query merge in Prometheus. This is still experimental in Prometheus so it may change in any upcoming release.
type: boolean
apiserverConfig:
- description: APIServerConfig allows specifying a host and auth methods
- to access apiserver. If left empty, Prometheus is assumed to run
- inside of the cluster and will discover API servers automatically
- and use the pod's CA certificate and bearer token file at /var/run/secrets/kubernetes.io/serviceaccount/.
+ description: APIServerConfig allows specifying a host and auth methods to access apiserver. If left empty, Prometheus is assumed to run inside of the cluster and will discover API servers automatically and use the pod's CA certificate and bearer token file at /var/run/secrets/kubernetes.io/serviceaccount/.
properties:
authorization:
description: Authorization section for accessing apiserver
properties:
credentials:
- description: The secret's key that contains the credentials
- of the request
+ description: The secret's key that contains the credentials of the request
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
credentialsFile:
- description: File to read a secret from, mutually exclusive
- with Credentials (from SafeAuthorization)
+ description: File to read a secret from, mutually exclusive with Credentials (from SafeAuthorization)
type: string
type:
- description: Set the authentication type. Defaults to Bearer,
- Basic will cause an error
+ description: Set the authentication type. Defaults to Bearer, Basic will cause an error
type: string
type: object
basicAuth:
- description: BasicAuth allow an endpoint to authenticate over
- basic authentication
+ description: BasicAuth allow an endpoint to authenticate over basic authentication
properties:
password:
- description: The secret in the service monitor namespace that
- contains the password for authentication.
+ description: The secret in the service monitor namespace that contains the password for authentication.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
username:
- description: The secret in the service monitor namespace that
- contains the username for authentication.
+ description: The secret in the service monitor namespace that contains the username for authentication.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -1369,31 +886,25 @@ spec:
description: File to read bearer token for accessing apiserver.
type: string
host:
- description: Host of apiserver. A valid string consisting of a
- hostname or IP followed by an optional port number
+ description: Host of apiserver. A valid string consisting of a hostname or IP followed by an optional port number
type: string
tlsConfig:
description: TLS Config to use for accessing apiserver.
properties:
ca:
- description: Certificate authority used when verifying server
- certificates.
+ description: Certificate authority used when verifying server certificates.
properties:
configMap:
- description: ConfigMap containing data to use for the
- targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its
- key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
@@ -1403,17 +914,13 @@ spec:
description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -1421,27 +928,22 @@ spec:
x-kubernetes-map-type: atomic
type: object
caFile:
- description: Path to the CA cert in the Prometheus container
- to use for the targets.
+ description: Path to the CA cert in the Prometheus container to use for the targets.
type: string
cert:
description: Client certificate to present when doing client-authentication.
properties:
configMap:
- description: ConfigMap containing data to use for the
- targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its
- key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
@@ -1451,17 +953,13 @@ spec:
description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -1469,31 +967,25 @@ spec:
x-kubernetes-map-type: atomic
type: object
certFile:
- description: Path to the client cert file in the Prometheus
- container for the targets.
+ description: Path to the client cert file in the Prometheus container for the targets.
type: string
insecureSkipVerify:
description: Disable target certificate validation.
type: boolean
keyFile:
- description: Path to the client key file in the Prometheus
- container for the targets.
+ description: Path to the client key file in the Prometheus container for the targets.
type: string
keySecret:
- description: Secret containing the client key file for the
- targets.
+ description: Secret containing the client key file for the targets.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -1507,95 +999,47 @@ spec:
- host
type: object
arbitraryFSAccessThroughSMs:
- description: ArbitraryFSAccessThroughSMs configures whether configuration
- based on a service monitor can access arbitrary files on the file
- system of the Prometheus container e.g. bearer token files.
+ description: ArbitraryFSAccessThroughSMs configures whether configuration based on a service monitor can access arbitrary files on the file system of the Prometheus container e.g. bearer token files.
properties:
deny:
type: boolean
type: object
baseImage:
- description: 'Base image to use for a Prometheus deployment. Deprecated:
- use ''image'' instead'
+ description: 'Base image to use for a Prometheus deployment. Deprecated: use ''image'' instead'
type: string
configMaps:
- description: ConfigMaps is a list of ConfigMaps in the same namespace
- as the Prometheus object, which shall be mounted into the Prometheus
- Pods. Each ConfigMap is added to the StatefulSet definition as a
- volume named `configmap-<configmap-name>`. The ConfigMaps are mounted
- into /etc/prometheus/configmaps/<configmap-name> in the 'prometheus'
- container.
+ description: ConfigMaps is a list of ConfigMaps in the same namespace as the Prometheus object, which shall be mounted into the Prometheus Pods. Each ConfigMap is added to the StatefulSet definition as a volume named `configmap-<configmap-name>`. The ConfigMaps are mounted into /etc/prometheus/configmaps/<configmap-name> in the 'prometheus' container.
items:
type: string
type: array
containers:
- description: 'Containers allows injecting additional containers or
- modifying operator generated containers. This can be used to allow
- adding an authentication proxy to a Prometheus pod or to change
- the behavior of an operator generated container. Containers described
- here modify an operator generated container if they share the same
- name and modifications are done via a strategic merge patch. The
- current container names are: `prometheus`, `config-reloader`, and
- `thanos-sidecar`. Overriding containers is entirely outside the
- scope of what the maintainers will support and by doing so, you
- accept that this behaviour may break at any time without notice.'
+ description: 'Containers allows injecting additional containers or modifying operator generated containers. This can be used to allow adding an authentication proxy to a Prometheus pod or to change the behavior of an operator generated container. Containers described here modify an operator generated container if they share the same name and modifications are done via a strategic merge patch. The current container names are: `prometheus`, `config-reloader`, and `thanos-sidecar`. Overriding containers is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice.'
items:
- description: A single application container that you want to run
- within a pod.
+ description: A single application container that you want to run within a pod.
properties:
args:
- description: 'Arguments to the entrypoint. The container image''s
- CMD is used if this is not provided. Variable references $(VAR_NAME)
- are expanded using the container''s environment. If a variable
- cannot be resolved, the reference in the input string will
- be unchanged. Double $$ are reduced to a single $, which allows
- for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references
- will never be expanded, regardless of whether the variable
- exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
+ description: 'Arguments to the entrypoint. The container image''s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container''s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
command:
- description: 'Entrypoint array. Not executed within a shell.
- The container image''s ENTRYPOINT is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container''s
- environment. If a variable cannot be resolved, the reference
- in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax:
- i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
- Escaped references will never be expanded, regardless of whether
- the variable exists or not. Cannot be updated. More info:
- https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
+ description: 'Entrypoint array. Not executed within a shell. The container image''s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container''s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
env:
- description: List of environment variables to set in the container.
- Cannot be updated.
+ description: List of environment variables to set in the container. Cannot be updated.
items:
- description: EnvVar represents an environment variable present
- in a Container.
+ description: EnvVar represents an environment variable present in a Container.
properties:
name:
- description: Name of the environment variable. Must be
- a C_IDENTIFIER.
+ description: Name of the environment variable. Must be a C_IDENTIFIER.
type: string
value:
- description: 'Variable references $(VAR_NAME) are expanded
- using the previously defined environment variables in
- the container and any service environment variables.
- If a variable cannot be resolved, the reference in the
- input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME)
- syntax: i.e. "$$(VAR_NAME)" will produce the string
- literal "$(VAR_NAME)". Escaped references will never
- be expanded, regardless of whether the variable exists
- or not. Defaults to "".'
+ description: 'Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".'
type: string
valueFrom:
- description: Source for the environment variable's value.
- Cannot be used if value is not empty.
+ description: Source for the environment variable's value. Cannot be used if value is not empty.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -1604,55 +1048,39 @@ spec:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or
- its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
fieldRef:
- description: 'Selects a field of the pod: supports
- metadata.name, metadata.namespace, `metadata.labels[''<KEY>'']`,
- `metadata.annotations[''<KEY>'']`, spec.nodeName,
- spec.serviceAccountName, status.hostIP, status.podIP,
- status.podIPs.'
+ description: 'Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels[''<KEY>'']`, `metadata.annotations[''<KEY>'']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.'
properties:
apiVersion:
- description: Version of the schema the FieldPath
- is written in terms of, defaults to "v1".
+ description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
type: string
fieldPath:
- description: Path of the field to select in the
- specified API version.
+ description: Path of the field to select in the specified API version.
type: string
required:
- fieldPath
type: object
x-kubernetes-map-type: atomic
resourceFieldRef:
- description: 'Selects a resource of the container:
- only resources limits and requests (limits.cpu,
- limits.memory, limits.ephemeral-storage, requests.cpu,
- requests.memory and requests.ephemeral-storage)
- are currently supported.'
+ description: 'Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.'
properties:
containerName:
- description: 'Container name: required for volumes,
- optional for env vars'
+ description: 'Container name: required for volumes, optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format of the
- exposed resources, defaults to "1"
+ description: Specifies the output format of the exposed resources, defaults to "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
@@ -1663,22 +1091,16 @@ spec:
type: object
x-kubernetes-map-type: atomic
secretKeyRef:
- description: Selects a key of a secret in the pod's
- namespace
+ description: Selects a key of a secret in the pod's namespace
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its
- key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -1690,42 +1112,29 @@ spec:
type: object
type: array
envFrom:
- description: List of sources to populate environment variables
- in the container. The keys defined within a source must be
- a C_IDENTIFIER. All invalid keys will be reported as an event
- when the container is starting. When a key exists in multiple
- sources, the value associated with the last source will take
- precedence. Values defined by an Env with a duplicate key
- will take precedence. Cannot be updated.
+ description: List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
items:
- description: EnvFromSource represents the source of a set
- of ConfigMaps
+ description: EnvFromSource represents the source of a set of ConfigMaps
properties:
configMapRef:
description: The ConfigMap to select from
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap must be
- defined
+ description: Specify whether the ConfigMap must be defined
type: boolean
type: object
x-kubernetes-map-type: atomic
prefix:
- description: An optional identifier to prepend to each
- key in the ConfigMap. Must be a C_IDENTIFIER.
+ description: An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
type: string
secretRef:
description: The Secret to select from
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
description: Specify whether the Secret must be defined
@@ -1735,40 +1144,22 @@ spec:
type: object
type: array
image:
- description: 'Container image name. More info: https://kubernetes.io/docs/concepts/containers/images
- This field is optional to allow higher level config management
- to default or override container images in workload controllers
- like Deployments and StatefulSets.'
+ description: 'Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.'
type: string
imagePullPolicy:
- description: 'Image pull policy. One of Always, Never, IfNotPresent.
- Defaults to Always if :latest tag is specified, or IfNotPresent
- otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
+ description: 'Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
- description: Actions that the management system should take
- in response to container lifecycle events. Cannot be updated.
+ description: Actions that the management system should take in response to container lifecycle events. Cannot be updated.
properties:
postStart:
- description: 'PostStart is called immediately after a container
- is created. If the handler fails, the container is terminated
- and restarted according to its restart policy. Other management
- of the container blocks until the hook completes. More
- info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
+ description: 'PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: Command is the command line to execute
- inside the container, the working directory for
- the command is root ('/') in the container's
- filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions
- ('|', etc) won't work. To use a shell, you need
- to explicitly call out to that shell. Exit status
- of 0 is treated as live/healthy and non-zero is
- unhealthy.
+ description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
@@ -1777,16 +1168,12 @@ spec:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to
- the pod IP. You probably want to set "Host" in
- httpHeaders instead.
+ description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request.
- HTTP allows repeated headers.
+ description: Custom headers to set in the request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header
- to be used in HTTP probes
+ description: HTTPHeader describes a custom header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -1806,65 +1193,38 @@ spec:
anyOf:
- type: integer
- type: string
- description: Name or number of the port to access
- on the container. Number must be in the range
- 1 to 65535. Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the
- host. Defaults to HTTP.
+ description: Scheme to use for connecting to the host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: Deprecated. TCPSocket is NOT supported
- as a LifecycleHandler and kept for the backward compatibility.
- There are no validation of this field and lifecycle
- hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.
properties:
host:
- description: 'Optional: Host name to connect to,
- defaults to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: Number or name of the port to access
- on the container. Number must be in the range
- 1 to 65535. Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
preStop:
- description: 'PreStop is called immediately before a container
- is terminated due to an API request or management event
- such as liveness/startup probe failure, preemption, resource
- contention, etc. The handler is not called if the container
- crashes or exits. The Pod''s termination grace period
- countdown begins before the PreStop hook is executed.
- Regardless of the outcome of the handler, the container
- will eventually terminate within the Pod''s termination
- grace period (unless delayed by finalizers). Other management
- of the container blocks until the hook completes or until
- the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
+ description: 'PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod''s termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod''s termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: Command is the command line to execute
- inside the container, the working directory for
- the command is root ('/') in the container's
- filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions
- ('|', etc) won't work. To use a shell, you need
- to explicitly call out to that shell. Exit status
- of 0 is treated as live/healthy and non-zero is
- unhealthy.
+ description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
@@ -1873,16 +1233,12 @@ spec:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to
- the pod IP. You probably want to set "Host" in
- httpHeaders instead.
+ description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request.
- HTTP allows repeated headers.
+ description: Custom headers to set in the request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header
- to be used in HTTP probes
+ description: HTTPHeader describes a custom header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -1902,34 +1258,25 @@ spec:
anyOf:
- type: integer
- type: string
- description: Name or number of the port to access
- on the container. Number must be in the range
- 1 to 65535. Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the
- host. Defaults to HTTP.
+ description: Scheme to use for connecting to the host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: Deprecated. TCPSocket is NOT supported
- as a LifecycleHandler and kept for the backward compatibility.
- There are no validation of this field and lifecycle
- hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.
properties:
host:
- description: 'Optional: Host name to connect to,
- defaults to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: Number or name of the port to access
- on the container. Number must be in the range
- 1 to 65535. Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
@@ -1937,47 +1284,30 @@ spec:
type: object
type: object
livenessProbe:
- description: 'Periodic probe of container liveness. Container
- will be restarted if the probe fails. Cannot be updated. More
- info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: Command is the command line to execute
- inside the container, the working directory for the
- command is root ('/') in the container's filesystem.
- The command is simply exec'd, it is not run inside
- a shell, so traditional shell instructions ('|', etc)
- won't work. To use a shell, you need to explicitly
- call out to that shell. Exit status of 0 is treated
- as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe
- to be considered failed after having succeeded. Defaults
- to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
format: int32
type: integer
grpc:
- description: GRPC specifies an action involving a GRPC port.
- This is a beta field and requires enabling GRPCContainerProbe
- feature gate.
+ description: GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.
properties:
port:
- description: Port number of the gRPC service. Number
- must be in the range 1 to 65535.
+ description: Port number of the gRPC service. Number must be in the range 1 to 65535.
format: int32
type: integer
service:
- description: "Service is the name of the service to
- place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
- \n If this is not specified, the default behavior
- is defined by gRPC."
+ description: "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). \n If this is not specified, the default behavior is defined by gRPC."
type: string
required:
- port
@@ -1986,16 +1316,12 @@ spec:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to the
- pod IP. You probably want to set "Host" in httpHeaders
- instead.
+ description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP
- allows repeated headers.
+ description: Custom headers to set in the request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header
- to be used in HTTP probes
+ description: HTTPHeader describes a custom header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -2015,120 +1341,75 @@ spec:
anyOf:
- type: integer
- type: string
- description: Name or number of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: 'Number of seconds after the container has
- started before liveness probes are initiated. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
format: int32
type: integer
successThreshold:
- description: Minimum consecutive successes for the probe
- to be considered successful after having failed. Defaults
- to 1. Must be 1 for liveness and startup. Minimum value
- is 1.
+ description: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
- description: TCPSocket specifies an action involving a TCP
- port.
+ description: TCPSocket specifies an action involving a TCP port.
properties:
host:
- description: 'Optional: Host name to connect to, defaults
- to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: Number or name of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: Optional duration in seconds the pod needs
- to terminate gracefully upon probe failure. The grace
- period is the duration in seconds after the processes
- running in the pod are sent a termination signal and the
- time when the processes are forcibly halted with a kill
- signal. Set this value longer than the expected cleanup
- time for your process. If this value is nil, the pod's
- terminationGracePeriodSeconds will be used. Otherwise,
- this value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates
- stop immediately via the kill signal (no opportunity to
- shut down). This is a beta field and requires enabling
- ProbeTerminationGracePeriod feature gate. Minimum value
- is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: 'Number of seconds after which the probe times
- out. Defaults to 1 second. Minimum value is 1. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
name:
- description: Name of the container specified as a DNS_LABEL.
- Each container in a pod must have a unique name (DNS_LABEL).
- Cannot be updated.
+ description: Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
type: string
ports:
- description: List of ports to expose from the container. Not
- specifying a port here DOES NOT prevent that port from being
- exposed. Any port which is listening on the default "0.0.0.0"
- address inside a container will be accessible from the network.
- Modifying this array with strategic merge patch may corrupt
- the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255.
- Cannot be updated.
+ description: List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.
items:
- description: ContainerPort represents a network port in a
- single container.
+ description: ContainerPort represents a network port in a single container.
properties:
containerPort:
- description: Number of port to expose on the pod's IP
- address. This must be a valid port number, 0 < x < 65536.
+ description: Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
format: int32
type: integer
hostIP:
description: What host IP to bind the external port to.
type: string
hostPort:
- description: Number of port to expose on the host. If
- specified, this must be a valid port number, 0 < x <
- 65536. If HostNetwork is specified, this must match
- ContainerPort. Most containers do not need this.
+ description: Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.
format: int32
type: integer
name:
- description: If specified, this must be an IANA_SVC_NAME
- and unique within the pod. Each named port in a pod
- must have a unique name. Name for the port that can
- be referred to by services.
+ description: If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
type: string
protocol:
default: TCP
- description: Protocol for port. Must be UDP, TCP, or SCTP.
- Defaults to "TCP".
+ description: Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".
type: string
required:
- containerPort
@@ -2139,47 +1420,30 @@ spec:
- protocol
x-kubernetes-list-type: map
readinessProbe:
- description: 'Periodic probe of container service readiness.
- Container will be removed from service endpoints if the probe
- fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: Command is the command line to execute
- inside the container, the working directory for the
- command is root ('/') in the container's filesystem.
- The command is simply exec'd, it is not run inside
- a shell, so traditional shell instructions ('|', etc)
- won't work. To use a shell, you need to explicitly
- call out to that shell. Exit status of 0 is treated
- as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe
- to be considered failed after having succeeded. Defaults
- to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
format: int32
type: integer
grpc:
- description: GRPC specifies an action involving a GRPC port.
- This is a beta field and requires enabling GRPCContainerProbe
- feature gate.
+ description: GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.
properties:
port:
- description: Port number of the gRPC service. Number
- must be in the range 1 to 65535.
+ description: Port number of the gRPC service. Number must be in the range 1 to 65535.
format: int32
type: integer
service:
- description: "Service is the name of the service to
- place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
- \n If this is not specified, the default behavior
- is defined by gRPC."
+ description: "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). \n If this is not specified, the default behavior is defined by gRPC."
type: string
required:
- port
@@ -2188,16 +1452,12 @@ spec:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to the
- pod IP. You probably want to set "Host" in httpHeaders
- instead.
+ description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP
- allows repeated headers.
+ description: Custom headers to set in the request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header
- to be used in HTTP probes
+ description: HTTPHeader describes a custom header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -2217,95 +1477,60 @@ spec:
anyOf:
- type: integer
- type: string
- description: Name or number of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: 'Number of seconds after the container has
- started before liveness probes are initiated. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
format: int32
type: integer
successThreshold:
- description: Minimum consecutive successes for the probe
- to be considered successful after having failed. Defaults
- to 1. Must be 1 for liveness and startup. Minimum value
- is 1.
+ description: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
- description: TCPSocket specifies an action involving a TCP
- port.
+ description: TCPSocket specifies an action involving a TCP port.
properties:
host:
- description: 'Optional: Host name to connect to, defaults
- to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: Number or name of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: Optional duration in seconds the pod needs
- to terminate gracefully upon probe failure. The grace
- period is the duration in seconds after the processes
- running in the pod are sent a termination signal and the
- time when the processes are forcibly halted with a kill
- signal. Set this value longer than the expected cleanup
- time for your process. If this value is nil, the pod's
- terminationGracePeriodSeconds will be used. Otherwise,
- this value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates
- stop immediately via the kill signal (no opportunity to
- shut down). This is a beta field and requires enabling
- ProbeTerminationGracePeriod feature gate. Minimum value
- is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: 'Number of seconds after which the probe times
- out. Defaults to 1 second. Minimum value is 1. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
resources:
- description: 'Compute Resources required by this container.
- Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
properties:
claims:
- description: "Claims lists the names of resources, defined
- in spec.resourceClaims, that are used by this container.
- \n This is an alpha field and requires enabling the DynamicResourceAllocation
- feature gate. \n This field is immutable."
+ description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable."
items:
description: ResourceClaim references one entry in PodSpec.ResourceClaims.
properties:
name:
- description: Name must match the name of one entry
- in pod.spec.resourceClaims of the Pod where this
- field is used. It makes that resource available
- inside a container.
+ description: Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
type: string
required:
- name
@@ -2321,8 +1546,7 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute
- resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -2331,236 +1555,121 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Requests describes the minimum amount of compute
- resources required. If Requests is omitted for a container,
- it defaults to Limits if that is explicitly specified,
- otherwise to an implementation-defined value. More info:
- https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
securityContext:
- description: 'SecurityContext defines the security options the
- container should be run with. If set, the fields of SecurityContext
- override the equivalent fields of PodSecurityContext. More
- info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
+ description: 'SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
properties:
allowPrivilegeEscalation:
- description: 'AllowPrivilegeEscalation controls whether
- a process can gain more privileges than its parent process.
- This bool directly controls if the no_new_privs flag will
- be set on the container process. AllowPrivilegeEscalation
- is true always when the container is: 1) run as Privileged
- 2) has CAP_SYS_ADMIN Note that this field cannot be set
- when spec.os.name is windows.'
+ description: 'AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.'
type: boolean
capabilities:
- description: The capabilities to add/drop when running containers.
- Defaults to the default set of capabilities granted by
- the container runtime. Note that this field cannot be
- set when spec.os.name is windows.
+ description: The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.
properties:
add:
description: Added capabilities
items:
- description: Capability represent POSIX capabilities
- type
+ description: Capability represent POSIX capabilities type
type: string
type: array
drop:
description: Removed capabilities
items:
- description: Capability represent POSIX capabilities
- type
+ description: Capability represent POSIX capabilities type
type: string
type: array
type: object
privileged:
- description: Run container in privileged mode. Processes
- in privileged containers are essentially equivalent to
- root on the host. Defaults to false. Note that this field
- cannot be set when spec.os.name is windows.
+ description: Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.
type: boolean
procMount:
- description: procMount denotes the type of proc mount to
- use for the containers. The default is DefaultProcMount
- which uses the container runtime defaults for readonly
- paths and masked paths. This requires the ProcMountType
- feature flag to be enabled. Note that this field cannot
- be set when spec.os.name is windows.
+ description: procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.
type: string
readOnlyRootFilesystem:
- description: Whether this container has a read-only root
- filesystem. Default is false. Note that this field cannot
- be set when spec.os.name is windows.
+ description: Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.
type: boolean
runAsGroup:
- description: The GID to run the entrypoint of the container
- process. Uses runtime default if unset. May also be set
- in PodSecurityContext. If set in both SecurityContext
- and PodSecurityContext, the value specified in SecurityContext
- takes precedence. Note that this field cannot be set when
- spec.os.name is windows.
+ description: The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
format: int64
type: integer
runAsNonRoot:
- description: Indicates that the container must run as a
- non-root user. If true, the Kubelet will validate the
- image at runtime to ensure that it does not run as UID
- 0 (root) and fail to start the container if it does. If
- unset or false, no such validation will be performed.
- May also be set in PodSecurityContext. If set in both
- SecurityContext and PodSecurityContext, the value specified
- in SecurityContext takes precedence.
+ description: Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
type: boolean
runAsUser:
- description: The UID to run the entrypoint of the container
- process. Defaults to user specified in image metadata
- if unspecified. May also be set in PodSecurityContext. If
- set in both SecurityContext and PodSecurityContext, the
- value specified in SecurityContext takes precedence. Note
- that this field cannot be set when spec.os.name is windows.
+ description: The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
format: int64
type: integer
seLinuxOptions:
- description: The SELinux context to be applied to the container.
- If unspecified, the container runtime will allocate a
- random SELinux context for each container. May also be
- set in PodSecurityContext. If set in both SecurityContext
- and PodSecurityContext, the value specified in SecurityContext
- takes precedence. Note that this field cannot be set when
- spec.os.name is windows.
+ description: The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
properties:
level:
- description: Level is SELinux level label that applies
- to the container.
+ description: Level is SELinux level label that applies to the container.
type: string
role:
- description: Role is a SELinux role label that applies
- to the container.
+ description: Role is a SELinux role label that applies to the container.
type: string
type:
- description: Type is a SELinux type label that applies
- to the container.
+ description: Type is a SELinux type label that applies to the container.
type: string
user:
- description: User is a SELinux user label that applies
- to the container.
+ description: User is a SELinux user label that applies to the container.
type: string
type: object
seccompProfile:
- description: The seccomp options to use by this container.
- If seccomp options are provided at both the pod & container
- level, the container options override the pod options.
- Note that this field cannot be set when spec.os.name is
- windows.
+ description: The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
properties:
localhostProfile:
- description: localhostProfile indicates a profile defined
- in a file on the node should be used. The profile
- must be preconfigured on the node to work. Must be
- a descending path, relative to the kubelet's configured
- seccomp profile location. Must only be set if type
- is "Localhost".
+ description: localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost".
type: string
type:
- description: "type indicates which kind of seccomp profile
- will be applied. Valid options are: \n Localhost -
- a profile defined in a file on the node should be
- used. RuntimeDefault - the container runtime default
- profile should be used. Unconfined - no profile should
- be applied."
+ description: "type indicates which kind of seccomp profile will be applied. Valid options are: \n Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied."
type: string
required:
- type
type: object
windowsOptions:
- description: The Windows specific settings applied to all
- containers. If unspecified, the options from the PodSecurityContext
- will be used. If set in both SecurityContext and PodSecurityContext,
- the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is
- linux.
+ description: The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
properties:
gmsaCredentialSpec:
- description: GMSACredentialSpec is where the GMSA admission
- webhook (https://github.com/kubernetes-sigs/windows-gmsa)
- inlines the contents of the GMSA credential spec named
- by the GMSACredentialSpecName field.
+ description: GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.
type: string
gmsaCredentialSpecName:
- description: GMSACredentialSpecName is the name of the
- GMSA credential spec to use.
+ description: GMSACredentialSpecName is the name of the GMSA credential spec to use.
type: string
hostProcess:
- description: HostProcess determines if a container should
- be run as a 'Host Process' container. This field is
- alpha-level and will only be honored by components
- that enable the WindowsHostProcessContainers feature
- flag. Setting this field without the feature flag
- will result in errors when validating the Pod. All
- of a Pod's containers must have the same effective
- HostProcess value (it is not allowed to have a mix
- of HostProcess containers and non-HostProcess containers). In
- addition, if HostProcess is true then HostNetwork
- must also be set to true.
+ description: HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.
type: boolean
runAsUserName:
- description: The UserName in Windows to run the entrypoint
- of the container process. Defaults to the user specified
- in image metadata if unspecified. May also be set
- in PodSecurityContext. If set in both SecurityContext
- and PodSecurityContext, the value specified in SecurityContext
- takes precedence.
+ description: The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
type: string
type: object
type: object
startupProbe:
- description: 'StartupProbe indicates that the Pod has successfully
- initialized. If specified, no other probes are executed until
- this completes successfully. If this probe fails, the Pod
- will be restarted, just as if the livenessProbe failed. This
- can be used to provide different probe parameters at the beginning
- of a Pod''s lifecycle, when it might take a long time to load
- data or warm a cache, than during steady-state operation.
- This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod''s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: Command is the command line to execute
- inside the container, the working directory for the
- command is root ('/') in the container's filesystem.
- The command is simply exec'd, it is not run inside
- a shell, so traditional shell instructions ('|', etc)
- won't work. To use a shell, you need to explicitly
- call out to that shell. Exit status of 0 is treated
- as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe
- to be considered failed after having succeeded. Defaults
- to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
format: int32
type: integer
grpc:
- description: GRPC specifies an action involving a GRPC port.
- This is a beta field and requires enabling GRPCContainerProbe
- feature gate.
+ description: GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.
properties:
port:
- description: Port number of the gRPC service. Number
- must be in the range 1 to 65535.
+ description: Port number of the gRPC service. Number must be in the range 1 to 65535.
format: int32
type: integer
service:
- description: "Service is the name of the service to
- place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
- \n If this is not specified, the default behavior
- is defined by gRPC."
+ description: "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). \n If this is not specified, the default behavior is defined by gRPC."
type: string
required:
- port
@@ -2569,16 +1678,12 @@ spec:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to the
- pod IP. You probably want to set "Host" in httpHeaders
- instead.
+ description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP
- allows repeated headers.
+ description: Custom headers to set in the request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header
- to be used in HTTP probes
+ description: HTTPHeader describes a custom header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -2598,133 +1703,75 @@ spec:
anyOf:
- type: integer
- type: string
- description: Name or number of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: 'Number of seconds after the container has
- started before liveness probes are initiated. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
format: int32
type: integer
successThreshold:
- description: Minimum consecutive successes for the probe
- to be considered successful after having failed. Defaults
- to 1. Must be 1 for liveness and startup. Minimum value
- is 1.
+ description: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
- description: TCPSocket specifies an action involving a TCP
- port.
+ description: TCPSocket specifies an action involving a TCP port.
properties:
host:
- description: 'Optional: Host name to connect to, defaults
- to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: Number or name of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: Optional duration in seconds the pod needs
- to terminate gracefully upon probe failure. The grace
- period is the duration in seconds after the processes
- running in the pod are sent a termination signal and the
- time when the processes are forcibly halted with a kill
- signal. Set this value longer than the expected cleanup
- time for your process. If this value is nil, the pod's
- terminationGracePeriodSeconds will be used. Otherwise,
- this value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates
- stop immediately via the kill signal (no opportunity to
- shut down). This is a beta field and requires enabling
- ProbeTerminationGracePeriod feature gate. Minimum value
- is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: 'Number of seconds after which the probe times
- out. Defaults to 1 second. Minimum value is 1. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
stdin:
- description: Whether this container should allocate a buffer
- for stdin in the container runtime. If this is not set, reads
- from stdin in the container will always result in EOF. Default
- is false.
+ description: Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
type: boolean
stdinOnce:
- description: Whether the container runtime should close the
- stdin channel after it has been opened by a single attach.
- When stdin is true the stdin stream will remain open across
- multiple attach sessions. If stdinOnce is set to true, stdin
- is opened on container start, is empty until the first client
- attaches to stdin, and then remains open and accepts data
- until the client disconnects, at which time stdin is closed
- and remains closed until the container is restarted. If this
- flag is false, a container processes that reads from stdin
- will never receive an EOF. Default is false
+ description: Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
type: boolean
terminationMessagePath:
- description: 'Optional: Path at which the file to which the
- container''s termination message will be written is mounted
- into the container''s filesystem. Message written is intended
- to be brief final status, such as an assertion failure message.
- Will be truncated by the node if greater than 4096 bytes.
- The total message length across all containers will be limited
- to 12kb. Defaults to /dev/termination-log. Cannot be updated.'
+ description: 'Optional: Path at which the file to which the container''s termination message will be written is mounted into the container''s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.'
type: string
terminationMessagePolicy:
- description: Indicate how the termination message should be
- populated. File will use the contents of terminationMessagePath
- to populate the container status message on both success and
- failure. FallbackToLogsOnError will use the last chunk of
- container log output if the termination message file is empty
- and the container exited with an error. The log output is
- limited to 2048 bytes or 80 lines, whichever is smaller. Defaults
- to File. Cannot be updated.
+ description: Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
type: string
tty:
- description: Whether this container should allocate a TTY for
- itself, also requires 'stdin' to be true. Default is false.
+ description: Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
type: boolean
volumeDevices:
- description: volumeDevices is the list of block devices to be
- used by the container.
+ description: volumeDevices is the list of block devices to be used by the container.
items:
- description: volumeDevice describes a mapping of a raw block
- device within a container.
+ description: volumeDevice describes a mapping of a raw block device within a container.
properties:
devicePath:
- description: devicePath is the path inside of the container
- that the device will be mapped to.
+ description: devicePath is the path inside of the container that the device will be mapped to.
type: string
name:
- description: name must match the name of a persistentVolumeClaim
- in the pod
+ description: name must match the name of a persistentVolumeClaim in the pod
type: string
required:
- devicePath
@@ -2732,40 +1779,27 @@ spec:
type: object
type: array
volumeMounts:
- description: Pod volumes to mount into the container's filesystem.
- Cannot be updated.
+ description: Pod volumes to mount into the container's filesystem. Cannot be updated.
items:
- description: VolumeMount describes a mounting of a Volume
- within a container.
+ description: VolumeMount describes a mounting of a Volume within a container.
properties:
mountPath:
- description: Path within the container at which the volume
- should be mounted. Must not contain ':'.
+ description: Path within the container at which the volume should be mounted. Must not contain ':'.
type: string
mountPropagation:
- description: mountPropagation determines how mounts are
- propagated from the host to container and the other
- way around. When not set, MountPropagationNone is used.
- This field is beta in 1.10.
+ description: mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.
type: string
name:
description: This must match the Name of a Volume.
type: string
readOnly:
- description: Mounted read-only if true, read-write otherwise
- (false or unspecified). Defaults to false.
+ description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
type: boolean
subPath:
- description: Path within the volume from which the container's
- volume should be mounted. Defaults to "" (volume's root).
+ description: Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
type: string
subPathExpr:
- description: Expanded path within the volume from which
- the container's volume should be mounted. Behaves similarly
- to SubPath but environment variable references $(VAR_NAME)
- are expanded using the container's environment. Defaults
- to "" (volume's root). SubPathExpr and SubPath are mutually
- exclusive.
+ description: Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.
type: string
required:
- mountPath
@@ -2773,9 +1807,7 @@ spec:
type: object
type: array
workingDir:
- description: Container's working directory. If not specified,
- the container runtime's default will be used, which might
- be configured in the container image. Cannot be updated.
+ description: Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.
type: string
required:
- name
@@ -2785,91 +1817,41 @@ spec:
description: Disable prometheus compaction.
type: boolean
enableAdminAPI:
- description: 'Enable access to prometheus web admin API. Defaults
- to the value of `false`. WARNING: Enabling the admin APIs enables
- mutating endpoints, to delete data, shutdown Prometheus, and more.
- Enabling this should be done with care and the user is advised to
- add additional authentication authorization via a proxy to ensure
- only clients authorized to perform these actions can do so. For
- more information see https://prometheus.io/docs/prometheus/latest/querying/api/#tsdb-admin-apis'
+ description: 'Enable access to prometheus web admin API. Defaults to the value of `false`. WARNING: Enabling the admin APIs enables mutating endpoints, to delete data, shutdown Prometheus, and more. Enabling this should be done with care and the user is advised to add additional authentication authorization via a proxy to ensure only clients authorized to perform these actions can do so. For more information see https://prometheus.io/docs/prometheus/latest/querying/api/#tsdb-admin-apis'
type: boolean
enableFeatures:
- description: Enable access to Prometheus disabled features. By default,
- no features are enabled. Enabling disabled features is entirely
- outside the scope of what the maintainers will support and by doing
- so, you accept that this behaviour may break at any time without
- notice. For more information see https://prometheus.io/docs/prometheus/latest/disabled_features/
+ description: Enable access to Prometheus disabled features. By default, no features are enabled. Enabling disabled features is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice. For more information see https://prometheus.io/docs/prometheus/latest/disabled_features/
items:
type: string
type: array
enableRemoteWriteReceiver:
- description: 'Enable Prometheus to be used as a receiver for the Prometheus
- remote write protocol. Defaults to the value of `false`. WARNING:
- This is not considered an efficient way of ingesting samples. Use
- it with caution for specific low-volume use cases. It is not suitable
- for replacing the ingestion via scraping and turning Prometheus
- into a push-based metrics collection system. For more information
- see https://prometheus.io/docs/prometheus/latest/querying/api/#remote-write-receiver
- Only valid in Prometheus versions 2.33.0 and newer.'
+ description: 'Enable Prometheus to be used as a receiver for the Prometheus remote write protocol. Defaults to the value of `false`. WARNING: This is not considered an efficient way of ingesting samples. Use it with caution for specific low-volume use cases. It is not suitable for replacing the ingestion via scraping and turning Prometheus into a push-based metrics collection system. For more information see https://prometheus.io/docs/prometheus/latest/querying/api/#remote-write-receiver Only valid in Prometheus versions 2.33.0 and newer.'
type: boolean
enforcedBodySizeLimit:
- description: 'EnforcedBodySizeLimit defines the maximum size of uncompressed
- response body that will be accepted by Prometheus. Targets responding
- with a body larger than this many bytes will cause the scrape to
- fail. Example: 100MB. If defined, the limit will apply to all service/pod
- monitors and probes. This is an experimental feature, this behaviour
- could change or be removed in the future. Only valid in Prometheus
- versions 2.28.0 and newer.'
+ description: 'EnforcedBodySizeLimit defines the maximum size of uncompressed response body that will be accepted by Prometheus. Targets responding with a body larger than this many bytes will cause the scrape to fail. Example: 100MB. If defined, the limit will apply to all service/pod monitors and probes. This is an experimental feature, this behaviour could change or be removed in the future. Only valid in Prometheus versions 2.28.0 and newer.'
pattern: (^0|([0-9]*[.])?[0-9]+((K|M|G|T|E|P)i?)?B)$
type: string
enforcedLabelLimit:
- description: Per-scrape limit on number of labels that will be accepted
- for a sample. If more than this number of labels are present post
- metric-relabeling, the entire scrape will be treated as failed.
- 0 means no limit. Only valid in Prometheus versions 2.27.0 and newer.
+ description: Per-scrape limit on number of labels that will be accepted for a sample. If more than this number of labels are present post metric-relabeling, the entire scrape will be treated as failed. 0 means no limit. Only valid in Prometheus versions 2.27.0 and newer.
format: int64
type: integer
enforcedLabelNameLengthLimit:
- description: Per-scrape limit on length of labels name that will be
- accepted for a sample. If a label name is longer than this number
- post metric-relabeling, the entire scrape will be treated as failed.
- 0 means no limit. Only valid in Prometheus versions 2.27.0 and newer.
+ description: Per-scrape limit on length of labels name that will be accepted for a sample. If a label name is longer than this number post metric-relabeling, the entire scrape will be treated as failed. 0 means no limit. Only valid in Prometheus versions 2.27.0 and newer.
format: int64
type: integer
enforcedLabelValueLengthLimit:
- description: Per-scrape limit on length of labels value that will
- be accepted for a sample. If a label value is longer than this number
- post metric-relabeling, the entire scrape will be treated as failed.
- 0 means no limit. Only valid in Prometheus versions 2.27.0 and newer.
+ description: Per-scrape limit on length of labels value that will be accepted for a sample. If a label value is longer than this number post metric-relabeling, the entire scrape will be treated as failed. 0 means no limit. Only valid in Prometheus versions 2.27.0 and newer.
format: int64
type: integer
enforcedNamespaceLabel:
- description: "EnforcedNamespaceLabel If set, a label will be added
- to \n 1. all user-metrics (created by `ServiceMonitor`, `PodMonitor`
- and `Probe` objects) and 2. in all `PrometheusRule` objects (except
- the ones excluded in `prometheusRulesExcludedFromEnforce`) to *
- alerting & recording rules and * the metrics used in their expressions
- (`expr`). \n Label name is this field's value. Label value is the
- namespace of the created object (mentioned above)."
+ description: "EnforcedNamespaceLabel If set, a label will be added to \n 1. all user-metrics (created by `ServiceMonitor`, `PodMonitor` and `Probe` objects) and 2. in all `PrometheusRule` objects (except the ones excluded in `prometheusRulesExcludedFromEnforce`) to * alerting & recording rules and * the metrics used in their expressions (`expr`). \n Label name is this field's value. Label value is the namespace of the created object (mentioned above)."
type: string
enforcedSampleLimit:
- description: EnforcedSampleLimit defines global limit on number of
- scraped samples that will be accepted. This overrides any SampleLimit
- set per ServiceMonitor or/and PodMonitor. It is meant to be used
- by admins to enforce the SampleLimit to keep overall number of samples/series
- under the desired limit. Note that if SampleLimit is lower that
- value will be taken instead.
+ description: EnforcedSampleLimit defines global limit on number of scraped samples that will be accepted. This overrides any SampleLimit set per ServiceMonitor or/and PodMonitor. It is meant to be used by admins to enforce the SampleLimit to keep overall number of samples/series under the desired limit. Note that if SampleLimit is lower that value will be taken instead.
format: int64
type: integer
enforcedTargetLimit:
- description: EnforcedTargetLimit defines a global limit on the number
- of scraped targets. This overrides any TargetLimit set per ServiceMonitor
- or/and PodMonitor. It is meant to be used by admins to enforce
- the TargetLimit to keep the overall number of targets under the
- desired limit. Note that if TargetLimit is lower, that value will
- be taken instead, except if either value is zero, in which case
- the non-zero value will be used. If both values are zero, no limit
- is enforced.
+ description: EnforcedTargetLimit defines a global limit on the number of scraped targets. This overrides any TargetLimit set per ServiceMonitor or/and PodMonitor. It is meant to be used by admins to enforce the TargetLimit to keep the overall number of targets under the desired limit. Note that if TargetLimit is lower, that value will be taken instead, except if either value is zero, in which case the non-zero value will be used. If both values are zero, no limit is enforced.
format: int64
type: integer
evaluationInterval:
@@ -2878,23 +1860,18 @@ spec:
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
excludedFromEnforcement:
- description: List of references to PodMonitor, ServiceMonitor, Probe
- and PrometheusRule objects to be excluded from enforcing a namespace
- label of origin. Applies only if enforcedNamespaceLabel set to true.
+ description: List of references to PodMonitor, ServiceMonitor, Probe and PrometheusRule objects to be excluded from enforcing a namespace label of origin. Applies only if enforcedNamespaceLabel set to true.
items:
- description: ObjectReference references a PodMonitor, ServiceMonitor,
- Probe or PrometheusRule object.
+ description: ObjectReference references a PodMonitor, ServiceMonitor, Probe or PrometheusRule object.
properties:
group:
default: monitoring.coreos.com
- description: Group of the referent. When not specified, it defaults
- to `monitoring.coreos.com`
+ description: Group of the referent. When not specified, it defaults to `monitoring.coreos.com`
enum:
- monitoring.coreos.com
type: string
name:
- description: Name of the referent. When not set, all resources
- are matched.
+ description: Name of the referent. When not set, all resources are matched.
type: string
namespace:
description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
@@ -2914,32 +1891,25 @@ spec:
type: object
type: array
exemplars:
- description: Exemplars related settings that are runtime reloadable.
- It requires to enable the exemplar storage feature to be effective.
+ description: Exemplars related settings that are runtime reloadable. It requires to enable the exemplar storage feature to be effective.
properties:
maxSize:
- description: Maximum number of exemplars stored in memory for
- all series. If not set, Prometheus uses its default value. A
- value of zero or less than zero disables the storage.
+ description: Maximum number of exemplars stored in memory for all series. If not set, Prometheus uses its default value. A value of zero or less than zero disables the storage.
format: int64
type: integer
type: object
externalLabels:
additionalProperties:
type: string
- description: The labels to add to any time series or alerts when communicating
- with external systems (federation, remote storage, Alertmanager).
+ description: The labels to add to any time series or alerts when communicating with external systems (federation, remote storage, Alertmanager).
type: object
externalUrl:
- description: The external URL the Prometheus instances will be available
- under. This is necessary to generate correct URLs. This is necessary
- if Prometheus is not served from root of a DNS name.
+ description: The external URL the Prometheus instances will be available under. This is necessary to generate correct URLs. This is necessary if Prometheus is not served from root of a DNS name.
type: string
hostAliases:
description: Pods' hostAliases configuration
items:
- description: HostAlias holds the mapping between IP and hostnames
- that will be injected as an entry in the pod's hosts file.
+ description: HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.
properties:
hostnames:
description: Hostnames for the above IP address.
@@ -2958,27 +1928,16 @@ spec:
- ip
x-kubernetes-list-type: map
hostNetwork:
- description: Use the host's network namespace if true. Make sure to
- understand the security implications if you want to enable it. When
- hostNetwork is enabled, this will set dnsPolicy to ClusterFirstWithHostNet
- automatically.
+ description: Use the host's network namespace if true. Make sure to understand the security implications if you want to enable it. When hostNetwork is enabled, this will set dnsPolicy to ClusterFirstWithHostNet automatically.
type: boolean
ignoreNamespaceSelectors:
- description: IgnoreNamespaceSelectors if set to true will ignore NamespaceSelector
- settings from all PodMonitor, ServiceMonitor and Probe objects.
- They will only discover endpoints within the namespace of the PodMonitor,
- ServiceMonitor and Probe objects. Defaults to false.
+ description: IgnoreNamespaceSelectors if set to true will ignore NamespaceSelector settings from all PodMonitor, ServiceMonitor and Probe objects. They will only discover endpoints within the namespace of the PodMonitor, ServiceMonitor and Probe objects. Defaults to false.
type: boolean
image:
- description: Image if specified has precedence over baseImage, tag
- and sha combinations. Specifying the version is still necessary
- to ensure the Prometheus Operator knows what version of Prometheus
- is being configured.
+ description: Image if specified has precedence over baseImage, tag and sha combinations. Specifying the version is still necessary to ensure the Prometheus Operator knows what version of Prometheus is being configured.
type: string
imagePullPolicy:
- description: Image pull policy for the 'prometheus', 'init-config-reloader'
- and 'config-reloader' containers. See https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy
- for more details.
+ description: Image pull policy for the 'prometheus', 'init-config-reloader' and 'config-reloader' containers. See https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy for more details.
enum:
- ""
- Always
@@ -2986,89 +1945,44 @@ spec:
- IfNotPresent
type: string
imagePullSecrets:
- description: An optional list of references to secrets in the same
- namespace to use for pulling prometheus and alertmanager images
- from registries see http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod
+ description: An optional list of references to secrets in the same namespace to use for pulling prometheus and alertmanager images from registries see http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod
items:
- description: LocalObjectReference contains enough information to
- let you locate the referenced object inside the same namespace.
+ description: LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
x-kubernetes-map-type: atomic
type: array
initContainers:
- description: 'InitContainers allows adding initContainers to the pod
- definition. Those can be used to e.g. fetch secrets for injection
- into the Prometheus configuration from external sources. Any errors
- during the execution of an initContainer will lead to a restart
- of the Pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
- InitContainers described here modify an operator generated init
- containers if they share the same name and modifications are done
- via a strategic merge patch. The current init container name is:
- `init-config-reloader`. Overriding init containers is entirely outside
- the scope of what the maintainers will support and by doing so,
- you accept that this behaviour may break at any time without notice.'
+ description: 'InitContainers allows adding initContainers to the pod definition. Those can be used to e.g. fetch secrets for injection into the Prometheus configuration from external sources. Any errors during the execution of an initContainer will lead to a restart of the Pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ InitContainers described here modify an operator generated init containers if they share the same name and modifications are done via a strategic merge patch. The current init container name is: `init-config-reloader`. Overriding init containers is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice.'
items:
- description: A single application container that you want to run
- within a pod.
+ description: A single application container that you want to run within a pod.
properties:
args:
- description: 'Arguments to the entrypoint. The container image''s
- CMD is used if this is not provided. Variable references $(VAR_NAME)
- are expanded using the container''s environment. If a variable
- cannot be resolved, the reference in the input string will
- be unchanged. Double $$ are reduced to a single $, which allows
- for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references
- will never be expanded, regardless of whether the variable
- exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
+ description: 'Arguments to the entrypoint. The container image''s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container''s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
command:
- description: 'Entrypoint array. Not executed within a shell.
- The container image''s ENTRYPOINT is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container''s
- environment. If a variable cannot be resolved, the reference
- in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax:
- i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
- Escaped references will never be expanded, regardless of whether
- the variable exists or not. Cannot be updated. More info:
- https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
+ description: 'Entrypoint array. Not executed within a shell. The container image''s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container''s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
env:
- description: List of environment variables to set in the container.
- Cannot be updated.
+ description: List of environment variables to set in the container. Cannot be updated.
items:
- description: EnvVar represents an environment variable present
- in a Container.
+ description: EnvVar represents an environment variable present in a Container.
properties:
name:
- description: Name of the environment variable. Must be
- a C_IDENTIFIER.
+ description: Name of the environment variable. Must be a C_IDENTIFIER.
type: string
value:
- description: 'Variable references $(VAR_NAME) are expanded
- using the previously defined environment variables in
- the container and any service environment variables.
- If a variable cannot be resolved, the reference in the
- input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME)
- syntax: i.e. "$$(VAR_NAME)" will produce the string
- literal "$(VAR_NAME)". Escaped references will never
- be expanded, regardless of whether the variable exists
- or not. Defaults to "".'
+ description: 'Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".'
type: string
valueFrom:
- description: Source for the environment variable's value.
- Cannot be used if value is not empty.
+ description: Source for the environment variable's value. Cannot be used if value is not empty.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -3077,55 +1991,39 @@ spec:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or
- its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
fieldRef:
- description: 'Selects a field of the pod: supports
- metadata.name, metadata.namespace, `metadata.labels[''<KEY>'']`,
- `metadata.annotations[''<KEY>'']`, spec.nodeName,
- spec.serviceAccountName, status.hostIP, status.podIP,
- status.podIPs.'
+ description: 'Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels[''<KEY>'']`, `metadata.annotations[''<KEY>'']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.'
properties:
apiVersion:
- description: Version of the schema the FieldPath
- is written in terms of, defaults to "v1".
+ description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
type: string
fieldPath:
- description: Path of the field to select in the
- specified API version.
+ description: Path of the field to select in the specified API version.
type: string
required:
- fieldPath
type: object
x-kubernetes-map-type: atomic
resourceFieldRef:
- description: 'Selects a resource of the container:
- only resources limits and requests (limits.cpu,
- limits.memory, limits.ephemeral-storage, requests.cpu,
- requests.memory and requests.ephemeral-storage)
- are currently supported.'
+ description: 'Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.'
properties:
containerName:
- description: 'Container name: required for volumes,
- optional for env vars'
+ description: 'Container name: required for volumes, optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format of the
- exposed resources, defaults to "1"
+ description: Specifies the output format of the exposed resources, defaults to "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
@@ -3136,22 +2034,16 @@ spec:
type: object
x-kubernetes-map-type: atomic
secretKeyRef:
- description: Selects a key of a secret in the pod's
- namespace
+ description: Selects a key of a secret in the pod's namespace
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its
- key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -3163,42 +2055,29 @@ spec:
type: object
type: array
envFrom:
- description: List of sources to populate environment variables
- in the container. The keys defined within a source must be
- a C_IDENTIFIER. All invalid keys will be reported as an event
- when the container is starting. When a key exists in multiple
- sources, the value associated with the last source will take
- precedence. Values defined by an Env with a duplicate key
- will take precedence. Cannot be updated.
+ description: List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
items:
- description: EnvFromSource represents the source of a set
- of ConfigMaps
+ description: EnvFromSource represents the source of a set of ConfigMaps
properties:
configMapRef:
description: The ConfigMap to select from
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap must be
- defined
+ description: Specify whether the ConfigMap must be defined
type: boolean
type: object
x-kubernetes-map-type: atomic
prefix:
- description: An optional identifier to prepend to each
- key in the ConfigMap. Must be a C_IDENTIFIER.
+ description: An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
type: string
secretRef:
description: The Secret to select from
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
description: Specify whether the Secret must be defined
@@ -3208,40 +2087,22 @@ spec:
type: object
type: array
image:
- description: 'Container image name. More info: https://kubernetes.io/docs/concepts/containers/images
- This field is optional to allow higher level config management
- to default or override container images in workload controllers
- like Deployments and StatefulSets.'
+ description: 'Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.'
type: string
imagePullPolicy:
- description: 'Image pull policy. One of Always, Never, IfNotPresent.
- Defaults to Always if :latest tag is specified, or IfNotPresent
- otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
+ description: 'Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
- description: Actions that the management system should take
- in response to container lifecycle events. Cannot be updated.
+ description: Actions that the management system should take in response to container lifecycle events. Cannot be updated.
properties:
postStart:
- description: 'PostStart is called immediately after a container
- is created. If the handler fails, the container is terminated
- and restarted according to its restart policy. Other management
- of the container blocks until the hook completes. More
- info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
+ description: 'PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: Command is the command line to execute
- inside the container, the working directory for
- the command is root ('/') in the container's
- filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions
- ('|', etc) won't work. To use a shell, you need
- to explicitly call out to that shell. Exit status
- of 0 is treated as live/healthy and non-zero is
- unhealthy.
+ description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
@@ -3250,16 +2111,12 @@ spec:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to
- the pod IP. You probably want to set "Host" in
- httpHeaders instead.
+ description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request.
- HTTP allows repeated headers.
+ description: Custom headers to set in the request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header
- to be used in HTTP probes
+ description: HTTPHeader describes a custom header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -3279,65 +2136,38 @@ spec:
anyOf:
- type: integer
- type: string
- description: Name or number of the port to access
- on the container. Number must be in the range
- 1 to 65535. Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the
- host. Defaults to HTTP.
+ description: Scheme to use for connecting to the host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: Deprecated. TCPSocket is NOT supported
- as a LifecycleHandler and kept for the backward compatibility.
- There are no validation of this field and lifecycle
- hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.
properties:
host:
- description: 'Optional: Host name to connect to,
- defaults to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: Number or name of the port to access
- on the container. Number must be in the range
- 1 to 65535. Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
preStop:
- description: 'PreStop is called immediately before a container
- is terminated due to an API request or management event
- such as liveness/startup probe failure, preemption, resource
- contention, etc. The handler is not called if the container
- crashes or exits. The Pod''s termination grace period
- countdown begins before the PreStop hook is executed.
- Regardless of the outcome of the handler, the container
- will eventually terminate within the Pod''s termination
- grace period (unless delayed by finalizers). Other management
- of the container blocks until the hook completes or until
- the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
+ description: 'PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod''s termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod''s termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: Command is the command line to execute
- inside the container, the working directory for
- the command is root ('/') in the container's
- filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions
- ('|', etc) won't work. To use a shell, you need
- to explicitly call out to that shell. Exit status
- of 0 is treated as live/healthy and non-zero is
- unhealthy.
+ description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
@@ -3346,16 +2176,12 @@ spec:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to
- the pod IP. You probably want to set "Host" in
- httpHeaders instead.
+ description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request.
- HTTP allows repeated headers.
+ description: Custom headers to set in the request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header
- to be used in HTTP probes
+ description: HTTPHeader describes a custom header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -3375,34 +2201,25 @@ spec:
anyOf:
- type: integer
- type: string
- description: Name or number of the port to access
- on the container. Number must be in the range
- 1 to 65535. Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the
- host. Defaults to HTTP.
+ description: Scheme to use for connecting to the host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: Deprecated. TCPSocket is NOT supported
- as a LifecycleHandler and kept for the backward compatibility.
- There are no validation of this field and lifecycle
- hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.
properties:
host:
- description: 'Optional: Host name to connect to,
- defaults to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: Number or name of the port to access
- on the container. Number must be in the range
- 1 to 65535. Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
@@ -3410,47 +2227,30 @@ spec:
type: object
type: object
livenessProbe:
- description: 'Periodic probe of container liveness. Container
- will be restarted if the probe fails. Cannot be updated. More
- info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: Command is the command line to execute
- inside the container, the working directory for the
- command is root ('/') in the container's filesystem.
- The command is simply exec'd, it is not run inside
- a shell, so traditional shell instructions ('|', etc)
- won't work. To use a shell, you need to explicitly
- call out to that shell. Exit status of 0 is treated
- as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe
- to be considered failed after having succeeded. Defaults
- to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
format: int32
type: integer
grpc:
- description: GRPC specifies an action involving a GRPC port.
- This is a beta field and requires enabling GRPCContainerProbe
- feature gate.
+ description: GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.
properties:
port:
- description: Port number of the gRPC service. Number
- must be in the range 1 to 65535.
+ description: Port number of the gRPC service. Number must be in the range 1 to 65535.
format: int32
type: integer
service:
- description: "Service is the name of the service to
- place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
- \n If this is not specified, the default behavior
- is defined by gRPC."
+ description: "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). \n If this is not specified, the default behavior is defined by gRPC."
type: string
required:
- port
@@ -3459,16 +2259,12 @@ spec:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to the
- pod IP. You probably want to set "Host" in httpHeaders
- instead.
+ description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP
- allows repeated headers.
+ description: Custom headers to set in the request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header
- to be used in HTTP probes
+ description: HTTPHeader describes a custom header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -3488,120 +2284,75 @@ spec:
anyOf:
- type: integer
- type: string
- description: Name or number of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: 'Number of seconds after the container has
- started before liveness probes are initiated. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
format: int32
type: integer
successThreshold:
- description: Minimum consecutive successes for the probe
- to be considered successful after having failed. Defaults
- to 1. Must be 1 for liveness and startup. Minimum value
- is 1.
+ description: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
- description: TCPSocket specifies an action involving a TCP
- port.
+ description: TCPSocket specifies an action involving a TCP port.
properties:
host:
- description: 'Optional: Host name to connect to, defaults
- to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: Number or name of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: Optional duration in seconds the pod needs
- to terminate gracefully upon probe failure. The grace
- period is the duration in seconds after the processes
- running in the pod are sent a termination signal and the
- time when the processes are forcibly halted with a kill
- signal. Set this value longer than the expected cleanup
- time for your process. If this value is nil, the pod's
- terminationGracePeriodSeconds will be used. Otherwise,
- this value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates
- stop immediately via the kill signal (no opportunity to
- shut down). This is a beta field and requires enabling
- ProbeTerminationGracePeriod feature gate. Minimum value
- is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: 'Number of seconds after which the probe times
- out. Defaults to 1 second. Minimum value is 1. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
name:
- description: Name of the container specified as a DNS_LABEL.
- Each container in a pod must have a unique name (DNS_LABEL).
- Cannot be updated.
+ description: Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
type: string
ports:
- description: List of ports to expose from the container. Not
- specifying a port here DOES NOT prevent that port from being
- exposed. Any port which is listening on the default "0.0.0.0"
- address inside a container will be accessible from the network.
- Modifying this array with strategic merge patch may corrupt
- the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255.
- Cannot be updated.
+ description: List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.
items:
- description: ContainerPort represents a network port in a
- single container.
+ description: ContainerPort represents a network port in a single container.
properties:
containerPort:
- description: Number of port to expose on the pod's IP
- address. This must be a valid port number, 0 < x < 65536.
+ description: Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
format: int32
type: integer
hostIP:
description: What host IP to bind the external port to.
type: string
hostPort:
- description: Number of port to expose on the host. If
- specified, this must be a valid port number, 0 < x <
- 65536. If HostNetwork is specified, this must match
- ContainerPort. Most containers do not need this.
+ description: Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.
format: int32
type: integer
name:
- description: If specified, this must be an IANA_SVC_NAME
- and unique within the pod. Each named port in a pod
- must have a unique name. Name for the port that can
- be referred to by services.
+ description: If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
type: string
protocol:
default: TCP
- description: Protocol for port. Must be UDP, TCP, or SCTP.
- Defaults to "TCP".
+ description: Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".
type: string
required:
- containerPort
@@ -3612,47 +2363,30 @@ spec:
- protocol
x-kubernetes-list-type: map
readinessProbe:
- description: 'Periodic probe of container service readiness.
- Container will be removed from service endpoints if the probe
- fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: Command is the command line to execute
- inside the container, the working directory for the
- command is root ('/') in the container's filesystem.
- The command is simply exec'd, it is not run inside
- a shell, so traditional shell instructions ('|', etc)
- won't work. To use a shell, you need to explicitly
- call out to that shell. Exit status of 0 is treated
- as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe
- to be considered failed after having succeeded. Defaults
- to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
format: int32
type: integer
grpc:
- description: GRPC specifies an action involving a GRPC port.
- This is a beta field and requires enabling GRPCContainerProbe
- feature gate.
+ description: GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.
properties:
port:
- description: Port number of the gRPC service. Number
- must be in the range 1 to 65535.
+ description: Port number of the gRPC service. Number must be in the range 1 to 65535.
format: int32
type: integer
service:
- description: "Service is the name of the service to
- place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
- \n If this is not specified, the default behavior
- is defined by gRPC."
+ description: "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). \n If this is not specified, the default behavior is defined by gRPC."
type: string
required:
- port
@@ -3661,16 +2395,12 @@ spec:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to the
- pod IP. You probably want to set "Host" in httpHeaders
- instead.
+ description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP
- allows repeated headers.
+ description: Custom headers to set in the request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header
- to be used in HTTP probes
+ description: HTTPHeader describes a custom header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -3690,95 +2420,60 @@ spec:
anyOf:
- type: integer
- type: string
- description: Name or number of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: 'Number of seconds after the container has
- started before liveness probes are initiated. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
format: int32
type: integer
successThreshold:
- description: Minimum consecutive successes for the probe
- to be considered successful after having failed. Defaults
- to 1. Must be 1 for liveness and startup. Minimum value
- is 1.
+ description: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
- description: TCPSocket specifies an action involving a TCP
- port.
+ description: TCPSocket specifies an action involving a TCP port.
properties:
host:
- description: 'Optional: Host name to connect to, defaults
- to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: Number or name of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: Optional duration in seconds the pod needs
- to terminate gracefully upon probe failure. The grace
- period is the duration in seconds after the processes
- running in the pod are sent a termination signal and the
- time when the processes are forcibly halted with a kill
- signal. Set this value longer than the expected cleanup
- time for your process. If this value is nil, the pod's
- terminationGracePeriodSeconds will be used. Otherwise,
- this value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates
- stop immediately via the kill signal (no opportunity to
- shut down). This is a beta field and requires enabling
- ProbeTerminationGracePeriod feature gate. Minimum value
- is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: 'Number of seconds after which the probe times
- out. Defaults to 1 second. Minimum value is 1. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
resources:
- description: 'Compute Resources required by this container.
- Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
properties:
claims:
- description: "Claims lists the names of resources, defined
- in spec.resourceClaims, that are used by this container.
- \n This is an alpha field and requires enabling the DynamicResourceAllocation
- feature gate. \n This field is immutable."
+ description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable."
items:
description: ResourceClaim references one entry in PodSpec.ResourceClaims.
properties:
name:
- description: Name must match the name of one entry
- in pod.spec.resourceClaims of the Pod where this
- field is used. It makes that resource available
- inside a container.
+ description: Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
type: string
required:
- name
@@ -3794,8 +2489,7 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute
- resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -3804,236 +2498,121 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Requests describes the minimum amount of compute
- resources required. If Requests is omitted for a container,
- it defaults to Limits if that is explicitly specified,
- otherwise to an implementation-defined value. More info:
- https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
securityContext:
- description: 'SecurityContext defines the security options the
- container should be run with. If set, the fields of SecurityContext
- override the equivalent fields of PodSecurityContext. More
- info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
+ description: 'SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
properties:
allowPrivilegeEscalation:
- description: 'AllowPrivilegeEscalation controls whether
- a process can gain more privileges than its parent process.
- This bool directly controls if the no_new_privs flag will
- be set on the container process. AllowPrivilegeEscalation
- is true always when the container is: 1) run as Privileged
- 2) has CAP_SYS_ADMIN Note that this field cannot be set
- when spec.os.name is windows.'
+ description: 'AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.'
type: boolean
capabilities:
- description: The capabilities to add/drop when running containers.
- Defaults to the default set of capabilities granted by
- the container runtime. Note that this field cannot be
- set when spec.os.name is windows.
+ description: The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.
properties:
add:
description: Added capabilities
items:
- description: Capability represent POSIX capabilities
- type
+ description: Capability represent POSIX capabilities type
type: string
type: array
drop:
description: Removed capabilities
items:
- description: Capability represent POSIX capabilities
- type
+ description: Capability represent POSIX capabilities type
type: string
type: array
type: object
privileged:
- description: Run container in privileged mode. Processes
- in privileged containers are essentially equivalent to
- root on the host. Defaults to false. Note that this field
- cannot be set when spec.os.name is windows.
+ description: Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.
type: boolean
procMount:
- description: procMount denotes the type of proc mount to
- use for the containers. The default is DefaultProcMount
- which uses the container runtime defaults for readonly
- paths and masked paths. This requires the ProcMountType
- feature flag to be enabled. Note that this field cannot
- be set when spec.os.name is windows.
+ description: procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.
type: string
readOnlyRootFilesystem:
- description: Whether this container has a read-only root
- filesystem. Default is false. Note that this field cannot
- be set when spec.os.name is windows.
+ description: Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.
type: boolean
runAsGroup:
- description: The GID to run the entrypoint of the container
- process. Uses runtime default if unset. May also be set
- in PodSecurityContext. If set in both SecurityContext
- and PodSecurityContext, the value specified in SecurityContext
- takes precedence. Note that this field cannot be set when
- spec.os.name is windows.
+ description: The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
format: int64
type: integer
runAsNonRoot:
- description: Indicates that the container must run as a
- non-root user. If true, the Kubelet will validate the
- image at runtime to ensure that it does not run as UID
- 0 (root) and fail to start the container if it does. If
- unset or false, no such validation will be performed.
- May also be set in PodSecurityContext. If set in both
- SecurityContext and PodSecurityContext, the value specified
- in SecurityContext takes precedence.
+ description: Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
type: boolean
runAsUser:
- description: The UID to run the entrypoint of the container
- process. Defaults to user specified in image metadata
- if unspecified. May also be set in PodSecurityContext. If
- set in both SecurityContext and PodSecurityContext, the
- value specified in SecurityContext takes precedence. Note
- that this field cannot be set when spec.os.name is windows.
+ description: The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
format: int64
type: integer
seLinuxOptions:
- description: The SELinux context to be applied to the container.
- If unspecified, the container runtime will allocate a
- random SELinux context for each container. May also be
- set in PodSecurityContext. If set in both SecurityContext
- and PodSecurityContext, the value specified in SecurityContext
- takes precedence. Note that this field cannot be set when
- spec.os.name is windows.
+ description: The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
properties:
level:
- description: Level is SELinux level label that applies
- to the container.
+ description: Level is SELinux level label that applies to the container.
type: string
role:
- description: Role is a SELinux role label that applies
- to the container.
+ description: Role is a SELinux role label that applies to the container.
type: string
type:
- description: Type is a SELinux type label that applies
- to the container.
+ description: Type is a SELinux type label that applies to the container.
type: string
user:
- description: User is a SELinux user label that applies
- to the container.
+ description: User is a SELinux user label that applies to the container.
type: string
type: object
seccompProfile:
- description: The seccomp options to use by this container.
- If seccomp options are provided at both the pod & container
- level, the container options override the pod options.
- Note that this field cannot be set when spec.os.name is
- windows.
+ description: The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
properties:
localhostProfile:
- description: localhostProfile indicates a profile defined
- in a file on the node should be used. The profile
- must be preconfigured on the node to work. Must be
- a descending path, relative to the kubelet's configured
- seccomp profile location. Must only be set if type
- is "Localhost".
+ description: localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost".
type: string
type:
- description: "type indicates which kind of seccomp profile
- will be applied. Valid options are: \n Localhost -
- a profile defined in a file on the node should be
- used. RuntimeDefault - the container runtime default
- profile should be used. Unconfined - no profile should
- be applied."
+ description: "type indicates which kind of seccomp profile will be applied. Valid options are: \n Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied."
type: string
required:
- type
type: object
windowsOptions:
- description: The Windows specific settings applied to all
- containers. If unspecified, the options from the PodSecurityContext
- will be used. If set in both SecurityContext and PodSecurityContext,
- the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is
- linux.
+ description: The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
properties:
gmsaCredentialSpec:
- description: GMSACredentialSpec is where the GMSA admission
- webhook (https://github.com/kubernetes-sigs/windows-gmsa)
- inlines the contents of the GMSA credential spec named
- by the GMSACredentialSpecName field.
+ description: GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.
type: string
gmsaCredentialSpecName:
- description: GMSACredentialSpecName is the name of the
- GMSA credential spec to use.
+ description: GMSACredentialSpecName is the name of the GMSA credential spec to use.
type: string
hostProcess:
- description: HostProcess determines if a container should
- be run as a 'Host Process' container. This field is
- alpha-level and will only be honored by components
- that enable the WindowsHostProcessContainers feature
- flag. Setting this field without the feature flag
- will result in errors when validating the Pod. All
- of a Pod's containers must have the same effective
- HostProcess value (it is not allowed to have a mix
- of HostProcess containers and non-HostProcess containers). In
- addition, if HostProcess is true then HostNetwork
- must also be set to true.
+ description: HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.
type: boolean
runAsUserName:
- description: The UserName in Windows to run the entrypoint
- of the container process. Defaults to the user specified
- in image metadata if unspecified. May also be set
- in PodSecurityContext. If set in both SecurityContext
- and PodSecurityContext, the value specified in SecurityContext
- takes precedence.
+ description: The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
type: string
type: object
type: object
startupProbe:
- description: 'StartupProbe indicates that the Pod has successfully
- initialized. If specified, no other probes are executed until
- this completes successfully. If this probe fails, the Pod
- will be restarted, just as if the livenessProbe failed. This
- can be used to provide different probe parameters at the beginning
- of a Pod''s lifecycle, when it might take a long time to load
- data or warm a cache, than during steady-state operation.
- This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod''s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: Command is the command line to execute
- inside the container, the working directory for the
- command is root ('/') in the container's filesystem.
- The command is simply exec'd, it is not run inside
- a shell, so traditional shell instructions ('|', etc)
- won't work. To use a shell, you need to explicitly
- call out to that shell. Exit status of 0 is treated
- as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe
- to be considered failed after having succeeded. Defaults
- to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
format: int32
type: integer
grpc:
- description: GRPC specifies an action involving a GRPC port.
- This is a beta field and requires enabling GRPCContainerProbe
- feature gate.
+ description: GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.
properties:
port:
- description: Port number of the gRPC service. Number
- must be in the range 1 to 65535.
+ description: Port number of the gRPC service. Number must be in the range 1 to 65535.
format: int32
type: integer
service:
- description: "Service is the name of the service to
- place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
- \n If this is not specified, the default behavior
- is defined by gRPC."
+ description: "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). \n If this is not specified, the default behavior is defined by gRPC."
type: string
required:
- port
@@ -4042,16 +2621,12 @@ spec:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to the
- pod IP. You probably want to set "Host" in httpHeaders
- instead.
+ description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP
- allows repeated headers.
+ description: Custom headers to set in the request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header
- to be used in HTTP probes
+ description: HTTPHeader describes a custom header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -4071,133 +2646,75 @@ spec:
anyOf:
- type: integer
- type: string
- description: Name or number of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: 'Number of seconds after the container has
- started before liveness probes are initiated. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
format: int32
type: integer
successThreshold:
- description: Minimum consecutive successes for the probe
- to be considered successful after having failed. Defaults
- to 1. Must be 1 for liveness and startup. Minimum value
- is 1.
+ description: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
- description: TCPSocket specifies an action involving a TCP
- port.
+ description: TCPSocket specifies an action involving a TCP port.
properties:
host:
- description: 'Optional: Host name to connect to, defaults
- to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: Number or name of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: Optional duration in seconds the pod needs
- to terminate gracefully upon probe failure. The grace
- period is the duration in seconds after the processes
- running in the pod are sent a termination signal and the
- time when the processes are forcibly halted with a kill
- signal. Set this value longer than the expected cleanup
- time for your process. If this value is nil, the pod's
- terminationGracePeriodSeconds will be used. Otherwise,
- this value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates
- stop immediately via the kill signal (no opportunity to
- shut down). This is a beta field and requires enabling
- ProbeTerminationGracePeriod feature gate. Minimum value
- is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: 'Number of seconds after which the probe times
- out. Defaults to 1 second. Minimum value is 1. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
stdin:
- description: Whether this container should allocate a buffer
- for stdin in the container runtime. If this is not set, reads
- from stdin in the container will always result in EOF. Default
- is false.
+ description: Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
type: boolean
stdinOnce:
- description: Whether the container runtime should close the
- stdin channel after it has been opened by a single attach.
- When stdin is true the stdin stream will remain open across
- multiple attach sessions. If stdinOnce is set to true, stdin
- is opened on container start, is empty until the first client
- attaches to stdin, and then remains open and accepts data
- until the client disconnects, at which time stdin is closed
- and remains closed until the container is restarted. If this
- flag is false, a container processes that reads from stdin
- will never receive an EOF. Default is false
+ description: Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
type: boolean
terminationMessagePath:
- description: 'Optional: Path at which the file to which the
- container''s termination message will be written is mounted
- into the container''s filesystem. Message written is intended
- to be brief final status, such as an assertion failure message.
- Will be truncated by the node if greater than 4096 bytes.
- The total message length across all containers will be limited
- to 12kb. Defaults to /dev/termination-log. Cannot be updated.'
+ description: 'Optional: Path at which the file to which the container''s termination message will be written is mounted into the container''s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.'
type: string
terminationMessagePolicy:
- description: Indicate how the termination message should be
- populated. File will use the contents of terminationMessagePath
- to populate the container status message on both success and
- failure. FallbackToLogsOnError will use the last chunk of
- container log output if the termination message file is empty
- and the container exited with an error. The log output is
- limited to 2048 bytes or 80 lines, whichever is smaller. Defaults
- to File. Cannot be updated.
+ description: Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
type: string
tty:
- description: Whether this container should allocate a TTY for
- itself, also requires 'stdin' to be true. Default is false.
+ description: Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
type: boolean
volumeDevices:
- description: volumeDevices is the list of block devices to be
- used by the container.
+ description: volumeDevices is the list of block devices to be used by the container.
items:
- description: volumeDevice describes a mapping of a raw block
- device within a container.
+ description: volumeDevice describes a mapping of a raw block device within a container.
properties:
devicePath:
- description: devicePath is the path inside of the container
- that the device will be mapped to.
+ description: devicePath is the path inside of the container that the device will be mapped to.
type: string
name:
- description: name must match the name of a persistentVolumeClaim
- in the pod
+ description: name must match the name of a persistentVolumeClaim in the pod
type: string
required:
- devicePath
@@ -4205,40 +2722,27 @@ spec:
type: object
type: array
volumeMounts:
- description: Pod volumes to mount into the container's filesystem.
- Cannot be updated.
+ description: Pod volumes to mount into the container's filesystem. Cannot be updated.
items:
- description: VolumeMount describes a mounting of a Volume
- within a container.
+ description: VolumeMount describes a mounting of a Volume within a container.
properties:
mountPath:
- description: Path within the container at which the volume
- should be mounted. Must not contain ':'.
+ description: Path within the container at which the volume should be mounted. Must not contain ':'.
type: string
mountPropagation:
- description: mountPropagation determines how mounts are
- propagated from the host to container and the other
- way around. When not set, MountPropagationNone is used.
- This field is beta in 1.10.
+ description: mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.
type: string
name:
description: This must match the Name of a Volume.
type: string
readOnly:
- description: Mounted read-only if true, read-write otherwise
- (false or unspecified). Defaults to false.
+ description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
type: boolean
subPath:
- description: Path within the volume from which the container's
- volume should be mounted. Defaults to "" (volume's root).
+ description: Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
type: string
subPathExpr:
- description: Expanded path within the volume from which
- the container's volume should be mounted. Behaves similarly
- to SubPath but environment variable references $(VAR_NAME)
- are expanded using the container's environment. Defaults
- to "" (volume's root). SubPathExpr and SubPath are mutually
- exclusive.
+ description: Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.
type: string
required:
- mountPath
@@ -4246,17 +2750,14 @@ spec:
type: object
type: array
workingDir:
- description: Container's working directory. If not specified,
- the container runtime's default will be used, which might
- be configured in the container image. Cannot be updated.
+ description: Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.
type: string
required:
- name
type: object
type: array
listenLocal:
- description: ListenLocal makes the Prometheus server listen on loopback,
- so that it does not bind against the Pod IP.
+ description: ListenLocal makes the Prometheus server listen on loopback, so that it does not bind against the Pod IP.
type: boolean
logFormat:
description: Log format for Prometheus to be configured with.
@@ -4275,12 +2776,7 @@ spec:
- error
type: string
minReadySeconds:
- description: Minimum number of seconds for which a newly created pod
- should be ready without any of its container crashing for it to
- be considered available. Defaults to 0 (pod will be considered available
- as soon as it is ready) This is an alpha field from kubernetes 1.22
- until 1.24 which requires enabling the StatefulSetMinReadySeconds
- feature gate.
+ description: Minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) This is an alpha field from kubernetes 1.22 until 1.24 which requires enabling the StatefulSetMinReadySeconds feature gate.
format: int32
type: integer
nodeSelector:
@@ -4289,75 +2785,47 @@ spec:
description: Define which Nodes the Pods are scheduled on.
type: object
overrideHonorLabels:
- description: When true, Prometheus resolves label conflicts by renaming
- the labels in the scraped data to "exported_<label value>" for all
- targets created from service and pod monitors. Otherwise the HonorLabels
- field of the service or pod monitor applies.
+ description: When true, Prometheus resolves label conflicts by renaming the labels in the scraped data to "exported_<label value>" for all targets created from service and pod monitors. Otherwise the HonorLabels field of the service or pod monitor applies.
type: boolean
overrideHonorTimestamps:
- description: When true, Prometheus ignores the timestamps for all
- the targets created from service and pod monitors. Otherwise the
- HonorTimestamps field of the service or pod monitor applies.
+ description: When true, Prometheus ignores the timestamps for all the targets created from service and pod monitors. Otherwise the HonorTimestamps field of the service or pod monitor applies.
type: boolean
paused:
- description: When a Prometheus deployment is paused, no actions except
- for deletion will be performed on the underlying objects.
+ description: When a Prometheus deployment is paused, no actions except for deletion will be performed on the underlying objects.
type: boolean
podMetadata:
- description: PodMetadata configures Labels and Annotations which are
- propagated to the prometheus pods.
+ description: PodMetadata configures Labels and Annotations which are propagated to the prometheus pods.
properties:
annotations:
additionalProperties:
type: string
- description: 'Annotations is an unstructured key value map stored
- with a resource that may be set by external tools to store and
- retrieve arbitrary metadata. They are not queryable and should
- be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations'
+ description: 'Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations'
type: object
labels:
additionalProperties:
type: string
- description: 'Map of string keys and values that can be used to
- organize and categorize (scope and select) objects. May match
- selectors of replication controllers and services. More info:
- http://kubernetes.io/docs/user-guide/labels'
+ description: 'Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels'
type: object
name:
- description: 'Name must be unique within a namespace. Is required
- when creating resources, although some resources may allow a
- client to request the generation of an appropriate name automatically.
- Name is primarily intended for creation idempotence and configuration
- definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names'
+ description: 'Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names'
type: string
type: object
podMonitorNamespaceSelector:
- description: Namespace's labels to match for PodMonitor discovery.
- If nil, only check own namespace.
+ description: Namespace's labels to match for PodMonitor discovery. If nil, only check own namespace.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements.
- The requirements are ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a selector that
- contains values, a key, and an operator that relates the key
- and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the selector applies
- to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship to
- a set of values. Valid operators are In, NotIn, Exists
- and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string values. If the
- operator is In or NotIn, the values array must be non-empty.
- If the operator is Exists or DoesNotExist, the values
- array must be empty. This array is replaced during a strategic
- merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -4369,48 +2837,26 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value} pairs. A single
- {key,value} in the matchLabels map is equivalent to an element
- of matchExpressions, whose key field is "key", the operator
- is "In", and the values array contains only "value". The requirements
- are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
podMonitorSelector:
- description: "*Experimental* PodMonitors to be selected for target
- discovery. \n If `spec.serviceMonitorSelector`, `spec.podMonitorSelector`
- and `spec.probeSelector` are null, the Prometheus configuration
- is unmanaged. The Prometheus operator will ensure that the Prometheus
- configuration's Secret exists, but it is the responsibility of the
- user to provide the raw gzipped Prometheus configuration under the
- `prometheus.yaml.gz` key. This behavior is deprecated and will be
- removed in the next major version of the custom resource definition.
- It is recommended to use `spec.additionalScrapeConfigs` instead."
+ description: "*Experimental* PodMonitors to be selected for target discovery. \n If `spec.serviceMonitorSelector`, `spec.podMonitorSelector` and `spec.probeSelector` are null, the Prometheus configuration is unmanaged. The Prometheus operator will ensure that the Prometheus configuration's Secret exists, but it is the responsibility of the user to provide the raw gzipped Prometheus configuration under the `prometheus.yaml.gz` key. This behavior is deprecated and will be removed in the next major version of the custom resource definition. It is recommended to use `spec.additionalScrapeConfigs` instead."
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements.
- The requirements are ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a selector that
- contains values, a key, and an operator that relates the key
- and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the selector applies
- to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship to
- a set of values. Valid operators are In, NotIn, Exists
- and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string values. If the
- operator is In or NotIn, the values array must be non-empty.
- If the operator is Exists or DoesNotExist, the values
- array must be empty. This array is replaced during a strategic
- merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -4422,55 +2868,38 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value} pairs. A single
- {key,value} in the matchLabels map is equivalent to an element
- of matchExpressions, whose key field is "key", the operator
- is "In", and the values array contains only "value". The requirements
- are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
podTargetLabels:
- description: PodTargetLabels are added to all Pod/ServiceMonitors'
- podTargetLabels
+ description: PodTargetLabels are added to all Pod/ServiceMonitors' podTargetLabels
items:
type: string
type: array
portName:
default: web
- description: Port name used for the pods and governing service. Defaults
- to `web`.
+ description: Port name used for the pods and governing service. Defaults to `web`.
type: string
priorityClassName:
description: Priority class assigned to the Pods
type: string
probeNamespaceSelector:
- description: '*Experimental* Namespaces to be selected for Probe discovery.
- If nil, only check own namespace.'
+ description: '*Experimental* Namespaces to be selected for Probe discovery. If nil, only check own namespace.'
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements.
- The requirements are ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a selector that
- contains values, a key, and an operator that relates the key
- and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the selector applies
- to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship to
- a set of values. Valid operators are In, NotIn, Exists
- and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string values. If the
- operator is In or NotIn, the values array must be non-empty.
- If the operator is Exists or DoesNotExist, the values
- array must be empty. This array is replaced during a strategic
- merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -4482,48 +2911,26 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value} pairs. A single
- {key,value} in the matchLabels map is equivalent to an element
- of matchExpressions, whose key field is "key", the operator
- is "In", and the values array contains only "value". The requirements
- are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
probeSelector:
- description: "*Experimental* Probes to be selected for target discovery.
- \n If `spec.serviceMonitorSelector`, `spec.podMonitorSelector` and
- `spec.probeSelector` are null, the Prometheus configuration is unmanaged.
- The Prometheus operator will ensure that the Prometheus configuration's
- Secret exists, but it is the responsibility of the user to provide
- the raw gzipped Prometheus configuration under the `prometheus.yaml.gz`
- key. This behavior is deprecated and will be removed in the next
- major version of the custom resource definition. It is recommended
- to use `spec.additionalScrapeConfigs` instead."
+ description: "*Experimental* Probes to be selected for target discovery. \n If `spec.serviceMonitorSelector`, `spec.podMonitorSelector` and `spec.probeSelector` are null, the Prometheus configuration is unmanaged. The Prometheus operator will ensure that the Prometheus configuration's Secret exists, but it is the responsibility of the user to provide the raw gzipped Prometheus configuration under the `prometheus.yaml.gz` key. This behavior is deprecated and will be removed in the next major version of the custom resource definition. It is recommended to use `spec.additionalScrapeConfigs` instead."
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements.
- The requirements are ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a selector that
- contains values, a key, and an operator that relates the key
- and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the selector applies
- to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship to
- a set of values. Valid operators are In, NotIn, Exists
- and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string values. If the
- operator is In or NotIn, the values array must be non-empty.
- If the operator is Exists or DoesNotExist, the values
- array must be empty. This array is replaced during a strategic
- merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -4535,29 +2942,17 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value} pairs. A single
- {key,value} in the matchLabels map is equivalent to an element
- of matchExpressions, whose key field is "key", the operator
- is "In", and the values array contains only "value". The requirements
- are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
prometheusExternalLabelName:
- description: Name of Prometheus external label used to denote Prometheus
- instance name. Defaults to the value of `prometheus`. External label
- will _not_ be added when value is set to empty string (`""`).
+ description: Name of Prometheus external label used to denote Prometheus instance name. Defaults to the value of `prometheus`. External label will _not_ be added when value is set to empty string (`""`).
type: string
prometheusRulesExcludedFromEnforce:
- description: 'PrometheusRulesExcludedFromEnforce - list of prometheus
- rules to be excluded from enforcing of adding namespace labels.
- Works only if enforcedNamespaceLabel set to true. Make sure both
- ruleNamespace and ruleName are set for each pair. Deprecated: use
- excludedFromEnforcement instead.'
+ description: 'PrometheusRulesExcludedFromEnforce - list of prometheus rules to be excluded from enforcing of adding namespace labels. Works only if enforcedNamespaceLabel set to true. Make sure both ruleNamespace and ruleName are set for each pair. Deprecated: use excludedFromEnforcement instead.'
items:
- description: PrometheusRuleExcludeConfig enables users to configure
- excluded PrometheusRule names and their namespaces to be ignored
- while enforcing namespace label for alerts and metrics.
+ description: PrometheusRuleExcludeConfig enables users to configure excluded PrometheusRule names and their namespaces to be ignored while enforcing namespace label for alerts and metrics.
properties:
ruleName:
description: RuleNamespace - name of excluded rule
@@ -4571,12 +2966,10 @@ spec:
type: object
type: array
query:
- description: QuerySpec defines the query command line flags when starting
- Prometheus.
+ description: QuerySpec defines the query command line flags when starting Prometheus.
properties:
lookbackDelta:
- description: The delta difference allowed for retrieving metrics
- during expression evaluations.
+ description: The delta difference allowed for retrieving metrics during expression evaluations.
type: string
maxConcurrency:
description: Number of concurrent queries that can be run at once.
@@ -4584,10 +2977,7 @@ spec:
minimum: 1
type: integer
maxSamples:
- description: Maximum number of samples a single query can load
- into memory. Note that queries will fail if they would load
- more samples than this into memory, so this also limits the
- number of samples a query can return.
+ description: Maximum number of samples a single query can load into memory. Note that queries will fail if they would load more samples than this into memory, so this also limits the number of samples a query can return.
format: int32
type: integer
timeout:
@@ -4596,94 +2986,69 @@ spec:
type: string
type: object
queryLogFile:
- description: QueryLogFile specifies the file to which PromQL queries
- are logged. If the filename has an empty path, e.g. 'query.log',
- prometheus-operator will mount the file into an emptyDir volume
- at `/var/log/prometheus`. If a full path is provided, e.g. /var/log/prometheus/query.log,
- you must mount a volume in the specified directory and it must be
- writable. This is because the prometheus container runs with a read-only
- root filesystem for security reasons. Alternatively, the location
- can be set to a stdout location such as `/dev/stdout` to log query
- information to the default Prometheus log stream. This is only available
- in versions of Prometheus >= 2.16.0. For more details, see the Prometheus
- docs (https://prometheus.io/docs/guides/query-log/)
+ description: QueryLogFile specifies the file to which PromQL queries are logged. If the filename has an empty path, e.g. 'query.log', prometheus-operator will mount the file into an emptyDir volume at `/var/log/prometheus`. If a full path is provided, e.g. /var/log/prometheus/query.log, you must mount a volume in the specified directory and it must be writable. This is because the prometheus container runs with a read-only root filesystem for security reasons. Alternatively, the location can be set to a stdout location such as `/dev/stdout` to log query information to the default Prometheus log stream. This is only available in versions of Prometheus >= 2.16.0. For more details, see the Prometheus docs (https://prometheus.io/docs/guides/query-log/)
type: string
remoteRead:
description: remoteRead is the list of remote read configurations.
items:
- description: RemoteReadSpec defines the configuration for Prometheus
- to read back samples from a remote endpoint.
+ description: RemoteReadSpec defines the configuration for Prometheus to read back samples from a remote endpoint.
properties:
authorization:
description: Authorization section for remote read
properties:
credentials:
- description: The secret's key that contains the credentials
- of the request
+ description: The secret's key that contains the credentials of the request
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
credentialsFile:
- description: File to read a secret from, mutually exclusive
- with Credentials (from SafeAuthorization)
+ description: File to read a secret from, mutually exclusive with Credentials (from SafeAuthorization)
type: string
type:
- description: Set the authentication type. Defaults to Bearer,
- Basic will cause an error
+ description: Set the authentication type. Defaults to Bearer, Basic will cause an error
type: string
type: object
basicAuth:
description: BasicAuth for the URL.
properties:
password:
- description: The secret in the service monitor namespace
- that contains the password for authentication.
+ description: The secret in the service monitor namespace that contains the password for authentication.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
username:
- description: The secret in the service monitor namespace
- that contains the username for authentication.
+ description: The secret in the service monitor namespace that contains the username for authentication.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -4697,47 +3062,33 @@ spec:
description: File to read bearer token for remote read.
type: string
filterExternalLabels:
- description: Whether to use the external labels as selectors
- for the remote read endpoint. Requires Prometheus v2.34.0
- and above.
+ description: Whether to use the external labels as selectors for the remote read endpoint. Requires Prometheus v2.34.0 and above.
type: boolean
headers:
additionalProperties:
type: string
- description: Custom HTTP headers to be sent along with each
- remote read request. Be aware that headers that are set by
- Prometheus itself can't be overwritten. Only valid in Prometheus
- versions 2.26.0 and newer.
+ description: Custom HTTP headers to be sent along with each remote read request. Be aware that headers that are set by Prometheus itself can't be overwritten. Only valid in Prometheus versions 2.26.0 and newer.
type: object
name:
- description: The name of the remote read queue, it must be unique
- if specified. The name is used in metrics and logging in order
- to differentiate read configurations. Only valid in Prometheus
- versions 2.15.0 and newer.
+ description: The name of the remote read queue, it must be unique if specified. The name is used in metrics and logging in order to differentiate read configurations. Only valid in Prometheus versions 2.15.0 and newer.
type: string
oauth2:
- description: OAuth2 for the URL. Only valid in Prometheus versions
- 2.27.0 and newer.
+ description: OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer.
properties:
clientId:
- description: The secret or configmap containing the OAuth2
- client id
+ description: The secret or configmap containing the OAuth2 client id
properties:
configMap:
- description: ConfigMap containing data to use for the
- targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its
- key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
@@ -4747,17 +3098,13 @@ spec:
description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -4768,16 +3115,13 @@ spec:
description: The secret containing the OAuth2 client secret
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -4806,8 +3150,7 @@ spec:
description: Optional ProxyURL.
type: string
readRecent:
- description: Whether reads should be made for queries for time
- ranges that the local storage should have complete data for.
+ description: Whether reads should be made for queries for time ranges that the local storage should have complete data for.
type: boolean
remoteTimeout:
description: Timeout for requests to the remote read endpoint.
@@ -4816,31 +3159,25 @@ spec:
requiredMatchers:
additionalProperties:
type: string
- description: An optional list of equality matchers which have
- to be present in a selector to query the remote read endpoint.
+ description: An optional list of equality matchers which have to be present in a selector to query the remote read endpoint.
type: object
tlsConfig:
description: TLS Config to use for remote read.
properties:
ca:
- description: Certificate authority used when verifying server
- certificates.
+ description: Certificate authority used when verifying server certificates.
properties:
configMap:
- description: ConfigMap containing data to use for the
- targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its
- key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
@@ -4850,17 +3187,13 @@ spec:
description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -4868,27 +3201,22 @@ spec:
x-kubernetes-map-type: atomic
type: object
caFile:
- description: Path to the CA cert in the Prometheus container
- to use for the targets.
+ description: Path to the CA cert in the Prometheus container to use for the targets.
type: string
cert:
description: Client certificate to present when doing client-authentication.
properties:
configMap:
- description: ConfigMap containing data to use for the
- targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its
- key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
@@ -4898,17 +3226,13 @@ spec:
description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -4916,31 +3240,25 @@ spec:
x-kubernetes-map-type: atomic
type: object
certFile:
- description: Path to the client cert file in the Prometheus
- container for the targets.
+ description: Path to the client cert file in the Prometheus container for the targets.
type: string
insecureSkipVerify:
description: Disable target certificate validation.
type: boolean
keyFile:
- description: Path to the client key file in the Prometheus
- container for the targets.
+ description: Path to the client key file in the Prometheus container for the targets.
type: string
keySecret:
- description: Secret containing the client key file for the
- targets.
+ description: Secret containing the client key file for the targets.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -4960,79 +3278,64 @@ spec:
remoteWrite:
description: remoteWrite is the list of remote write configurations.
items:
- description: RemoteWriteSpec defines the configuration to write
- samples from Prometheus to a remote endpoint.
+ description: RemoteWriteSpec defines the configuration to write samples from Prometheus to a remote endpoint.
properties:
authorization:
description: Authorization section for remote write
properties:
credentials:
- description: The secret's key that contains the credentials
- of the request
+ description: The secret's key that contains the credentials of the request
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
credentialsFile:
- description: File to read a secret from, mutually exclusive
- with Credentials (from SafeAuthorization)
+ description: File to read a secret from, mutually exclusive with Credentials (from SafeAuthorization)
type: string
type:
- description: Set the authentication type. Defaults to Bearer,
- Basic will cause an error
+ description: Set the authentication type. Defaults to Bearer, Basic will cause an error
type: string
type: object
basicAuth:
description: BasicAuth for the URL.
properties:
password:
- description: The secret in the service monitor namespace
- that contains the password for authentication.
+ description: The secret in the service monitor namespace that contains the password for authentication.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
username:
- description: The secret in the service monitor namespace
- that contains the username for authentication.
+ description: The secret in the service monitor namespace that contains the username for authentication.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -5048,54 +3351,39 @@ spec:
headers:
additionalProperties:
type: string
- description: Custom HTTP headers to be sent along with each
- remote write request. Be aware that headers that are set by
- Prometheus itself can't be overwritten. Only valid in Prometheus
- versions 2.25.0 and newer.
+ description: Custom HTTP headers to be sent along with each remote write request. Be aware that headers that are set by Prometheus itself can't be overwritten. Only valid in Prometheus versions 2.25.0 and newer.
type: object
metadataConfig:
- description: MetadataConfig configures the sending of series
- metadata to the remote storage.
+ description: MetadataConfig configures the sending of series metadata to the remote storage.
properties:
send:
- description: Whether metric metadata is sent to the remote
- storage or not.
+ description: Whether metric metadata is sent to the remote storage or not.
type: boolean
sendInterval:
- description: How frequently metric metadata is sent to the
- remote storage.
+ description: How frequently metric metadata is sent to the remote storage.
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
type: object
name:
- description: The name of the remote write queue, it must be
- unique if specified. The name is used in metrics and logging
- in order to differentiate queues. Only valid in Prometheus
- versions 2.15.0 and newer.
+ description: The name of the remote write queue, it must be unique if specified. The name is used in metrics and logging in order to differentiate queues. Only valid in Prometheus versions 2.15.0 and newer.
type: string
oauth2:
- description: OAuth2 for the URL. Only valid in Prometheus versions
- 2.27.0 and newer.
+ description: OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer.
properties:
clientId:
- description: The secret or configmap containing the OAuth2
- client id
+ description: The secret or configmap containing the OAuth2 client id
properties:
configMap:
- description: ConfigMap containing data to use for the
- targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its
- key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
@@ -5105,17 +3393,13 @@ spec:
description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -5126,16 +3410,13 @@ spec:
description: The secret containing the OAuth2 client secret
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -5164,44 +3445,34 @@ spec:
description: Optional ProxyURL.
type: string
queueConfig:
- description: QueueConfig allows tuning of the remote write queue
- parameters.
+ description: QueueConfig allows tuning of the remote write queue parameters.
properties:
batchSendDeadline:
- description: BatchSendDeadline is the maximum time a sample
- will wait in buffer.
+ description: BatchSendDeadline is the maximum time a sample will wait in buffer.
type: string
capacity:
- description: Capacity is the number of samples to buffer
- per shard before we start dropping them.
+ description: Capacity is the number of samples to buffer per shard before we start dropping them.
type: integer
maxBackoff:
description: MaxBackoff is the maximum retry delay.
type: string
maxRetries:
- description: MaxRetries is the maximum number of times to
- retry a batch on recoverable errors.
+ description: MaxRetries is the maximum number of times to retry a batch on recoverable errors.
type: integer
maxSamplesPerSend:
- description: MaxSamplesPerSend is the maximum number of
- samples per send.
+ description: MaxSamplesPerSend is the maximum number of samples per send.
type: integer
maxShards:
- description: MaxShards is the maximum number of shards,
- i.e. amount of concurrency.
+ description: MaxShards is the maximum number of shards, i.e. amount of concurrency.
type: integer
minBackoff:
- description: MinBackoff is the initial retry delay. Gets
- doubled for every retry.
+ description: MinBackoff is the initial retry delay. Gets doubled for every retry.
type: string
minShards:
- description: MinShards is the minimum number of shards,
- i.e. amount of concurrency.
+ description: MinShards is the minimum number of shards, i.e. amount of concurrency.
type: integer
retryOnRateLimit:
- description: Retry upon receiving a 429 status code from
- the remote-write storage. This is experimental feature
- and might change in the future.
+ description: Retry upon receiving a 429 status code from the remote-write storage. This is experimental feature and might change in the future.
type: boolean
type: object
remoteTimeout:
@@ -5209,30 +3480,22 @@ spec:
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
sendExemplars:
- description: Enables sending of exemplars over remote write.
- Note that exemplar-storage itself must be enabled using the
- enableFeature option for exemplars to be scraped in the first
- place. Only valid in Prometheus versions 2.27.0 and newer.
+ description: Enables sending of exemplars over remote write. Note that exemplar-storage itself must be enabled using the enableFeature option for exemplars to be scraped in the first place. Only valid in Prometheus versions 2.27.0 and newer.
type: boolean
sigv4:
- description: Sigv4 allows to configures AWS's Signature Verification
- 4
+ description: Sigv4 allows to configures AWS's Signature Verification 4
properties:
accessKey:
- description: AccessKey is the AWS API key. If blank, the
- environment variable `AWS_ACCESS_KEY_ID` is used.
+ description: AccessKey is the AWS API key. If blank, the environment variable `AWS_ACCESS_KEY_ID` is used.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -5242,27 +3505,22 @@ spec:
description: Profile is the named AWS profile used to authenticate.
type: string
region:
- description: Region is the AWS region. If blank, the region
- from the default credentials chain used.
+ description: Region is the AWS region. If blank, the region from the default credentials chain used.
type: string
roleArn:
description: RoleArn is the named AWS profile used to authenticate.
type: string
secretKey:
- description: SecretKey is the AWS API secret. If blank,
- the environment variable `AWS_SECRET_ACCESS_KEY` is used.
+ description: SecretKey is the AWS API secret. If blank, the environment variable `AWS_SECRET_ACCESS_KEY` is used.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -5273,24 +3531,19 @@ spec:
description: TLS Config to use for remote write.
properties:
ca:
- description: Certificate authority used when verifying server
- certificates.
+ description: Certificate authority used when verifying server certificates.
properties:
configMap:
- description: ConfigMap containing data to use for the
- targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its
- key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
@@ -5300,17 +3553,13 @@ spec:
description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -5318,27 +3567,22 @@ spec:
x-kubernetes-map-type: atomic
type: object
caFile:
- description: Path to the CA cert in the Prometheus container
- to use for the targets.
+ description: Path to the CA cert in the Prometheus container to use for the targets.
type: string
cert:
description: Client certificate to present when doing client-authentication.
properties:
configMap:
- description: ConfigMap containing data to use for the
- targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its
- key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
@@ -5348,17 +3592,13 @@ spec:
description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -5366,31 +3606,25 @@ spec:
x-kubernetes-map-type: atomic
type: object
certFile:
- description: Path to the client cert file in the Prometheus
- container for the targets.
+ description: Path to the client cert file in the Prometheus container for the targets.
type: string
insecureSkipVerify:
description: Disable target certificate validation.
type: boolean
keyFile:
- description: Path to the client key file in the Prometheus
- container for the targets.
+ description: Path to the client key file in the Prometheus container for the targets.
type: string
keySecret:
- description: Secret containing the client key file for the
- targets.
+ description: Secret containing the client key file for the targets.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -5406,16 +3640,11 @@ spec:
writeRelabelConfigs:
description: The list of remote write relabel configurations.
items:
- description: 'RelabelConfig allows dynamic rewriting of the
- label set, being applied to samples before ingestion. It
- defines `<metric_relabel_configs>`-section of Prometheus
- configuration. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs'
+ description: 'RelabelConfig allows dynamic rewriting of the label set, being applied to samples before ingestion. It defines `<metric_relabel_configs>`-section of Prometheus configuration. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs'
properties:
action:
default: replace
- description: Action to perform based on regex matching.
- Default is 'replace'. uppercase and lowercase actions
- require Prometheus >= 2.36.
+ description: Action to perform based on regex matching. Default is 'replace'. uppercase and lowercase actions require Prometheus >= 2.36.
enum:
- replace
- Replace
@@ -5441,39 +3670,27 @@ spec:
- DropEqual
type: string
modulus:
- description: Modulus to take of the hash of the source
- label values.
+ description: Modulus to take of the hash of the source label values.
format: int64
type: integer
regex:
- description: Regular expression against which the extracted
- value is matched. Default is '(.*)'
+ description: Regular expression against which the extracted value is matched. Default is '(.*)'
type: string
replacement:
- description: Replacement value against which a regex replace
- is performed if the regular expression matches. Regex
- capture groups are available. Default is '$1'
+ description: Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Default is '$1'
type: string
separator:
- description: Separator placed between concatenated source
- label values. default is ';'.
+ description: Separator placed between concatenated source label values. default is ';'.
type: string
sourceLabels:
- description: The source labels select values from existing
- labels. Their content is concatenated using the configured
- separator and matched against the configured regular
- expression for the replace, keep, and drop actions.
+ description: The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions.
items:
- description: LabelName is a valid Prometheus label name
- which may only contain ASCII letters, numbers, as
- well as underscores.
+ description: LabelName is a valid Prometheus label name which may only contain ASCII letters, numbers, as well as underscores.
pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$
type: string
type: array
targetLabel:
- description: Label to which the resulting value is written
- in a replace action. It is mandatory for replace actions.
- Regex capture groups are available.
+ description: Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available.
type: string
type: object
type: array
@@ -5482,31 +3699,22 @@ spec:
type: object
type: array
replicaExternalLabelName:
- description: Name of Prometheus external label used to denote replica
- name. Defaults to the value of `prometheus_replica`. External label
- will _not_ be added when value is set to empty string (`""`).
+ description: Name of Prometheus external label used to denote replica name. Defaults to the value of `prometheus_replica`. External label will _not_ be added when value is set to empty string (`""`).
type: string
replicas:
- description: Number of replicas of each shard to deploy for a Prometheus
- deployment. Number of replicas multiplied by shards is the total
- number of Pods created.
+ description: Number of replicas of each shard to deploy for a Prometheus deployment. Number of replicas multiplied by shards is the total number of Pods created.
format: int32
type: integer
resources:
description: Define resources requests and limits for single Pods.
properties:
claims:
- description: "Claims lists the names of resources, defined in
- spec.resourceClaims, that are used by this container. \n This
- is an alpha field and requires enabling the DynamicResourceAllocation
- feature gate. \n This field is immutable."
+ description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable."
items:
description: ResourceClaim references one entry in PodSpec.ResourceClaims.
properties:
name:
- description: Name must match the name of one entry in pod.spec.resourceClaims
- of the Pod where this field is used. It makes that resource
- available inside a container.
+ description: Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
type: string
required:
- name
@@ -5522,8 +3730,7 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute resources
- allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -5532,17 +3739,11 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Requests describes the minimum amount of compute
- resources required. If Requests is omitted for a container,
- it defaults to Limits if that is explicitly specified, otherwise
- to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
retention:
- description: Time duration Prometheus shall retain data for. Default
- is '24h' if retentionSize is not set, and must match the regular
- expression `[0-9]+(ms|s|m|h|d|w|y)` (milliseconds seconds minutes
- hours days weeks years).
+ description: Time duration Prometheus shall retain data for. Default is '24h' if retentionSize is not set, and must match the regular expression `[0-9]+(ms|s|m|h|d|w|y)` (milliseconds seconds minutes hours days weeks years).
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
retentionSize:
@@ -5550,40 +3751,24 @@ spec:
pattern: (^0|([0-9]*[.])?[0-9]+((K|M|G|T|E|P)i?)?B)$
type: string
routePrefix:
- description: The route prefix Prometheus registers HTTP handlers for.
- This is useful, if using ExternalURL and a proxy is rewriting HTTP
- routes of a request, and the actual ExternalURL is still true, but
- the server serves requests under a different route prefix. For example
- for use with `kubectl proxy`.
+ description: The route prefix Prometheus registers HTTP handlers for. This is useful, if using ExternalURL and a proxy is rewriting HTTP routes of a request, and the actual ExternalURL is still true, but the server serves requests under a different route prefix. For example for use with `kubectl proxy`.
type: string
ruleNamespaceSelector:
- description: Namespaces to be selected for PrometheusRules discovery.
- If unspecified, only the same namespace as the Prometheus object
- is in is used.
+ description: Namespaces to be selected for PrometheusRules discovery. If unspecified, only the same namespace as the Prometheus object is in is used.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements.
- The requirements are ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a selector that
- contains values, a key, and an operator that relates the key
- and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the selector applies
- to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship to
- a set of values. Valid operators are In, NotIn, Exists
- and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string values. If the
- operator is In or NotIn, the values array must be non-empty.
- If the operator is Exists or DoesNotExist, the values
- array must be empty. This array is replaced during a strategic
- merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -5595,45 +3780,26 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value} pairs. A single
- {key,value} in the matchLabels map is equivalent to an element
- of matchExpressions, whose key field is "key", the operator
- is "In", and the values array contains only "value". The requirements
- are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
ruleSelector:
- description: A selector to select which PrometheusRules to mount for
- loading alerting/recording rules from. Until (excluding) Prometheus
- Operator v0.24.0 Prometheus Operator will migrate any legacy rule
- ConfigMaps to PrometheusRule custom resources selected by RuleSelector.
- Make sure it does not match any config maps that you do not want
- to be migrated.
+ description: A selector to select which PrometheusRules to mount for loading alerting/recording rules from. Until (excluding) Prometheus Operator v0.24.0 Prometheus Operator will migrate any legacy rule ConfigMaps to PrometheusRule custom resources selected by RuleSelector. Make sure it does not match any config maps that you do not want to be migrated.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements.
- The requirements are ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a selector that
- contains values, a key, and an operator that relates the key
- and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the selector applies
- to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship to
- a set of values. Valid operators are In, NotIn, Exists
- and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string values. If the
- operator is In or NotIn, the values array must be non-empty.
- If the operator is Exists or DoesNotExist, the values
- array must be empty. This array is replaced during a strategic
- merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -5645,11 +3811,7 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value} pairs. A single
- {key,value} in the matchLabels map is equivalent to an element
- of matchExpressions, whose key field is "key", the operator
- is "In", and the values array contains only "value". The requirements
- are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
@@ -5660,17 +3822,13 @@ spec:
description: /--rules.alert.*/ command-line arguments
properties:
forGracePeriod:
- description: Minimum duration between alert and restored 'for'
- state. This is maintained only for alerts with configured
- 'for' time greater than grace period.
+ description: Minimum duration between alert and restored 'for' state. This is maintained only for alerts with configured 'for' time greater than grace period.
type: string
forOutageTolerance:
- description: Max time to tolerate prometheus outage for restoring
- 'for' state of alert.
+ description: Max time to tolerate prometheus outage for restoring 'for' state of alert.
type: string
resendDelay:
- description: Minimum amount of time to wait before resending
- an alert to Alertmanager.
+ description: Minimum amount of time to wait before resending an alert to Alertmanager.
type: string
type: object
type: object
@@ -5680,137 +3838,71 @@ spec:
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
scrapeTimeout:
- description: Number of seconds to wait for target to respond before
- erroring.
+ description: Number of seconds to wait for target to respond before erroring.
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
secrets:
- description: Secrets is a list of Secrets in the same namespace as
- the Prometheus object, which shall be mounted into the Prometheus
- Pods. Each Secret is added to the StatefulSet definition as a volume
- named `secret-<secret-name>`. The Secrets are mounted into /etc/prometheus/secrets/<secret-name>
- in the 'prometheus' container.
+ description: Secrets is a list of Secrets in the same namespace as the Prometheus object, which shall be mounted into the Prometheus Pods. Each Secret is added to the StatefulSet definition as a volume named `secret-<secret-name>`. The Secrets are mounted into /etc/prometheus/secrets/<secret-name> in the 'prometheus' container.
items:
type: string
type: array
securityContext:
- description: SecurityContext holds pod-level security attributes and
- common container settings. This defaults to the default PodSecurityContext.
+ description: SecurityContext holds pod-level security attributes and common container settings. This defaults to the default PodSecurityContext.
properties:
fsGroup:
- description: "A special supplemental group that applies to all
- containers in a pod. Some volume types allow the Kubelet to
- change the ownership of that volume to be owned by the pod:
- \n 1. The owning GID will be the FSGroup 2. The setgid bit is
- set (new files created in the volume will be owned by FSGroup)
- 3. The permission bits are OR'd with rw-rw---- \n If unset,
- the Kubelet will not modify the ownership and permissions of
- any volume. Note that this field cannot be set when spec.os.name
- is windows."
+ description: "A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: \n 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- \n If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows."
format: int64
type: integer
fsGroupChangePolicy:
- description: 'fsGroupChangePolicy defines behavior of changing
- ownership and permission of the volume before being exposed
- inside Pod. This field will only apply to volume types which
- support fsGroup based ownership(and permissions). It will have
- no effect on ephemeral volume types such as: secret, configmaps
- and emptydir. Valid values are "OnRootMismatch" and "Always".
- If not specified, "Always" is used. Note that this field cannot
- be set when spec.os.name is windows.'
+ description: 'fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. Note that this field cannot be set when spec.os.name is windows.'
type: string
runAsGroup:
- description: The GID to run the entrypoint of the container process.
- Uses runtime default if unset. May also be set in SecurityContext. If
- set in both SecurityContext and PodSecurityContext, the value
- specified in SecurityContext takes precedence for that container.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
format: int64
type: integer
runAsNonRoot:
- description: Indicates that the container must run as a non-root
- user. If true, the Kubelet will validate the image at runtime
- to ensure that it does not run as UID 0 (root) and fail to start
- the container if it does. If unset or false, no such validation
- will be performed. May also be set in SecurityContext. If set
- in both SecurityContext and PodSecurityContext, the value specified
- in SecurityContext takes precedence.
+ description: Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
type: boolean
runAsUser:
- description: The UID to run the entrypoint of the container process.
- Defaults to user specified in image metadata if unspecified.
- May also be set in SecurityContext. If set in both SecurityContext
- and PodSecurityContext, the value specified in SecurityContext
- takes precedence for that container. Note that this field cannot
- be set when spec.os.name is windows.
+ description: The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
format: int64
type: integer
seLinuxOptions:
- description: The SELinux context to be applied to all containers.
- If unspecified, the container runtime will allocate a random
- SELinux context for each container. May also be set in SecurityContext. If
- set in both SecurityContext and PodSecurityContext, the value
- specified in SecurityContext takes precedence for that container.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
properties:
level:
- description: Level is SELinux level label that applies to
- the container.
+ description: Level is SELinux level label that applies to the container.
type: string
role:
- description: Role is a SELinux role label that applies to
- the container.
+ description: Role is a SELinux role label that applies to the container.
type: string
type:
- description: Type is a SELinux type label that applies to
- the container.
+ description: Type is a SELinux type label that applies to the container.
type: string
user:
- description: User is a SELinux user label that applies to
- the container.
+ description: User is a SELinux user label that applies to the container.
type: string
type: object
seccompProfile:
- description: The seccomp options to use by the containers in this
- pod. Note that this field cannot be set when spec.os.name is
- windows.
+ description: The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.
properties:
localhostProfile:
- description: localhostProfile indicates a profile defined
- in a file on the node should be used. The profile must be
- preconfigured on the node to work. Must be a descending
- path, relative to the kubelet's configured seccomp profile
- location. Must only be set if type is "Localhost".
+ description: localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost".
type: string
type:
- description: "type indicates which kind of seccomp profile
- will be applied. Valid options are: \n Localhost - a profile
- defined in a file on the node should be used. RuntimeDefault
- - the container runtime default profile should be used.
- Unconfined - no profile should be applied."
+ description: "type indicates which kind of seccomp profile will be applied. Valid options are: \n Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied."
type: string
required:
- type
type: object
supplementalGroups:
- description: A list of groups applied to the first process run
- in each container, in addition to the container's primary GID,
- the fsGroup (if specified), and group memberships defined in
- the container image for the uid of the container process. If
- unspecified, no additional groups are added to any container.
- Note that group memberships defined in the container image for
- the uid of the container process are still effective, even if
- they are not included in this list. Note that this field cannot
- be set when spec.os.name is windows.
+ description: A list of groups applied to the first process run in each container, in addition to the container's primary GID, the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process. If unspecified, no additional groups are added to any container. Note that group memberships defined in the container image for the uid of the container process are still effective, even if they are not included in this list. Note that this field cannot be set when spec.os.name is windows.
items:
format: int64
type: integer
type: array
sysctls:
- description: Sysctls hold a list of namespaced sysctls used for
- the pod. Pods with unsupported sysctls (by the container runtime)
- might fail to launch. Note that this field cannot be set when
- spec.os.name is windows.
+ description: Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows.
items:
description: Sysctl defines a kernel parameter to be set
properties:
@@ -5826,73 +3918,41 @@ spec:
type: object
type: array
windowsOptions:
- description: The Windows specific settings applied to all containers.
- If unspecified, the options within a container's SecurityContext
- will be used. If set in both SecurityContext and PodSecurityContext,
- the value specified in SecurityContext takes precedence. Note
- that this field cannot be set when spec.os.name is linux.
+ description: The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
properties:
gmsaCredentialSpec:
- description: GMSACredentialSpec is where the GMSA admission
- webhook (https://github.com/kubernetes-sigs/windows-gmsa)
- inlines the contents of the GMSA credential spec named by
- the GMSACredentialSpecName field.
+ description: GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.
type: string
gmsaCredentialSpecName:
- description: GMSACredentialSpecName is the name of the GMSA
- credential spec to use.
+ description: GMSACredentialSpecName is the name of the GMSA credential spec to use.
type: string
hostProcess:
- description: HostProcess determines if a container should
- be run as a 'Host Process' container. This field is alpha-level
- and will only be honored by components that enable the WindowsHostProcessContainers
- feature flag. Setting this field without the feature flag
- will result in errors when validating the Pod. All of a
- Pod's containers must have the same effective HostProcess
- value (it is not allowed to have a mix of HostProcess containers
- and non-HostProcess containers). In addition, if HostProcess
- is true then HostNetwork must also be set to true.
+ description: HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.
type: boolean
runAsUserName:
- description: The UserName in Windows to run the entrypoint
- of the container process. Defaults to the user specified
- in image metadata if unspecified. May also be set in PodSecurityContext.
- If set in both SecurityContext and PodSecurityContext, the
- value specified in SecurityContext takes precedence.
+ description: The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
type: string
type: object
type: object
serviceAccountName:
- description: ServiceAccountName is the name of the ServiceAccount
- to use to run the Prometheus Pods.
+ description: ServiceAccountName is the name of the ServiceAccount to use to run the Prometheus Pods.
type: string
serviceMonitorNamespaceSelector:
- description: Namespace's labels to match for ServiceMonitor discovery.
- If nil, only check own namespace.
+ description: Namespace's labels to match for ServiceMonitor discovery. If nil, only check own namespace.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements.
- The requirements are ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a selector that
- contains values, a key, and an operator that relates the key
- and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the selector applies
- to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship to
- a set of values. Valid operators are In, NotIn, Exists
- and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string values. If the
- operator is In or NotIn, the values array must be non-empty.
- If the operator is Exists or DoesNotExist, the values
- array must be empty. This array is replaced during a strategic
- merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -5904,48 +3964,26 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value} pairs. A single
- {key,value} in the matchLabels map is equivalent to an element
- of matchExpressions, whose key field is "key", the operator
- is "In", and the values array contains only "value". The requirements
- are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
serviceMonitorSelector:
- description: "ServiceMonitors to be selected for target discovery.
- \n If `spec.serviceMonitorSelector`, `spec.podMonitorSelector` and
- `spec.probeSelector` are null, the Prometheus configuration is unmanaged.
- The Prometheus operator will ensure that the Prometheus configuration's
- Secret exists, but it is the responsibility of the user to provide
- the raw gzipped Prometheus configuration under the `prometheus.yaml.gz`
- key. This behavior is deprecated and will be removed in the next
- major version of the custom resource definition. It is recommended
- to use `spec.additionalScrapeConfigs` instead."
+ description: "ServiceMonitors to be selected for target discovery. \n If `spec.serviceMonitorSelector`, `spec.podMonitorSelector` and `spec.probeSelector` are null, the Prometheus configuration is unmanaged. The Prometheus operator will ensure that the Prometheus configuration's Secret exists, but it is the responsibility of the user to provide the raw gzipped Prometheus configuration under the `prometheus.yaml.gz` key. This behavior is deprecated and will be removed in the next major version of the custom resource definition. It is recommended to use `spec.additionalScrapeConfigs` instead."
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements.
- The requirements are ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a selector that
- contains values, a key, and an operator that relates the key
- and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the selector applies
- to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship to
- a set of values. Valid operators are In, NotIn, Exists
- and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string values. If the
- operator is In or NotIn, the values array must be non-empty.
- If the operator is Exists or DoesNotExist, the values
- array must be empty. This array is replaced during a strategic
- merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -5957,136 +3995,65 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value} pairs. A single
- {key,value} in the matchLabels map is equivalent to an element
- of matchExpressions, whose key field is "key", the operator
- is "In", and the values array contains only "value". The requirements
- are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
sha:
- description: 'SHA of Prometheus container image to be deployed. Defaults
- to the value of `version`. Similar to a tag, but the SHA explicitly
- deploys an immutable container image. Version and Tag are ignored
- if SHA is set. Deprecated: use ''image'' instead. The image digest
- can be specified as part of the image URL.'
+ description: 'SHA of Prometheus container image to be deployed. Defaults to the value of `version`. Similar to a tag, but the SHA explicitly deploys an immutable container image. Version and Tag are ignored if SHA is set. Deprecated: use ''image'' instead. The image digest can be specified as part of the image URL.'
type: string
shards:
- description: 'EXPERIMENTAL: Number of shards to distribute targets
- onto. Number of replicas multiplied by shards is the total number
- of Pods created. Note that scaling down shards will not reshard
- data onto remaining instances, it must be manually moved. Increasing
- shards will not reshard data either but it will continue to be available
- from the same instances. To query globally use Thanos sidecar and
- Thanos querier or remote write data to a central location. Sharding
- is done on the content of the `__address__` target meta-label.'
+ description: 'EXPERIMENTAL: Number of shards to distribute targets onto. Number of replicas multiplied by shards is the total number of Pods created. Note that scaling down shards will not reshard data onto remaining instances, it must be manually moved. Increasing shards will not reshard data either but it will continue to be available from the same instances. To query globally use Thanos sidecar and Thanos querier or remote write data to a central location. Sharding is done on the content of the `__address__` target meta-label.'
format: int32
type: integer
storage:
description: Storage spec to specify how storage shall be used.
properties:
disableMountSubPath:
- description: 'Deprecated: subPath usage will be disabled by default
- in a future release, this option will become unnecessary. DisableMountSubPath
- allows to remove any subPath usage in volume mounts.'
+ description: 'Deprecated: subPath usage will be disabled by default in a future release, this option will become unnecessary. DisableMountSubPath allows to remove any subPath usage in volume mounts.'
type: boolean
emptyDir:
- description: 'EmptyDirVolumeSource to be used by the StatefulSet.
- If specified, used in place of any volumeClaimTemplate. More
- info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir'
+ description: 'EmptyDirVolumeSource to be used by the StatefulSet. If specified, used in place of any volumeClaimTemplate. More info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir'
properties:
medium:
- description: 'medium represents what type of storage medium
- should back this directory. The default is "" which means
- to use the node''s default medium. Must be an empty string
- (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
+ description: 'medium represents what type of storage medium should back this directory. The default is "" which means to use the node''s default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
type: string
sizeLimit:
anyOf:
- type: integer
- type: string
- description: 'sizeLimit is the total amount of local storage
- required for this EmptyDir volume. The size limit is also
- applicable for memory medium. The maximum usage on memory
- medium EmptyDir would be the minimum value between the SizeLimit
- specified here and the sum of memory limits of all containers
- in a pod. The default is nil which means that the limit
- is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir'
+ description: 'sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir'
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
type: object
ephemeral:
- description: 'EphemeralVolumeSource to be used by the StatefulSet.
- This is a beta field in k8s 1.21, for lower versions, starting
- with k8s 1.19, it requires enabling the GenericEphemeralVolume
- feature gate. More info: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes'
+ description: 'EphemeralVolumeSource to be used by the StatefulSet. This is a beta field in k8s 1.21, for lower versions, starting with k8s 1.19, it requires enabling the GenericEphemeralVolume feature gate. More info: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes'
properties:
volumeClaimTemplate:
- description: "Will be used to create a stand-alone PVC to
- provision the volume. The pod in which this EphemeralVolumeSource
- is embedded will be the owner of the PVC, i.e. the PVC will
- be deleted together with the pod. The name of the PVC will
- be `<pod name>-<volume name>` where `<volume name>` is the
- name from the `PodSpec.Volumes` array entry. Pod validation
- will reject the pod if the concatenated name is not valid
- for a PVC (for example, too long). \n An existing PVC with
- that name that is not owned by the pod will *not* be used
- for the pod to avoid using an unrelated volume by mistake.
- Starting the pod is then blocked until the unrelated PVC
- is removed. If such a pre-created PVC is meant to be used
- by the pod, the PVC has to updated with an owner reference
- to the pod once the pod exists. Normally this should not
- be necessary, but it may be useful when manually reconstructing
- a broken cluster. \n This field is read-only and no changes
- will be made by Kubernetes to the PVC after it has been
- created. \n Required, must not be nil."
+ description: "Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `<pod name>-<volume name>` where `<volume name>` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). \n An existing PVC with that name that is not owned by the pod will *not* be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. \n This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. \n Required, must not be nil."
properties:
metadata:
- description: May contain labels and annotations that will
- be copied into the PVC when creating it. No other fields
- are allowed and will be rejected during validation.
+ description: May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.
type: object
spec:
- description: The specification for the PersistentVolumeClaim.
- The entire content is copied unchanged into the PVC
- that gets created from this template. The same fields
- as in a PersistentVolumeClaim are also valid here.
+ description: The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
properties:
accessModes:
- description: 'accessModes contains the desired access
- modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
+ description: 'accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
items:
type: string
type: array
dataSource:
- description: 'dataSource field can be used to specify
- either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
- * An existing PVC (PersistentVolumeClaim) If the
- provisioner or an external controller can support
- the specified data source, it will create a new
- volume based on the contents of the specified data
- source. When the AnyVolumeDataSource feature gate
- is enabled, dataSource contents will be copied to
- dataSourceRef, and dataSourceRef contents will be
- copied to dataSource when dataSourceRef.namespace
- is not specified. If the namespace is specified,
- then dataSourceRef will not be copied to dataSource.'
+ description: 'dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.'
properties:
apiGroup:
- description: APIGroup is the group for the resource
- being referenced. If APIGroup is not specified,
- the specified Kind must be in the core API group.
- For any other third-party types, APIGroup is
- required.
+ description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
type: string
kind:
- description: Kind is the type of resource being
- referenced
+ description: Kind is the type of resource being referenced
type: string
name:
- description: Name is the name of resource being
- referenced
+ description: Name is the name of resource being referenced
type: string
required:
- kind
@@ -6094,89 +4061,34 @@ spec:
type: object
x-kubernetes-map-type: atomic
dataSourceRef:
- description: 'dataSourceRef specifies the object from
- which to populate the volume with data, if a non-empty
- volume is desired. This may be any object from a
- non-empty API group (non core object) or a PersistentVolumeClaim
- object. When this field is specified, volume binding
- will only succeed if the type of the specified object
- matches some installed volume populator or dynamic
- provisioner. This field will replace the functionality
- of the dataSource field and as such if both fields
- are non-empty, they must have the same value. For
- backwards compatibility, when namespace isn''t specified
- in dataSourceRef, both fields (dataSource and dataSourceRef)
- will be set to the same value automatically if one
- of them is empty and the other is non-empty. When
- namespace is specified in dataSourceRef, dataSource
- isn''t set to the same value and must be empty.
- There are three important differences between dataSource
- and dataSourceRef: * While dataSource only allows
- two specific types of objects, dataSourceRef allows
- any non-core object, as well as PersistentVolumeClaim
- objects. * While dataSource ignores disallowed values
- (dropping them), dataSourceRef preserves all values,
- and generates an error if a disallowed value is
- specified. * While dataSource only allows local
- objects, dataSourceRef allows objects in any namespaces.
- (Beta) Using this field requires the AnyVolumeDataSource
- feature gate to be enabled. (Alpha) Using the namespace
- field of dataSourceRef requires the CrossNamespaceVolumeDataSource
- feature gate to be enabled.'
+ description: 'dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn''t specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn''t set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.'
properties:
apiGroup:
- description: APIGroup is the group for the resource
- being referenced. If APIGroup is not specified,
- the specified Kind must be in the core API group.
- For any other third-party types, APIGroup is
- required.
+ description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
type: string
kind:
- description: Kind is the type of resource being
- referenced
+ description: Kind is the type of resource being referenced
type: string
name:
- description: Name is the name of resource being
- referenced
+ description: Name is the name of resource being referenced
type: string
namespace:
- description: Namespace is the namespace of resource
- being referenced Note that when a namespace
- is specified, a gateway.networking.k8s.io/ReferenceGrant
- object is required in the referent namespace
- to allow that namespace's owner to accept the
- reference. See the ReferenceGrant documentation
- for details. (Alpha) This field requires the
- CrossNamespaceVolumeDataSource feature gate
- to be enabled.
+ description: Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
type: string
required:
- kind
- name
type: object
resources:
- description: 'resources represents the minimum resources
- the volume should have. If RecoverVolumeExpansionFailure
- feature is enabled users are allowed to specify
- resource requirements that are lower than previous
- value but must still be higher than capacity recorded
- in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
+ description: 'resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
properties:
claims:
- description: "Claims lists the names of resources,
- defined in spec.resourceClaims, that are used
- by this container. \n This is an alpha field
- and requires enabling the DynamicResourceAllocation
- feature gate. \n This field is immutable."
+ description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable."
items:
- description: ResourceClaim references one entry
- in PodSpec.ResourceClaims.
+ description: ResourceClaim references one entry in PodSpec.ResourceClaims.
properties:
name:
- description: Name must match the name of
- one entry in pod.spec.resourceClaims of
- the Pod where this field is used. It makes
- that resource available inside a container.
+ description: Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
type: string
required:
- name
@@ -6192,8 +4104,7 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount
- of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -6202,43 +4113,25 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Requests describes the minimum amount
- of compute resources required. If Requests is
- omitted for a container, it defaults to Limits
- if that is explicitly specified, otherwise to
- an implementation-defined value. More info:
- https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
selector:
- description: selector is a label query over volumes
- to consider for binding.
+ description: selector is a label query over volumes to consider for binding.
properties:
matchExpressions:
- description: matchExpressions is a list of label
- selector requirements. The requirements are
- ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is
- a selector that contains values, a key, and
- an operator that relates the key and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the
- selector applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's
- relationship to a set of values. Valid
- operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string
- values. If the operator is In or NotIn,
- the values array must be non-empty. If
- the operator is Exists or DoesNotExist,
- the values array must be empty. This array
- is replaced during a strategic merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -6250,27 +4143,18 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value}
- pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions,
- whose key field is "key", the operator is "In",
- and the values array contains only "value".
- The requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
storageClassName:
- description: 'storageClassName is the name of the
- StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
+ description: 'storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
type: string
volumeMode:
- description: volumeMode defines what type of volume
- is required by the claim. Value of Filesystem is
- implied when not included in claim spec.
+ description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
type: string
volumeName:
- description: volumeName is the binding reference to
- the PersistentVolume backing this claim.
+ description: volumeName is the binding reference to the PersistentVolume backing this claim.
type: string
type: object
required:
@@ -6278,81 +4162,44 @@ spec:
type: object
type: object
volumeClaimTemplate:
- description: A PVC spec to be used by the StatefulSet. The easiest
- way to use a volume that cannot be automatically provisioned
- (for whatever reason) is to use a label selector alongside manually
- created PersistentVolumes.
+ description: A PVC spec to be used by the StatefulSet. The easiest way to use a volume that cannot be automatically provisioned (for whatever reason) is to use a label selector alongside manually created PersistentVolumes.
properties:
apiVersion:
- description: 'APIVersion defines the versioned schema of this
- representation of an object. Servers should convert recognized
- schemas to the latest internal value, and may reject unrecognized
- values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+ description: 'APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: 'Kind is a string value representing the REST
- resource this object represents. Servers may infer this
- from the endpoint the client submits requests to. Cannot
- be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+ description: 'Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
- description: EmbeddedMetadata contains metadata relevant to
- an EmbeddedResource.
+ description: EmbeddedMetadata contains metadata relevant to an EmbeddedResource.
properties:
annotations:
additionalProperties:
type: string
- description: 'Annotations is an unstructured key value
- map stored with a resource that may be set by external
- tools to store and retrieve arbitrary metadata. They
- are not queryable and should be preserved when modifying
- objects. More info: http://kubernetes.io/docs/user-guide/annotations'
+ description: 'Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations'
type: object
labels:
additionalProperties:
type: string
- description: 'Map of string keys and values that can be
- used to organize and categorize (scope and select) objects.
- May match selectors of replication controllers and services.
- More info: http://kubernetes.io/docs/user-guide/labels'
+ description: 'Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels'
type: object
name:
- description: 'Name must be unique within a namespace.
- Is required when creating resources, although some resources
- may allow a client to request the generation of an appropriate
- name automatically. Name is primarily intended for creation
- idempotence and configuration definition. Cannot be
- updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names'
+ description: 'Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names'
type: string
type: object
spec:
- description: 'Spec defines the desired characteristics of
- a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
+ description: 'Spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
properties:
accessModes:
- description: 'accessModes contains the desired access
- modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
+ description: 'accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
items:
type: string
type: array
dataSource:
- description: 'dataSource field can be used to specify
- either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
- * An existing PVC (PersistentVolumeClaim) If the provisioner
- or an external controller can support the specified
- data source, it will create a new volume based on the
- contents of the specified data source. When the AnyVolumeDataSource
- feature gate is enabled, dataSource contents will be
- copied to dataSourceRef, and dataSourceRef contents
- will be copied to dataSource when dataSourceRef.namespace
- is not specified. If the namespace is specified, then
- dataSourceRef will not be copied to dataSource.'
+ description: 'dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.'
properties:
apiGroup:
- description: APIGroup is the group for the resource
- being referenced. If APIGroup is not specified,
- the specified Kind must be in the core API group.
- For any other third-party types, APIGroup is required.
+ description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
type: string
kind:
description: Kind is the type of resource being referenced
@@ -6366,40 +4213,10 @@ spec:
type: object
x-kubernetes-map-type: atomic
dataSourceRef:
- description: 'dataSourceRef specifies the object from
- which to populate the volume with data, if a non-empty
- volume is desired. This may be any object from a non-empty
- API group (non core object) or a PersistentVolumeClaim
- object. When this field is specified, volume binding
- will only succeed if the type of the specified object
- matches some installed volume populator or dynamic provisioner.
- This field will replace the functionality of the dataSource
- field and as such if both fields are non-empty, they
- must have the same value. For backwards compatibility,
- when namespace isn''t specified in dataSourceRef, both
- fields (dataSource and dataSourceRef) will be set to
- the same value automatically if one of them is empty
- and the other is non-empty. When namespace is specified
- in dataSourceRef, dataSource isn''t set to the same
- value and must be empty. There are three important differences
- between dataSource and dataSourceRef: * While dataSource
- only allows two specific types of objects, dataSourceRef
- allows any non-core object, as well as PersistentVolumeClaim
- objects. * While dataSource ignores disallowed values
- (dropping them), dataSourceRef preserves all values,
- and generates an error if a disallowed value is specified.
- * While dataSource only allows local objects, dataSourceRef
- allows objects in any namespaces. (Beta) Using this
- field requires the AnyVolumeDataSource feature gate
- to be enabled. (Alpha) Using the namespace field of
- dataSourceRef requires the CrossNamespaceVolumeDataSource
- feature gate to be enabled.'
+ description: 'dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn''t specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn''t set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.'
properties:
apiGroup:
- description: APIGroup is the group for the resource
- being referenced. If APIGroup is not specified,
- the specified Kind must be in the core API group.
- For any other third-party types, APIGroup is required.
+ description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
type: string
kind:
description: Kind is the type of resource being referenced
@@ -6408,42 +4225,22 @@ spec:
description: Name is the name of resource being referenced
type: string
namespace:
- description: Namespace is the namespace of resource
- being referenced Note that when a namespace is specified,
- a gateway.networking.k8s.io/ReferenceGrant object
- is required in the referent namespace to allow that
- namespace's owner to accept the reference. See the
- ReferenceGrant documentation for details. (Alpha)
- This field requires the CrossNamespaceVolumeDataSource
- feature gate to be enabled.
+ description: Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
type: string
required:
- kind
- name
type: object
resources:
- description: 'resources represents the minimum resources
- the volume should have. If RecoverVolumeExpansionFailure
- feature is enabled users are allowed to specify resource
- requirements that are lower than previous value but
- must still be higher than capacity recorded in the status
- field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
+ description: 'resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
properties:
claims:
- description: "Claims lists the names of resources,
- defined in spec.resourceClaims, that are used by
- this container. \n This is an alpha field and requires
- enabling the DynamicResourceAllocation feature gate.
- \n This field is immutable."
+ description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable."
items:
- description: ResourceClaim references one entry
- in PodSpec.ResourceClaims.
+ description: ResourceClaim references one entry in PodSpec.ResourceClaims.
properties:
name:
- description: Name must match the name of one
- entry in pod.spec.resourceClaims of the Pod
- where this field is used. It makes that resource
- available inside a container.
+ description: Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
type: string
required:
- name
@@ -6459,8 +4256,7 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount
- of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -6469,41 +4265,25 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Requests describes the minimum amount
- of compute resources required. If Requests is omitted
- for a container, it defaults to Limits if that is
- explicitly specified, otherwise to an implementation-defined
- value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
selector:
- description: selector is a label query over volumes to
- consider for binding.
+ description: selector is a label query over volumes to consider for binding.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector
- requirements. The requirements are ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a selector
- that contains values, a key, and an operator that
- relates the key and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the selector
- applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship
- to a set of values. Valid operators are In,
- NotIn, Exists and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string values.
- If the operator is In or NotIn, the values
- array must be non-empty. If the operator is
- Exists or DoesNotExist, the values array must
- be empty. This array is replaced during a
- strategic merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -6515,35 +4295,25 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value} pairs.
- A single {key,value} in the matchLabels map is equivalent
- to an element of matchExpressions, whose key field
- is "key", the operator is "In", and the values array
- contains only "value". The requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
storageClassName:
- description: 'storageClassName is the name of the StorageClass
- required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
+ description: 'storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
type: string
volumeMode:
- description: volumeMode defines what type of volume is
- required by the claim. Value of Filesystem is implied
- when not included in claim spec.
+ description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
type: string
volumeName:
- description: volumeName is the binding reference to the
- PersistentVolume backing this claim.
+ description: volumeName is the binding reference to the PersistentVolume backing this claim.
type: string
type: object
status:
- description: 'Status represents the current information/status
- of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
+ description: 'Status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
properties:
accessModes:
- description: 'accessModes contains the actual access modes
- the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
+ description: 'accessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
items:
type: string
type: array
@@ -6554,19 +4324,7 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: allocatedResources is the storage resource
- within AllocatedResources tracks the capacity allocated
- to a PVC. It may be larger than the actual capacity
- when a volume expansion operation is requested. For
- storage quota, the larger value from allocatedResources
- and PVC.spec.resources is used. If allocatedResources
- is not set, PVC.spec.resources alone is used for quota
- calculation. If a volume expansion capacity request
- is lowered, allocatedResources is only lowered if there
- are no expansion operations in progress and if the actual
- volume capacity is equal or lower than the requested
- capacity. This is an alpha field and requires enabling
- RecoverVolumeExpansionFailure feature.
+ description: allocatedResources is the storage resource within AllocatedResources tracks the capacity allocated to a PVC. It may be larger than the actual capacity when a volume expansion operation is requested. For storage quota, the larger value from allocatedResources and PVC.spec.resources is used. If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation. If a volume expansion capacity request is lowered, allocatedResources is only lowered if there are no expansion operations in progress and if the actual volume capacity is equal or lower than the requested capacity. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
type: object
capacity:
additionalProperties:
@@ -6575,43 +4333,31 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: capacity represents the actual resources
- of the underlying volume.
+ description: capacity represents the actual resources of the underlying volume.
type: object
conditions:
- description: conditions is the current Condition of persistent
- volume claim. If underlying persistent volume is being
- resized then the Condition will be set to 'ResizeStarted'.
+ description: conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'.
items:
- description: PersistentVolumeClaimCondition contails
- details about state of pvc
+ description: PersistentVolumeClaimCondition contails details about state of pvc
properties:
lastProbeTime:
- description: lastProbeTime is the time we probed
- the condition.
+ description: lastProbeTime is the time we probed the condition.
format: date-time
type: string
lastTransitionTime:
- description: lastTransitionTime is the time the
- condition transitioned from one status to another.
+ description: lastTransitionTime is the time the condition transitioned from one status to another.
format: date-time
type: string
message:
- description: message is the human-readable message
- indicating details about last transition.
+ description: message is the human-readable message indicating details about last transition.
type: string
reason:
- description: reason is a unique, this should be
- a short, machine understandable string that gives
- the reason for condition's last transition. If
- it reports "ResizeStarted" that means the underlying
- persistent volume is being resized.
+ description: reason is a unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "ResizeStarted" that means the underlying persistent volume is being resized.
type: string
status:
type: string
type:
- description: PersistentVolumeClaimConditionType
- is a valid value of PersistentVolumeClaimCondition.Type
+ description: PersistentVolumeClaimConditionType is a valid value of PersistentVolumeClaimCondition.Type
type: string
required:
- status
@@ -6622,35 +4368,19 @@ spec:
description: phase represents the current phase of PersistentVolumeClaim.
type: string
resizeStatus:
- description: resizeStatus stores status of resize operation.
- ResizeStatus is not set by default but when expansion
- is complete resizeStatus is set to empty string by resize
- controller or kubelet. This is an alpha field and requires
- enabling RecoverVolumeExpansionFailure feature.
+ description: resizeStatus stores status of resize operation. ResizeStatus is not set by default but when expansion is complete resizeStatus is set to empty string by resize controller or kubelet. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
type: string
type: object
type: object
type: object
tag:
- description: 'Tag of Prometheus container image to be deployed. Defaults
- to the value of `version`. Version is ignored if Tag is set. Deprecated:
- use ''image'' instead. The image tag can be specified as part of
- the image URL.'
+ description: 'Tag of Prometheus container image to be deployed. Defaults to the value of `version`. Version is ignored if Tag is set. Deprecated: use ''image'' instead. The image tag can be specified as part of the image URL.'
type: string
thanos:
- description: "Thanos configuration allows configuring various aspects
- of a Prometheus server in a Thanos environment. \n This section
- is experimental, it may change significantly without deprecation
- notice in any release."
+ description: "Thanos configuration allows configuring various aspects of a Prometheus server in a Thanos environment. \n This section is experimental, it may change significantly without deprecation notice in any release."
properties:
additionalArgs:
- description: AdditionalArgs allows setting additional arguments
- for the Thanos container. The arguments are passed as-is to
- the Thanos container which may cause issues if they are invalid
- or not supported the given Thanos version. In case of an argument
- conflict (e.g. an argument which is already set by the operator
- itself) or when providing an invalid argument the reconciliation
- will fail and an error will be logged.
+ description: AdditionalArgs allows setting additional arguments for the Thanos container. The arguments are passed as-is to the Thanos container which may cause issues if they are invalid or not supported the given Thanos version. In case of an argument conflict (e.g. an argument which is already set by the operator itself) or when providing an invalid argument the reconciliation will fail and an error will be logged.
items:
description: Argument as part of the AdditionalArgs list.
properties:
@@ -6659,59 +4389,40 @@ spec:
minLength: 1
type: string
value:
- description: Argument value, e.g. 30s. Can be empty for
- name-only arguments (e.g. --storage.tsdb.no-lockfile)
+ description: Argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile)
type: string
required:
- name
type: object
type: array
baseImage:
- description: 'Thanos base image if other than default. Deprecated:
- use ''image'' instead'
+ description: 'Thanos base image if other than default. Deprecated: use ''image'' instead'
type: string
blockSize:
default: 2h
- description: 'BlockDuration controls the size of TSDB blocks produced
- by Prometheus. Default is 2h to match the upstream Prometheus
- defaults. WARNING: Changing the block duration can impact the
- performance and efficiency of the entire Prometheus/Thanos stack
- due to how it interacts with memory and Thanos compactors. It
- is recommended to keep this value set to a multiple of 120 times
- your longest scrape or rule interval. For example, 30s * 120
- = 1h.'
+ description: 'BlockDuration controls the size of TSDB blocks produced by Prometheus. Default is 2h to match the upstream Prometheus defaults. WARNING: Changing the block duration can impact the performance and efficiency of the entire Prometheus/Thanos stack due to how it interacts with memory and Thanos compactors. It is recommended to keep this value set to a multiple of 120 times your longest scrape or rule interval. For example, 30s * 120 = 1h.'
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
grpcListenLocal:
- description: If true, the Thanos sidecar listens on the loopback
- interface for the gRPC endpoints. It has no effect if `listenLocal`
- is true.
+ description: If true, the Thanos sidecar listens on the loopback interface for the gRPC endpoints. It has no effect if `listenLocal` is true.
type: boolean
grpcServerTlsConfig:
- description: 'GRPCServerTLSConfig configures the TLS parameters
- for the gRPC server providing the StoreAPI. Note: Currently
- only the CAFile, CertFile, and KeyFile fields are supported.
- Maps to the ''--grpc-server-tls-*'' CLI args.'
+ description: 'GRPCServerTLSConfig configures the TLS parameters for the gRPC server providing the StoreAPI. Note: Currently only the CAFile, CertFile, and KeyFile fields are supported. Maps to the ''--grpc-server-tls-*'' CLI args.'
properties:
ca:
- description: Certificate authority used when verifying server
- certificates.
+ description: Certificate authority used when verifying server certificates.
properties:
configMap:
- description: ConfigMap containing data to use for the
- targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its
- key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
@@ -6721,17 +4432,13 @@ spec:
description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -6739,27 +4446,22 @@ spec:
x-kubernetes-map-type: atomic
type: object
caFile:
- description: Path to the CA cert in the Prometheus container
- to use for the targets.
+ description: Path to the CA cert in the Prometheus container to use for the targets.
type: string
cert:
description: Client certificate to present when doing client-authentication.
properties:
configMap:
- description: ConfigMap containing data to use for the
- targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its
- key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
@@ -6769,17 +4471,13 @@ spec:
description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -6787,31 +4485,25 @@ spec:
x-kubernetes-map-type: atomic
type: object
certFile:
- description: Path to the client cert file in the Prometheus
- container for the targets.
+ description: Path to the client cert file in the Prometheus container for the targets.
type: string
insecureSkipVerify:
description: Disable target certificate validation.
type: boolean
keyFile:
- description: Path to the client key file in the Prometheus
- container for the targets.
+ description: Path to the client key file in the Prometheus container for the targets.
type: string
keySecret:
- description: Secret containing the client key file for the
- targets.
+ description: Secret containing the client key file for the targets.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -6822,21 +4514,13 @@ spec:
type: string
type: object
httpListenLocal:
- description: If true, the Thanos sidecar listens on the loopback
- interface for the HTTP endpoints. It has no effect if `listenLocal`
- is true.
+ description: If true, the Thanos sidecar listens on the loopback interface for the HTTP endpoints. It has no effect if `listenLocal` is true.
type: boolean
image:
- description: Image if specified has precedence over baseImage,
- tag and sha combinations. Specifying the version is still necessary
- to ensure the Prometheus Operator knows what version of Thanos
- is being configured.
+ description: Image if specified has precedence over baseImage, tag and sha combinations. Specifying the version is still necessary to ensure the Prometheus Operator knows what version of Thanos is being configured.
type: string
listenLocal:
- description: 'If true, the Thanos sidecar listens on the loopback
- interface for the HTTP and gRPC endpoints. It takes precedence
- over `grpcListenLocal` and `httpListenLocal`. Deprecated: use
- `grpcListenLocal` and `httpListenLocal` instead.'
+ description: 'If true, the Thanos sidecar listens on the loopback interface for the HTTP and gRPC endpoints. It takes precedence over `grpcListenLocal` and `httpListenLocal`. Deprecated: use `grpcListenLocal` and `httpListenLocal` instead.'
type: boolean
logFormat:
description: LogFormat for Thanos sidecar to be configured with.
@@ -6855,60 +4539,41 @@ spec:
- error
type: string
minTime:
- description: MinTime for Thanos sidecar to be configured with.
- Option can be a constant time in RFC3339 format or time duration
- relative to current time, such as -1d or 2h45m. Valid duration
- units are ms, s, m, h, d, w, y.
+ description: MinTime for Thanos sidecar to be configured with. Option can be a constant time in RFC3339 format or time duration relative to current time, such as -1d or 2h45m. Valid duration units are ms, s, m, h, d, w, y.
type: string
objectStorageConfig:
- description: ObjectStorageConfig configures object storage in
- Thanos. Alternative to ObjectStorageConfigFile, and lower order
- priority.
+ description: ObjectStorageConfig configures object storage in Thanos. Alternative to ObjectStorageConfigFile, and lower order priority.
properties:
key:
- description: The key of the secret to select from. Must be
- a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be
- defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
objectStorageConfigFile:
- description: ObjectStorageConfigFile specifies the path of the
- object storage configuration file. When used alongside with
- ObjectStorageConfig, ObjectStorageConfigFile takes precedence.
+ description: ObjectStorageConfigFile specifies the path of the object storage configuration file. When used alongside with ObjectStorageConfig, ObjectStorageConfigFile takes precedence.
type: string
readyTimeout:
- description: ReadyTimeout is the maximum time Thanos sidecar will
- wait for Prometheus to start. Eg 10m
+ description: ReadyTimeout is the maximum time Thanos sidecar will wait for Prometheus to start. Eg 10m
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
resources:
- description: Resources defines the resource requirements for the
- Thanos sidecar. If not provided, no requests/limits will be
- set
+ description: Resources defines the resource requirements for the Thanos sidecar. If not provided, no requests/limits will be set
properties:
claims:
- description: "Claims lists the names of resources, defined
- in spec.resourceClaims, that are used by this container.
- \n This is an alpha field and requires enabling the DynamicResourceAllocation
- feature gate. \n This field is immutable."
+ description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable."
items:
description: ResourceClaim references one entry in PodSpec.ResourceClaims.
properties:
name:
- description: Name must match the name of one entry in
- pod.spec.resourceClaims of the Pod where this field
- is used. It makes that resource available inside a
- container.
+ description: Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
type: string
required:
- name
@@ -6924,8 +4589,7 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute
- resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -6934,91 +4598,59 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Requests describes the minimum amount of compute
- resources required. If Requests is omitted for a container,
- it defaults to Limits if that is explicitly specified, otherwise
- to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
sha:
- description: 'SHA of Thanos container image to be deployed. Defaults
- to the value of `version`. Similar to a tag, but the SHA explicitly
- deploys an immutable container image. Version and Tag are ignored
- if SHA is set. Deprecated: use ''image'' instead. The image
- digest can be specified as part of the image URL.'
+ description: 'SHA of Thanos container image to be deployed. Defaults to the value of `version`. Similar to a tag, but the SHA explicitly deploys an immutable container image. Version and Tag are ignored if SHA is set. Deprecated: use ''image'' instead. The image digest can be specified as part of the image URL.'
type: string
tag:
- description: 'Tag of Thanos sidecar container image to be deployed.
- Defaults to the value of `version`. Version is ignored if Tag
- is set. Deprecated: use ''image'' instead. The image tag can
- be specified as part of the image URL.'
+ description: 'Tag of Thanos sidecar container image to be deployed. Defaults to the value of `version`. Version is ignored if Tag is set. Deprecated: use ''image'' instead. The image tag can be specified as part of the image URL.'
type: string
tracingConfig:
- description: TracingConfig configures tracing in Thanos. This
- is an experimental feature, it may change in any upcoming release
- in a breaking way.
+ description: TracingConfig configures tracing in Thanos. This is an experimental feature, it may change in any upcoming release in a breaking way.
properties:
key:
- description: The key of the secret to select from. Must be
- a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be
- defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
tracingConfigFile:
- description: TracingConfig specifies the path of the tracing configuration
- file. When used alongside with TracingConfig, TracingConfigFile
- takes precedence.
+ description: TracingConfig specifies the path of the tracing configuration file. When used alongside with TracingConfig, TracingConfigFile takes precedence.
type: string
version:
description: Version describes the version of Thanos to use.
type: string
volumeMounts:
- description: VolumeMounts allows configuration of additional VolumeMounts
- on the output StatefulSet definition. VolumeMounts specified
- will be appended to other VolumeMounts in the thanos-sidecar
- container.
+ description: VolumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition. VolumeMounts specified will be appended to other VolumeMounts in the thanos-sidecar container.
items:
- description: VolumeMount describes a mounting of a Volume within
- a container.
+ description: VolumeMount describes a mounting of a Volume within a container.
properties:
mountPath:
- description: Path within the container at which the volume
- should be mounted. Must not contain ':'.
+ description: Path within the container at which the volume should be mounted. Must not contain ':'.
type: string
mountPropagation:
- description: mountPropagation determines how mounts are
- propagated from the host to container and the other way
- around. When not set, MountPropagationNone is used. This
- field is beta in 1.10.
+ description: mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.
type: string
name:
description: This must match the Name of a Volume.
type: string
readOnly:
- description: Mounted read-only if true, read-write otherwise
- (false or unspecified). Defaults to false.
+ description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
type: boolean
subPath:
- description: Path within the volume from which the container's
- volume should be mounted. Defaults to "" (volume's root).
+ description: Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
type: string
subPathExpr:
- description: Expanded path within the volume from which
- the container's volume should be mounted. Behaves similarly
- to SubPath but environment variable references $(VAR_NAME)
- are expanded using the container's environment. Defaults
- to "" (volume's root). SubPathExpr and SubPath are mutually
- exclusive.
+ description: Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.
type: string
required:
- mountPath
@@ -7029,77 +4661,47 @@ spec:
tolerations:
description: If specified, the pod's tolerations.
items:
- description: The pod this Toleration is attached to tolerates any
- taint that matches the triple <key,value,effect> using the matching
- operator <operator>.
+ description: The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
properties:
effect:
- description: Effect indicates the taint effect to match. Empty
- means match all taint effects. When specified, allowed values
- are NoSchedule, PreferNoSchedule and NoExecute.
+ description: Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
type: string
key:
- description: Key is the taint key that the toleration applies
- to. Empty means match all taint keys. If the key is empty,
- operator must be Exists; this combination means to match all
- values and all keys.
+ description: Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
type: string
operator:
- description: Operator represents a key's relationship to the
- value. Valid operators are Exists and Equal. Defaults to Equal.
- Exists is equivalent to wildcard for value, so that a pod
- can tolerate all taints of a particular category.
+ description: Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
type: string
tolerationSeconds:
- description: TolerationSeconds represents the period of time
- the toleration (which must be of effect NoExecute, otherwise
- this field is ignored) tolerates the taint. By default, it
- is not set, which means tolerate the taint forever (do not
- evict). Zero and negative values will be treated as 0 (evict
- immediately) by the system.
+ description: TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
format: int64
type: integer
value:
- description: Value is the taint value the toleration matches
- to. If the operator is Exists, the value should be empty,
- otherwise just a regular string.
+ description: Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
type: string
type: object
type: array
topologySpreadConstraints:
description: If specified, the pod's topology spread constraints.
items:
- description: TopologySpreadConstraint specifies how to spread matching
- pods among the given topology.
+ description: TopologySpreadConstraint specifies how to spread matching pods among the given topology.
properties:
labelSelector:
- description: LabelSelector is used to find matching pods. Pods
- that match this label selector are counted to determine the
- number of pods in their corresponding topology domain.
+ description: LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector
- requirements. The requirements are ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a selector
- that contains values, a key, and an operator that relates
- the key and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the selector
- applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship
- to a set of values. Valid operators are In, NotIn,
- Exists and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string values.
- If the operator is In or NotIn, the values array
- must be non-empty. If the operator is Exists or
- DoesNotExist, the values array must be empty. This
- array is replaced during a strategic merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -7111,122 +4713,35 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value} pairs.
- A single {key,value} in the matchLabels map is equivalent
- to an element of matchExpressions, whose key field is
- "key", the operator is "In", and the values array contains
- only "value". The requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
matchLabelKeys:
- description: MatchLabelKeys is a set of pod label keys to select
- the pods over which spreading will be calculated. The keys
- are used to lookup values from the incoming pod labels, those
- key-value labels are ANDed with labelSelector to select the
- group of existing pods over which spreading will be calculated
- for the incoming pod. Keys that don't exist in the incoming
- pod labels will be ignored. A null or empty list means only
- match against labelSelector.
+ description: MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated. The keys are used to lookup values from the incoming pod labels, those key-value labels are ANDed with labelSelector to select the group of existing pods over which spreading will be calculated for the incoming pod. Keys that don't exist in the incoming pod labels will be ignored. A null or empty list means only match against labelSelector.
items:
type: string
type: array
x-kubernetes-list-type: atomic
maxSkew:
- description: 'MaxSkew describes the degree to which pods may
- be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`,
- it is the maximum permitted difference between the number
- of matching pods in the target topology and the global minimum.
- The global minimum is the minimum number of matching pods
- in an eligible domain or zero if the number of eligible domains
- is less than MinDomains. For example, in a 3-zone cluster,
- MaxSkew is set to 1, and pods with the same labelSelector
- spread as 2/2/1: In this case, the global minimum is 1. |
- zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew
- is 1, incoming pod can only be scheduled to zone3 to become
- 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1)
- on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming
- pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`,
- it is used to give higher precedence to topologies that satisfy
- it. It''s a required field. Default value is 1 and 0 is not
- allowed.'
+ description: 'MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It''s a required field. Default value is 1 and 0 is not allowed.'
format: int32
type: integer
minDomains:
- description: "MinDomains indicates a minimum number of eligible
- domains. When the number of eligible domains with matching
- topology keys is less than minDomains, Pod Topology Spread
- treats \"global minimum\" as 0, and then the calculation of
- Skew is performed. And when the number of eligible domains
- with matching topology keys equals or greater than minDomains,
- this value has no effect on scheduling. As a result, when
- the number of eligible domains is less than minDomains, scheduler
- won't schedule more than maxSkew Pods to those domains. If
- value is nil, the constraint behaves as if MinDomains is equal
- to 1. Valid values are integers greater than 0. When value
- is not nil, WhenUnsatisfiable must be DoNotSchedule. \n For
- example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains
- is set to 5 and pods with the same labelSelector spread as
- 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P |
- The number of domains is less than 5(MinDomains), so \"global
- minimum\" is treated as 0. In this situation, new pod with
- the same labelSelector cannot be scheduled, because computed
- skew will be 3(3 - 0) if new Pod is scheduled to any of the
- three zones, it will violate MaxSkew. \n This is a beta field
- and requires the MinDomainsInPodTopologySpread feature gate
- to be enabled (enabled by default)."
+ description: "MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats \"global minimum\" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule. \n For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so \"global minimum\" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew. \n This is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default)."
format: int32
type: integer
nodeAffinityPolicy:
- description: "NodeAffinityPolicy indicates how we will treat
- Pod's nodeAffinity/nodeSelector when calculating pod topology
- spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector
- are included in the calculations. - Ignore: nodeAffinity/nodeSelector
- are ignored. All nodes are included in the calculations. \n
- If this value is nil, the behavior is equivalent to the Honor
- policy. This is a beta-level feature default enabled by the
- NodeInclusionPolicyInPodTopologySpread feature flag."
+ description: "NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations. \n If this value is nil, the behavior is equivalent to the Honor policy. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag."
type: string
nodeTaintsPolicy:
- description: "NodeTaintsPolicy indicates how we will treat node
- taints when calculating pod topology spread skew. Options
- are: - Honor: nodes without taints, along with tainted nodes
- for which the incoming pod has a toleration, are included.
- - Ignore: node taints are ignored. All nodes are included.
- \n If this value is nil, the behavior is equivalent to the
- Ignore policy. This is a beta-level feature default enabled
- by the NodeInclusionPolicyInPodTopologySpread feature flag."
+ description: "NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included. \n If this value is nil, the behavior is equivalent to the Ignore policy. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag."
type: string
topologyKey:
- description: TopologyKey is the key of node labels. Nodes that
- have a label with this key and identical values are considered
- to be in the same topology. We consider each <key, value>
- as a "bucket", and try to put balanced number of pods into
- each bucket. We define a domain as a particular instance of
- a topology. Also, we define an eligible domain as a domain
- whose nodes meet the requirements of nodeAffinityPolicy and
- nodeTaintsPolicy. e.g. If TopologyKey is "kubernetes.io/hostname",
- each Node is a domain of that topology. And, if TopologyKey
- is "topology.kubernetes.io/zone", each zone is a domain of
- that topology. It's a required field.
+ description: TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a "bucket", and try to put balanced number of pods into each bucket. We define a domain as a particular instance of a topology. Also, we define an eligible domain as a domain whose nodes meet the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. It's a required field.
type: string
whenUnsatisfiable:
- description: 'WhenUnsatisfiable indicates how to deal with a
- pod if it doesn''t satisfy the spread constraint. - DoNotSchedule
- (default) tells the scheduler not to schedule it. - ScheduleAnyway
- tells the scheduler to schedule the pod in any location, but
- giving higher precedence to topologies that would help reduce
- the skew. A constraint is considered "Unsatisfiable" for an
- incoming pod if and only if every possible node assignment
- for that pod would violate "MaxSkew" on some topology. For
- example, in a 3-zone cluster, MaxSkew is set to 1, and pods
- with the same labelSelector spread as 3/1/1: | zone1 | zone2
- | zone3 | | P P P | P | P | If WhenUnsatisfiable is
- set to DoNotSchedule, incoming pod can only be scheduled to
- zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on
- zone2(zone3) satisfies MaxSkew(1). In other words, the cluster
- can still be imbalanced, but scheduler won''t make it *more*
- imbalanced. It''s a required field.'
+ description: 'WhenUnsatisfiable indicates how to deal with a pod if it doesn''t satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won''t make it *more* imbalanced. It''s a required field.'
type: string
required:
- maxSkew
@@ -7235,16 +4750,10 @@ spec:
type: object
type: array
tsdb:
- description: Defines the runtime reloadable configuration of the timeseries
- database (TSDB).
+ description: Defines the runtime reloadable configuration of the timeseries database (TSDB).
properties:
outOfOrderTimeWindow:
- description: Configures how old an out-of-order/out-of-bounds
- sample can be w.r.t. the TSDB max time. An out-of-order/out-of-bounds
- sample is ingested into the TSDB as long as the timestamp of
- the sample is >= (TSDB.MaxTime - outOfOrderTimeWindow). Out
- of order ingestion is an experimental feature and requires Prometheus
- >= v2.39.0.
+ description: Configures how old an out-of-order/out-of-bounds sample can be w.r.t. the TSDB max time. An out-of-order/out-of-bounds sample is ingested into the TSDB as long as the timestamp of the sample is >= (TSDB.MaxTime - outOfOrderTimeWindow). Out of order ingestion is an experimental feature and requires Prometheus >= v2.39.0.
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
type: object
@@ -7252,41 +4761,27 @@ spec:
description: Version of Prometheus to be deployed.
type: string
volumeMounts:
- description: VolumeMounts allows configuration of additional VolumeMounts
- on the output StatefulSet definition. VolumeMounts specified will
- be appended to other VolumeMounts in the prometheus container, that
- are generated as a result of StorageSpec objects.
+ description: VolumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition. VolumeMounts specified will be appended to other VolumeMounts in the prometheus container, that are generated as a result of StorageSpec objects.
items:
- description: VolumeMount describes a mounting of a Volume within
- a container.
+ description: VolumeMount describes a mounting of a Volume within a container.
properties:
mountPath:
- description: Path within the container at which the volume should
- be mounted. Must not contain ':'.
+ description: Path within the container at which the volume should be mounted. Must not contain ':'.
type: string
mountPropagation:
- description: mountPropagation determines how mounts are propagated
- from the host to container and the other way around. When
- not set, MountPropagationNone is used. This field is beta
- in 1.10.
+ description: mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.
type: string
name:
description: This must match the Name of a Volume.
type: string
readOnly:
- description: Mounted read-only if true, read-write otherwise
- (false or unspecified). Defaults to false.
+ description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
type: boolean
subPath:
- description: Path within the volume from which the container's
- volume should be mounted. Defaults to "" (volume's root).
+ description: Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
type: string
subPathExpr:
- description: Expanded path within the volume from which the
- container's volume should be mounted. Behaves similarly to
- SubPath but environment variable references $(VAR_NAME) are
- expanded using the container's environment. Defaults to ""
- (volume's root). SubPathExpr and SubPath are mutually exclusive.
+ description: Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.
type: string
required:
- mountPath
@@ -7294,93 +4789,62 @@ spec:
type: object
type: array
volumes:
- description: Volumes allows configuration of additional volumes on
- the output StatefulSet definition. Volumes specified will be appended
- to other volumes that are generated as a result of StorageSpec objects.
+ description: Volumes allows configuration of additional volumes on the output StatefulSet definition. Volumes specified will be appended to other volumes that are generated as a result of StorageSpec objects.
items:
- description: Volume represents a named volume in a pod that may
- be accessed by any container in the pod.
+ description: Volume represents a named volume in a pod that may be accessed by any container in the pod.
properties:
awsElasticBlockStore:
- description: 'awsElasticBlockStore represents an AWS Disk resource
- that is attached to a kubelet''s host machine and then exposed
- to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
+ description: 'awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet''s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
properties:
fsType:
- description: 'fsType is the filesystem type of the volume
- that you want to mount. Tip: Ensure that the filesystem
- type is supported by the host operating system. Examples:
- "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4"
- if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
- TODO: how do we prevent errors in the filesystem from
- compromising the machine'
+ description: 'fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine'
type: string
partition:
- description: 'partition is the partition in the volume that
- you want to mount. If omitted, the default is to mount
- by volume name. Examples: For volume /dev/sda1, you specify
- the partition as "1". Similarly, the volume partition
- for /dev/sda is "0" (or you can leave the property empty).'
+ description: 'partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).'
format: int32
type: integer
readOnly:
- description: 'readOnly value true will force the readOnly
- setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
+ description: 'readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
type: boolean
volumeID:
- description: 'volumeID is unique ID of the persistent disk
- resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
+ description: 'volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
type: string
required:
- volumeID
type: object
azureDisk:
- description: azureDisk represents an Azure Data Disk mount on
- the host and bind mount to the pod.
+ description: azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
properties:
cachingMode:
- description: 'cachingMode is the Host Caching mode: None,
- Read Only, Read Write.'
+ description: 'cachingMode is the Host Caching mode: None, Read Only, Read Write.'
type: string
diskName:
- description: diskName is the Name of the data disk in the
- blob storage
+ description: diskName is the Name of the data disk in the blob storage
type: string
diskURI:
- description: diskURI is the URI of data disk in the blob
- storage
+ description: diskURI is the URI of data disk in the blob storage
type: string
fsType:
- description: fsType is Filesystem type to mount. Must be
- a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4"
- if unspecified.
+ description: fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
type: string
kind:
- description: 'kind expected values are Shared: multiple
- blob disks per storage account Dedicated: single blob
- disk per storage account Managed: azure managed data
- disk (only in managed availability set). defaults to shared'
+ description: 'kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared'
type: string
readOnly:
- description: readOnly Defaults to false (read/write). ReadOnly
- here will force the ReadOnly setting in VolumeMounts.
+ description: readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
type: boolean
required:
- diskName
- diskURI
type: object
azureFile:
- description: azureFile represents an Azure File Service mount
- on the host and bind mount to the pod.
+ description: azureFile represents an Azure File Service mount on the host and bind mount to the pod.
properties:
readOnly:
- description: readOnly defaults to false (read/write). ReadOnly
- here will force the ReadOnly setting in VolumeMounts.
+ description: readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
type: boolean
secretName:
- description: secretName is the name of secret that contains
- Azure Storage Account Name and Key
+ description: secretName is the name of secret that contains Azure Storage Account Name and Key
type: string
shareName:
description: shareName is the azure share Name
@@ -7390,105 +4854,68 @@ spec:
- shareName
type: object
cephfs:
- description: cephFS represents a Ceph FS mount on the host that
- shares a pod's lifetime
+ description: cephFS represents a Ceph FS mount on the host that shares a pod's lifetime
properties:
monitors:
- description: 'monitors is Required: Monitors is a collection
- of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
+ description: 'monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
items:
type: string
type: array
path:
- description: 'path is Optional: Used as the mounted root,
- rather than the full Ceph tree, default is /'
+ description: 'path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /'
type: string
readOnly:
- description: 'readOnly is Optional: Defaults to false (read/write).
- ReadOnly here will force the ReadOnly setting in VolumeMounts.
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
+ description: 'readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
type: boolean
secretFile:
- description: 'secretFile is Optional: SecretFile is the
- path to key ring for User, default is /etc/ceph/user.secret
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
+ description: 'secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
type: string
secretRef:
- description: 'secretRef is Optional: SecretRef is reference
- to the authentication secret for User, default is empty.
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
+ description: 'secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
x-kubernetes-map-type: atomic
user:
- description: 'user is optional: User is the rados user name,
- default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
+ description: 'user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
type: string
required:
- monitors
type: object
cinder:
- description: 'cinder represents a cinder volume attached and
- mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
+ description: 'cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
properties:
fsType:
- description: 'fsType is the filesystem type to mount. Must
- be a filesystem type supported by the host operating system.
- Examples: "ext4", "xfs", "ntfs". Implicitly inferred to
- be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
+ description: 'fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
type: string
readOnly:
- description: 'readOnly defaults to false (read/write). ReadOnly
- here will force the ReadOnly setting in VolumeMounts.
- More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
+ description: 'readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
type: boolean
secretRef:
- description: 'secretRef is optional: points to a secret
- object containing parameters used to connect to OpenStack.'
+ description: 'secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
x-kubernetes-map-type: atomic
volumeID:
- description: 'volumeID used to identify the volume in cinder.
- More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
+ description: 'volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
type: string
required:
- volumeID
type: object
configMap:
- description: configMap represents a configMap that should populate
- this volume
+ description: configMap represents a configMap that should populate this volume
properties:
defaultMode:
- description: 'defaultMode is optional: mode bits used to
- set permissions on created files by default. Must be an
- octal value between 0000 and 0777 or a decimal value between
- 0 and 511. YAML accepts both octal and decimal values,
- JSON requires decimal values for mode bits. Defaults to
- 0644. Directories within the path are not affected by
- this setting. This might be in conflict with other options
- that affect the file mode, like fsGroup, and the result
- can be other mode bits set.'
+ description: 'defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
format: int32
type: integer
items:
- description: items if unspecified, each key-value pair in
- the Data field of the referenced ConfigMap will be projected
- into the volume as a file whose name is the key and content
- is the value. If specified, the listed keys will be projected
- into the specified paths, and unlisted keys will not be
- present. If a key is specified which is not present in
- the ConfigMap, the volume setup will error unless it is
- marked optional. Paths must be relative and may not contain
- the '..' path or start with '..'.
+ description: items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
items:
description: Maps a string key to a path within a volume.
properties:
@@ -7496,22 +4923,11 @@ spec:
description: key is the key to project.
type: string
mode:
- description: 'mode is Optional: mode bits used to
- set permissions on this file. Must be an octal value
- between 0000 and 0777 or a decimal value between
- 0 and 511. YAML accepts both octal and decimal values,
- JSON requires decimal values for mode bits. If not
- specified, the volume defaultMode will be used.
- This might be in conflict with other options that
- affect the file mode, like fsGroup, and the result
- can be other mode bits set.'
+ description: 'mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
format: int32
type: integer
path:
- description: path is the relative path of the file
- to map the key to. May not be an absolute path.
- May not contain the path element '..'. May not start
- with the string '..'.
+ description: path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
type: string
required:
- key
@@ -7519,135 +4935,84 @@ spec:
type: object
type: array
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: optional specify whether the ConfigMap or its
- keys must be defined
+ description: optional specify whether the ConfigMap or its keys must be defined
type: boolean
type: object
x-kubernetes-map-type: atomic
csi:
- description: csi (Container Storage Interface) represents ephemeral
- storage that is handled by certain external CSI drivers (Beta
- feature).
+ description: csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
properties:
driver:
- description: driver is the name of the CSI driver that handles
- this volume. Consult with your admin for the correct name
- as registered in the cluster.
+ description: driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.
type: string
fsType:
- description: fsType to mount. Ex. "ext4", "xfs", "ntfs".
- If not provided, the empty value is passed to the associated
- CSI driver which will determine the default filesystem
- to apply.
+ description: fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.
type: string
nodePublishSecretRef:
- description: nodePublishSecretRef is a reference to the
- secret object containing sensitive information to pass
- to the CSI driver to complete the CSI NodePublishVolume
- and NodeUnpublishVolume calls. This field is optional,
- and may be empty if no secret is required. If the secret
- object contains more than one secret, all secret references
- are passed.
+ description: nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
x-kubernetes-map-type: atomic
readOnly:
- description: readOnly specifies a read-only configuration
- for the volume. Defaults to false (read/write).
+ description: readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).
type: boolean
volumeAttributes:
additionalProperties:
type: string
- description: volumeAttributes stores driver-specific properties
- that are passed to the CSI driver. Consult your driver's
- documentation for supported values.
+ description: volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.
type: object
required:
- driver
type: object
downwardAPI:
- description: downwardAPI represents downward API about the pod
- that should populate this volume
+ description: downwardAPI represents downward API about the pod that should populate this volume
properties:
defaultMode:
- description: 'Optional: mode bits to use on created files
- by default. Must be a Optional: mode bits used to set
- permissions on created files by default. Must be an octal
- value between 0000 and 0777 or a decimal value between
- 0 and 511. YAML accepts both octal and decimal values,
- JSON requires decimal values for mode bits. Defaults to
- 0644. Directories within the path are not affected by
- this setting. This might be in conflict with other options
- that affect the file mode, like fsGroup, and the result
- can be other mode bits set.'
+ description: 'Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
format: int32
type: integer
items:
description: Items is a list of downward API volume file
items:
- description: DownwardAPIVolumeFile represents information
- to create the file containing the pod field
+ description: DownwardAPIVolumeFile represents information to create the file containing the pod field
properties:
fieldRef:
- description: 'Required: Selects a field of the pod:
- only annotations, labels, name and namespace are
- supported.'
+ description: 'Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.'
properties:
apiVersion:
- description: Version of the schema the FieldPath
- is written in terms of, defaults to "v1".
+ description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
type: string
fieldPath:
- description: Path of the field to select in the
- specified API version.
+ description: Path of the field to select in the specified API version.
type: string
required:
- fieldPath
type: object
x-kubernetes-map-type: atomic
mode:
- description: 'Optional: mode bits used to set permissions
- on this file, must be an octal value between 0000
- and 0777 or a decimal value between 0 and 511. YAML
- accepts both octal and decimal values, JSON requires
- decimal values for mode bits. If not specified,
- the volume defaultMode will be used. This might
- be in conflict with other options that affect the
- file mode, like fsGroup, and the result can be other
- mode bits set.'
+ description: 'Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
format: int32
type: integer
path:
- description: 'Required: Path is the relative path
- name of the file to be created. Must not be absolute
- or contain the ''..'' path. Must be utf-8 encoded.
- The first item of the relative path must not start
- with ''..'''
+ description: 'Required: Path is the relative path name of the file to be created. Must not be absolute or contain the ''..'' path. Must be utf-8 encoded. The first item of the relative path must not start with ''..'''
type: string
resourceFieldRef:
- description: 'Selects a resource of the container:
- only resources limits and requests (limits.cpu,
- limits.memory, requests.cpu and requests.memory)
- are currently supported.'
+ description: 'Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.'
properties:
containerName:
- description: 'Container name: required for volumes,
- optional for env vars'
+ description: 'Container name: required for volumes, optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format of the
- exposed resources, defaults to "1"
+ description: Specifies the output format of the exposed resources, defaults to "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
@@ -7663,114 +5028,47 @@ spec:
type: array
type: object
emptyDir:
- description: 'emptyDir represents a temporary directory that
- shares a pod''s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
+ description: 'emptyDir represents a temporary directory that shares a pod''s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
properties:
medium:
- description: 'medium represents what type of storage medium
- should back this directory. The default is "" which means
- to use the node''s default medium. Must be an empty string
- (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
+ description: 'medium represents what type of storage medium should back this directory. The default is "" which means to use the node''s default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
type: string
sizeLimit:
anyOf:
- type: integer
- type: string
- description: 'sizeLimit is the total amount of local storage
- required for this EmptyDir volume. The size limit is also
- applicable for memory medium. The maximum usage on memory
- medium EmptyDir would be the minimum value between the
- SizeLimit specified here and the sum of memory limits
- of all containers in a pod. The default is nil which means
- that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir'
+ description: 'sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir'
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
type: object
ephemeral:
- description: "ephemeral represents a volume that is handled
- by a cluster storage driver. The volume's lifecycle is tied
- to the pod that defines it - it will be created before the
- pod starts, and deleted when the pod is removed. \n Use this
- if: a) the volume is only needed while the pod runs, b) features
- of normal volumes like restoring from snapshot or capacity
- tracking are needed, c) the storage driver is specified through
- a storage class, and d) the storage driver supports dynamic
- volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource
- for more information on the connection between this volume
- type and PersistentVolumeClaim). \n Use PersistentVolumeClaim
- or one of the vendor-specific APIs for volumes that persist
- for longer than the lifecycle of an individual pod. \n Use
- CSI for light-weight local ephemeral volumes if the CSI driver
- is meant to be used that way - see the documentation of the
- driver for more information. \n A pod can use both types of
- ephemeral volumes and persistent volumes at the same time."
+ description: "ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. \n Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). \n Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. \n Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. \n A pod can use both types of ephemeral volumes and persistent volumes at the same time."
properties:
volumeClaimTemplate:
- description: "Will be used to create a stand-alone PVC to
- provision the volume. The pod in which this EphemeralVolumeSource
- is embedded will be the owner of the PVC, i.e. the PVC
- will be deleted together with the pod. The name of the
- PVC will be `<pod name>-<volume name>` where `<volume
- name>` is the name from the `PodSpec.Volumes` array entry.
- Pod validation will reject the pod if the concatenated
- name is not valid for a PVC (for example, too long). \n
- An existing PVC with that name that is not owned by the
- pod will *not* be used for the pod to avoid using an unrelated
- volume by mistake. Starting the pod is then blocked until
- the unrelated PVC is removed. If such a pre-created PVC
- is meant to be used by the pod, the PVC has to updated
- with an owner reference to the pod once the pod exists.
- Normally this should not be necessary, but it may be useful
- when manually reconstructing a broken cluster. \n This
- field is read-only and no changes will be made by Kubernetes
- to the PVC after it has been created. \n Required, must
- not be nil."
+ description: "Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `<pod name>-<volume name>` where `<volume name>` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). \n An existing PVC with that name that is not owned by the pod will *not* be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. \n This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. \n Required, must not be nil."
properties:
metadata:
- description: May contain labels and annotations that
- will be copied into the PVC when creating it. No other
- fields are allowed and will be rejected during validation.
+ description: May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.
type: object
spec:
- description: The specification for the PersistentVolumeClaim.
- The entire content is copied unchanged into the PVC
- that gets created from this template. The same fields
- as in a PersistentVolumeClaim are also valid here.
+ description: The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
properties:
accessModes:
- description: 'accessModes contains the desired access
- modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
+ description: 'accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
items:
type: string
type: array
dataSource:
- description: 'dataSource field can be used to specify
- either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
- * An existing PVC (PersistentVolumeClaim) If the
- provisioner or an external controller can support
- the specified data source, it will create a new
- volume based on the contents of the specified
- data source. When the AnyVolumeDataSource feature
- gate is enabled, dataSource contents will be copied
- to dataSourceRef, and dataSourceRef contents will
- be copied to dataSource when dataSourceRef.namespace
- is not specified. If the namespace is specified,
- then dataSourceRef will not be copied to dataSource.'
+ description: 'dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.'
properties:
apiGroup:
- description: APIGroup is the group for the resource
- being referenced. If APIGroup is not specified,
- the specified Kind must be in the core API
- group. For any other third-party types, APIGroup
- is required.
+ description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
type: string
kind:
- description: Kind is the type of resource being
- referenced
+ description: Kind is the type of resource being referenced
type: string
name:
- description: Name is the name of resource being
- referenced
+ description: Name is the name of resource being referenced
type: string
required:
- kind
@@ -7778,93 +5076,34 @@ spec:
type: object
x-kubernetes-map-type: atomic
dataSourceRef:
- description: 'dataSourceRef specifies the object
- from which to populate the volume with data, if
- a non-empty volume is desired. This may be any
- object from a non-empty API group (non core object)
- or a PersistentVolumeClaim object. When this field
- is specified, volume binding will only succeed
- if the type of the specified object matches some
- installed volume populator or dynamic provisioner.
- This field will replace the functionality of the
- dataSource field and as such if both fields are
- non-empty, they must have the same value. For
- backwards compatibility, when namespace isn''t
- specified in dataSourceRef, both fields (dataSource
- and dataSourceRef) will be set to the same value
- automatically if one of them is empty and the
- other is non-empty. When namespace is specified
- in dataSourceRef, dataSource isn''t set to the
- same value and must be empty. There are three
- important differences between dataSource and dataSourceRef:
- * While dataSource only allows two specific types
- of objects, dataSourceRef allows any non-core
- object, as well as PersistentVolumeClaim objects.
- * While dataSource ignores disallowed values (dropping
- them), dataSourceRef preserves all values, and
- generates an error if a disallowed value is specified.
- * While dataSource only allows local objects,
- dataSourceRef allows objects in any namespaces.
- (Beta) Using this field requires the AnyVolumeDataSource
- feature gate to be enabled. (Alpha) Using the
- namespace field of dataSourceRef requires the
- CrossNamespaceVolumeDataSource feature gate to
- be enabled.'
+ description: 'dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn''t specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn''t set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.'
properties:
apiGroup:
- description: APIGroup is the group for the resource
- being referenced. If APIGroup is not specified,
- the specified Kind must be in the core API
- group. For any other third-party types, APIGroup
- is required.
+ description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
type: string
kind:
- description: Kind is the type of resource being
- referenced
+ description: Kind is the type of resource being referenced
type: string
name:
- description: Name is the name of resource being
- referenced
+ description: Name is the name of resource being referenced
type: string
namespace:
- description: Namespace is the namespace of resource
- being referenced Note that when a namespace
- is specified, a gateway.networking.k8s.io/ReferenceGrant
- object is required in the referent namespace
- to allow that namespace's owner to accept
- the reference. See the ReferenceGrant documentation
- for details. (Alpha) This field requires the
- CrossNamespaceVolumeDataSource feature gate
- to be enabled.
+ description: Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
type: string
required:
- kind
- name
type: object
resources:
- description: 'resources represents the minimum resources
- the volume should have. If RecoverVolumeExpansionFailure
- feature is enabled users are allowed to specify
- resource requirements that are lower than previous
- value but must still be higher than capacity recorded
- in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
+ description: 'resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
properties:
claims:
- description: "Claims lists the names of resources,
- defined in spec.resourceClaims, that are used
- by this container. \n This is an alpha field
- and requires enabling the DynamicResourceAllocation
- feature gate. \n This field is immutable."
+ description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable."
items:
- description: ResourceClaim references one
- entry in PodSpec.ResourceClaims.
+ description: ResourceClaim references one entry in PodSpec.ResourceClaims.
properties:
name:
- description: Name must match the name
- of one entry in pod.spec.resourceClaims
- of the Pod where this field is used.
- It makes that resource available inside
- a container.
+ description: Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
type: string
required:
- name
@@ -7880,8 +5119,7 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount
- of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -7890,46 +5128,25 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Requests describes the minimum
- amount of compute resources required. If Requests
- is omitted for a container, it defaults to
- Limits if that is explicitly specified, otherwise
- to an implementation-defined value. More info:
- https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
selector:
- description: selector is a label query over volumes
- to consider for binding.
+ description: selector is a label query over volumes to consider for binding.
properties:
matchExpressions:
- description: matchExpressions is a list of label
- selector requirements. The requirements are
- ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement
- is a selector that contains values, a key,
- and an operator that relates the key and
- values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that
- the selector applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's
- relationship to a set of values. Valid
- operators are In, NotIn, Exists and
- DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string
- values. If the operator is In or NotIn,
- the values array must be non-empty.
- If the operator is Exists or DoesNotExist,
- the values array must be empty. This
- array is replaced during a strategic
- merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -7941,28 +5158,18 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value}
- pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions,
- whose key field is "key", the operator is
- "In", and the values array contains only "value".
- The requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
storageClassName:
- description: 'storageClassName is the name of the
- StorageClass required by the claim. More info:
- https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
+ description: 'storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
type: string
volumeMode:
- description: volumeMode defines what type of volume
- is required by the claim. Value of Filesystem
- is implied when not included in claim spec.
+ description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
type: string
volumeName:
- description: volumeName is the binding reference
- to the PersistentVolume backing this claim.
+ description: volumeName is the binding reference to the PersistentVolume backing this claim.
type: string
type: object
required:
@@ -7970,74 +5177,51 @@ spec:
type: object
type: object
fc:
- description: fc represents a Fibre Channel resource that is
- attached to a kubelet's host machine and then exposed to the
- pod.
+ description: fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
properties:
fsType:
- description: 'fsType is the filesystem type to mount. Must
- be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4"
- if unspecified. TODO: how do we prevent errors in the
- filesystem from compromising the machine'
+ description: 'fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine'
type: string
lun:
description: 'lun is Optional: FC target lun number'
format: int32
type: integer
readOnly:
- description: 'readOnly is Optional: Defaults to false (read/write).
- ReadOnly here will force the ReadOnly setting in VolumeMounts.'
+ description: 'readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.'
type: boolean
targetWWNs:
- description: 'targetWWNs is Optional: FC target worldwide
- names (WWNs)'
+ description: 'targetWWNs is Optional: FC target worldwide names (WWNs)'
items:
type: string
type: array
wwids:
- description: 'wwids Optional: FC volume world wide identifiers
- (wwids) Either wwids or combination of targetWWNs and
- lun must be set, but not both simultaneously.'
+ description: 'wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.'
items:
type: string
type: array
type: object
flexVolume:
- description: flexVolume represents a generic volume resource
- that is provisioned/attached using an exec based plugin.
+ description: flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
properties:
driver:
- description: driver is the name of the driver to use for
- this volume.
+ description: driver is the name of the driver to use for this volume.
type: string
fsType:
- description: fsType is the filesystem type to mount. Must
- be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". The default filesystem depends
- on FlexVolume script.
+ description: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
type: string
options:
additionalProperties:
type: string
- description: 'options is Optional: this field holds extra
- command options if any.'
+ description: 'options is Optional: this field holds extra command options if any.'
type: object
readOnly:
- description: 'readOnly is Optional: defaults to false (read/write).
- ReadOnly here will force the ReadOnly setting in VolumeMounts.'
+ description: 'readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.'
type: boolean
secretRef:
- description: 'secretRef is Optional: secretRef is reference
- to the secret object containing sensitive information
- to pass to the plugin scripts. This may be empty if no
- secret object is specified. If the secret object contains
- more than one secret, all secrets are passed to the plugin
- scripts.'
+ description: 'secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
x-kubernetes-map-type: atomic
@@ -8045,184 +5229,120 @@ spec:
- driver
type: object
flocker:
- description: flocker represents a Flocker volume attached to
- a kubelet's host machine. This depends on the Flocker control
- service being running
+ description: flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
properties:
datasetName:
- description: datasetName is Name of the dataset stored as
- metadata -> name on the dataset for Flocker should be
- considered as deprecated
+ description: datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
type: string
datasetUUID:
- description: datasetUUID is the UUID of the dataset. This
- is unique identifier of a Flocker dataset
+ description: datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
type: string
type: object
gcePersistentDisk:
- description: 'gcePersistentDisk represents a GCE Disk resource
- that is attached to a kubelet''s host machine and then exposed
- to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
+ description: 'gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet''s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
properties:
fsType:
- description: 'fsType is filesystem type of the volume that
- you want to mount. Tip: Ensure that the filesystem type
- is supported by the host operating system. Examples: "ext4",
- "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
- TODO: how do we prevent errors in the filesystem from
- compromising the machine'
+ description: 'fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine'
type: string
partition:
- description: 'partition is the partition in the volume that
- you want to mount. If omitted, the default is to mount
- by volume name. Examples: For volume /dev/sda1, you specify
- the partition as "1". Similarly, the volume partition
- for /dev/sda is "0" (or you can leave the property empty).
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
+ description: 'partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
format: int32
type: integer
pdName:
- description: 'pdName is unique name of the PD resource in
- GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
+ description: 'pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
type: string
readOnly:
- description: 'readOnly here will force the ReadOnly setting
- in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
+ description: 'readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
type: boolean
required:
- pdName
type: object
gitRepo:
- description: 'gitRepo represents a git repository at a particular
- revision. DEPRECATED: GitRepo is deprecated. To provision
- a container with a git repo, mount an EmptyDir into an InitContainer
- that clones the repo using git, then mount the EmptyDir into
- the Pod''s container.'
+ description: 'gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod''s container.'
properties:
directory:
- description: directory is the target directory name. Must
- not contain or start with '..'. If '.' is supplied, the
- volume directory will be the git repository. Otherwise,
- if specified, the volume will contain the git repository
- in the subdirectory with the given name.
+ description: directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.
type: string
repository:
description: repository is the URL
type: string
revision:
- description: revision is the commit hash for the specified
- revision.
+ description: revision is the commit hash for the specified revision.
type: string
required:
- repository
type: object
glusterfs:
- description: 'glusterfs represents a Glusterfs mount on the
- host that shares a pod''s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md'
+ description: 'glusterfs represents a Glusterfs mount on the host that shares a pod''s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md'
properties:
endpoints:
- description: 'endpoints is the endpoint name that details
- Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
+ description: 'endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: string
path:
- description: 'path is the Glusterfs volume path. More info:
- https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
+ description: 'path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: string
readOnly:
- description: 'readOnly here will force the Glusterfs volume
- to be mounted with read-only permissions. Defaults to
- false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
+ description: 'readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: boolean
required:
- endpoints
- path
type: object
hostPath:
- description: 'hostPath represents a pre-existing file or directory
- on the host machine that is directly exposed to the container.
- This is generally used for system agents or other privileged
- things that are allowed to see the host machine. Most containers
- will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
- --- TODO(jonesdl) We need to restrict who can use host directory
- mounts and who can/can not mount host directories as read/write.'
+ description: 'hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.'
properties:
path:
- description: 'path of the directory on the host. If the
- path is a symlink, it will follow the link to the real
- path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
+ description: 'path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
type: string
type:
- description: 'type for HostPath Volume Defaults to "" More
- info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
+ description: 'type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
type: string
required:
- path
type: object
iscsi:
- description: 'iscsi represents an ISCSI Disk resource that is
- attached to a kubelet''s host machine and then exposed to
- the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md'
+ description: 'iscsi represents an ISCSI Disk resource that is attached to a kubelet''s host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md'
properties:
chapAuthDiscovery:
- description: chapAuthDiscovery defines whether support iSCSI
- Discovery CHAP authentication
+ description: chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
type: boolean
chapAuthSession:
- description: chapAuthSession defines whether support iSCSI
- Session CHAP authentication
+ description: chapAuthSession defines whether support iSCSI Session CHAP authentication
type: boolean
fsType:
- description: 'fsType is the filesystem type of the volume
- that you want to mount. Tip: Ensure that the filesystem
- type is supported by the host operating system. Examples:
- "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4"
- if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
- TODO: how do we prevent errors in the filesystem from
- compromising the machine'
+ description: 'fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine'
type: string
initiatorName:
- description: initiatorName is the custom iSCSI Initiator
- Name. If initiatorName is specified with iscsiInterface
- simultaneously, new iSCSI interface <target portal>:<volume
- name> will be created for the connection.
+ description: initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.
type: string
iqn:
description: iqn is the target iSCSI Qualified Name.
type: string
iscsiInterface:
- description: iscsiInterface is the interface Name that uses
- an iSCSI transport. Defaults to 'default' (tcp).
+ description: iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
type: string
lun:
description: lun represents iSCSI Target Lun number.
format: int32
type: integer
portals:
- description: portals is the iSCSI Target Portal List. The
- portal is either an IP or ip_addr:port if the port is
- other than default (typically TCP ports 860 and 3260).
+ description: portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
items:
type: string
type: array
readOnly:
- description: readOnly here will force the ReadOnly setting
- in VolumeMounts. Defaults to false.
+ description: readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
type: boolean
secretRef:
- description: secretRef is the CHAP Secret for iSCSI target
- and initiator authentication
+ description: secretRef is the CHAP Secret for iSCSI target and initiator authentication
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
x-kubernetes-map-type: atomic
targetPortal:
- description: targetPortal is iSCSI Target Portal. The Portal
- is either an IP or ip_addr:port if the port is other than
- default (typically TCP ports 860 and 3260).
+ description: targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
type: string
required:
- iqn
@@ -8230,77 +5350,56 @@ spec:
- targetPortal
type: object
name:
- description: 'name of the volume. Must be a DNS_LABEL and unique
- within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+ description: 'name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
type: string
nfs:
- description: 'nfs represents an NFS mount on the host that shares
- a pod''s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
+ description: 'nfs represents an NFS mount on the host that shares a pod''s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
properties:
path:
- description: 'path that is exported by the NFS server. More
- info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
+ description: 'path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: string
readOnly:
- description: 'readOnly here will force the NFS export to
- be mounted with read-only permissions. Defaults to false.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
+ description: 'readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: boolean
server:
- description: 'server is the hostname or IP address of the
- NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
+ description: 'server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: string
required:
- path
- server
type: object
persistentVolumeClaim:
- description: 'persistentVolumeClaimVolumeSource represents a
- reference to a PersistentVolumeClaim in the same namespace.
- More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
+ description: 'persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
properties:
claimName:
- description: 'claimName is the name of a PersistentVolumeClaim
- in the same namespace as the pod using this volume. More
- info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
+ description: 'claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
type: string
readOnly:
- description: readOnly Will force the ReadOnly setting in
- VolumeMounts. Default false.
+ description: readOnly Will force the ReadOnly setting in VolumeMounts. Default false.
type: boolean
required:
- claimName
type: object
photonPersistentDisk:
- description: photonPersistentDisk represents a PhotonController
- persistent disk attached and mounted on kubelets host machine
+ description: photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
properties:
fsType:
- description: fsType is the filesystem type to mount. Must
- be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4"
- if unspecified.
+ description: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
type: string
pdID:
- description: pdID is the ID that identifies Photon Controller
- persistent disk
+ description: pdID is the ID that identifies Photon Controller persistent disk
type: string
required:
- pdID
type: object
portworxVolume:
- description: portworxVolume represents a portworx volume attached
- and mounted on kubelets host machine
+ description: portworxVolume represents a portworx volume attached and mounted on kubelets host machine
properties:
fsType:
- description: fSType represents the filesystem type to mount
- Must be a filesystem type supported by the host operating
- system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4"
- if unspecified.
+ description: fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
type: string
readOnly:
- description: readOnly defaults to false (read/write). ReadOnly
- here will force the ReadOnly setting in VolumeMounts.
+ description: readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
type: boolean
volumeID:
description: volumeID uniquely identifies a Portworx volume
@@ -8309,69 +5408,34 @@ spec:
- volumeID
type: object
projected:
- description: projected items for all in one resources secrets,
- configmaps, and downward API
+ description: projected items for all in one resources secrets, configmaps, and downward API
properties:
defaultMode:
- description: defaultMode are the mode bits used to set permissions
- on created files by default. Must be an octal value between
- 0000 and 0777 or a decimal value between 0 and 511. YAML
- accepts both octal and decimal values, JSON requires decimal
- values for mode bits. Directories within the path are
- not affected by this setting. This might be in conflict
- with other options that affect the file mode, like fsGroup,
- and the result can be other mode bits set.
+ description: defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
format: int32
type: integer
sources:
description: sources is the list of volume projections
items:
- description: Projection that may be projected along with
- other supported volume types
+ description: Projection that may be projected along with other supported volume types
properties:
configMap:
- description: configMap information about the configMap
- data to project
+ description: configMap information about the configMap data to project
properties:
items:
- description: items if unspecified, each key-value
- pair in the Data field of the referenced ConfigMap
- will be projected into the volume as a file
- whose name is the key and content is the value.
- If specified, the listed keys will be projected
- into the specified paths, and unlisted keys
- will not be present. If a key is specified which
- is not present in the ConfigMap, the volume
- setup will error unless it is marked optional.
- Paths must be relative and may not contain the
- '..' path or start with '..'.
+ description: items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
items:
- description: Maps a string key to a path within
- a volume.
+ description: Maps a string key to a path within a volume.
properties:
key:
description: key is the key to project.
type: string
mode:
- description: 'mode is Optional: mode bits
- used to set permissions on this file.
- Must be an octal value between 0000 and
- 0777 or a decimal value between 0 and
- 511. YAML accepts both octal and decimal
- values, JSON requires decimal values for
- mode bits. If not specified, the volume
- defaultMode will be used. This might be
- in conflict with other options that affect
- the file mode, like fsGroup, and the result
- can be other mode bits set.'
+ description: 'mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
format: int32
type: integer
path:
- description: path is the relative path of
- the file to map the key to. May not be
- an absolute path. May not contain the
- path element '..'. May not start with
- the string '..'.
+ description: path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
type: string
required:
- key
@@ -8379,91 +5443,56 @@ spec:
type: object
type: array
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: optional specify whether the ConfigMap
- or its keys must be defined
+ description: optional specify whether the ConfigMap or its keys must be defined
type: boolean
type: object
x-kubernetes-map-type: atomic
downwardAPI:
- description: downwardAPI information about the downwardAPI
- data to project
+ description: downwardAPI information about the downwardAPI data to project
properties:
items:
- description: Items is a list of DownwardAPIVolume
- file
+ description: Items is a list of DownwardAPIVolume file
items:
- description: DownwardAPIVolumeFile represents
- information to create the file containing
- the pod field
+ description: DownwardAPIVolumeFile represents information to create the file containing the pod field
properties:
fieldRef:
- description: 'Required: Selects a field
- of the pod: only annotations, labels,
- name and namespace are supported.'
+ description: 'Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.'
properties:
apiVersion:
- description: Version of the schema the
- FieldPath is written in terms of,
- defaults to "v1".
+ description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
type: string
fieldPath:
- description: Path of the field to select
- in the specified API version.
+ description: Path of the field to select in the specified API version.
type: string
required:
- fieldPath
type: object
x-kubernetes-map-type: atomic
mode:
- description: 'Optional: mode bits used to
- set permissions on this file, must be
- an octal value between 0000 and 0777 or
- a decimal value between 0 and 511. YAML
- accepts both octal and decimal values,
- JSON requires decimal values for mode
- bits. If not specified, the volume defaultMode
- will be used. This might be in conflict
- with other options that affect the file
- mode, like fsGroup, and the result can
- be other mode bits set.'
+ description: 'Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
format: int32
type: integer
path:
- description: 'Required: Path is the relative
- path name of the file to be created. Must
- not be absolute or contain the ''..''
- path. Must be utf-8 encoded. The first
- item of the relative path must not start
- with ''..'''
+ description: 'Required: Path is the relative path name of the file to be created. Must not be absolute or contain the ''..'' path. Must be utf-8 encoded. The first item of the relative path must not start with ''..'''
type: string
resourceFieldRef:
- description: 'Selects a resource of the
- container: only resources limits and requests
- (limits.cpu, limits.memory, requests.cpu
- and requests.memory) are currently supported.'
+ description: 'Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.'
properties:
containerName:
- description: 'Container name: required
- for volumes, optional for env vars'
+ description: 'Container name: required for volumes, optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format
- of the exposed resources, defaults
- to "1"
+ description: Specifies the output format of the exposed resources, defaults to "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
- description: 'Required: resource to
- select'
+ description: 'Required: resource to select'
type: string
required:
- resource
@@ -8475,48 +5504,22 @@ spec:
type: array
type: object
secret:
- description: secret information about the secret data
- to project
+ description: secret information about the secret data to project
properties:
items:
- description: items if unspecified, each key-value
- pair in the Data field of the referenced Secret
- will be projected into the volume as a file
- whose name is the key and content is the value.
- If specified, the listed keys will be projected
- into the specified paths, and unlisted keys
- will not be present. If a key is specified which
- is not present in the Secret, the volume setup
- will error unless it is marked optional. Paths
- must be relative and may not contain the '..'
- path or start with '..'.
+ description: items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
items:
- description: Maps a string key to a path within
- a volume.
+ description: Maps a string key to a path within a volume.
properties:
key:
description: key is the key to project.
type: string
mode:
- description: 'mode is Optional: mode bits
- used to set permissions on this file.
- Must be an octal value between 0000 and
- 0777 or a decimal value between 0 and
- 511. YAML accepts both octal and decimal
- values, JSON requires decimal values for
- mode bits. If not specified, the volume
- defaultMode will be used. This might be
- in conflict with other options that affect
- the file mode, like fsGroup, and the result
- can be other mode bits set.'
+ description: 'mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
format: int32
type: integer
path:
- description: path is the relative path of
- the file to map the key to. May not be
- an absolute path. May not contain the
- path element '..'. May not start with
- the string '..'.
+ description: path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
type: string
required:
- key
@@ -8524,45 +5527,25 @@ spec:
type: object
type: array
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: optional field specify whether the
- Secret or its key must be defined
+ description: optional field specify whether the Secret or its key must be defined
type: boolean
type: object
x-kubernetes-map-type: atomic
serviceAccountToken:
- description: serviceAccountToken is information about
- the serviceAccountToken data to project
+ description: serviceAccountToken is information about the serviceAccountToken data to project
properties:
audience:
- description: audience is the intended audience
- of the token. A recipient of a token must identify
- itself with an identifier specified in the audience
- of the token, and otherwise should reject the
- token. The audience defaults to the identifier
- of the apiserver.
+ description: audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.
type: string
expirationSeconds:
- description: expirationSeconds is the requested
- duration of validity of the service account
- token. As the token approaches expiration, the
- kubelet volume plugin will proactively rotate
- the service account token. The kubelet will
- start trying to rotate the token if the token
- is older than 80 percent of its time to live
- or if the token is older than 24 hours.Defaults
- to 1 hour and must be at least 10 minutes.
+ description: expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.
format: int64
type: integer
path:
- description: path is the path relative to the
- mount point of the file to project the token
- into.
+ description: path is the path relative to the mount point of the file to project the token into.
type: string
required:
- path
@@ -8571,148 +5554,105 @@ spec:
type: array
type: object
quobyte:
- description: quobyte represents a Quobyte mount on the host
- that shares a pod's lifetime
+ description: quobyte represents a Quobyte mount on the host that shares a pod's lifetime
properties:
group:
- description: group to map volume access to Default is no
- group
+ description: group to map volume access to Default is no group
type: string
readOnly:
- description: readOnly here will force the Quobyte volume
- to be mounted with read-only permissions. Defaults to
- false.
+ description: readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
type: boolean
registry:
- description: registry represents a single or multiple Quobyte
- Registry services specified as a string as host:port pair
- (multiple entries are separated with commas) which acts
- as the central registry for volumes
+ description: registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes
type: string
tenant:
- description: tenant owning the given Quobyte volume in the
- Backend Used with dynamically provisioned Quobyte volumes,
- value is set by the plugin
+ description: tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
type: string
user:
- description: user to map volume access to Defaults to serivceaccount
- user
+ description: user to map volume access to Defaults to serivceaccount user
type: string
volume:
- description: volume is a string that references an already
- created Quobyte volume by name.
+ description: volume is a string that references an already created Quobyte volume by name.
type: string
required:
- registry
- volume
type: object
rbd:
- description: 'rbd represents a Rados Block Device mount on the
- host that shares a pod''s lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md'
+ description: 'rbd represents a Rados Block Device mount on the host that shares a pod''s lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md'
properties:
fsType:
- description: 'fsType is the filesystem type of the volume
- that you want to mount. Tip: Ensure that the filesystem
- type is supported by the host operating system. Examples:
- "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4"
- if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd
- TODO: how do we prevent errors in the filesystem from
- compromising the machine'
+ description: 'fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine'
type: string
image:
- description: 'image is the rados image name. More info:
- https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
keyring:
- description: 'keyring is the path to key ring for RBDUser.
- Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
monitors:
- description: 'monitors is a collection of Ceph monitors.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
items:
type: string
type: array
pool:
- description: 'pool is the rados pool name. Default is rbd.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
readOnly:
- description: 'readOnly here will force the ReadOnly setting
- in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: boolean
secretRef:
- description: 'secretRef is name of the authentication secret
- for RBDUser. If provided overrides keyring. Default is
- nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
x-kubernetes-map-type: atomic
user:
- description: 'user is the rados user name. Default is admin.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
required:
- image
- monitors
type: object
scaleIO:
- description: scaleIO represents a ScaleIO persistent volume
- attached and mounted on Kubernetes nodes.
+ description: scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
properties:
fsType:
- description: fsType is the filesystem type to mount. Must
- be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Default is "xfs".
+ description: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".
type: string
gateway:
- description: gateway is the host address of the ScaleIO
- API Gateway.
+ description: gateway is the host address of the ScaleIO API Gateway.
type: string
protectionDomain:
- description: protectionDomain is the name of the ScaleIO
- Protection Domain for the configured storage.
+ description: protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
type: string
readOnly:
- description: readOnly Defaults to false (read/write). ReadOnly
- here will force the ReadOnly setting in VolumeMounts.
+ description: readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
type: boolean
secretRef:
- description: secretRef references to the secret for ScaleIO
- user and other sensitive information. If this is not provided,
- Login operation will fail.
+ description: secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
x-kubernetes-map-type: atomic
sslEnabled:
- description: sslEnabled Flag enable/disable SSL communication
- with Gateway, default false
+ description: sslEnabled Flag enable/disable SSL communication with Gateway, default false
type: boolean
storageMode:
- description: storageMode indicates whether the storage for
- a volume should be ThickProvisioned or ThinProvisioned.
- Default is ThinProvisioned.
+ description: storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
type: string
storagePool:
- description: storagePool is the ScaleIO Storage Pool associated
- with the protection domain.
+ description: storagePool is the ScaleIO Storage Pool associated with the protection domain.
type: string
system:
- description: system is the name of the storage system as
- configured in ScaleIO.
+ description: system is the name of the storage system as configured in ScaleIO.
type: string
volumeName:
- description: volumeName is the name of a volume already
- created in the ScaleIO system that is associated with
- this volume source.
+ description: volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.
type: string
required:
- gateway
@@ -8720,31 +5660,14 @@ spec:
- system
type: object
secret:
- description: 'secret represents a secret that should populate
- this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
+ description: 'secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
properties:
defaultMode:
- description: 'defaultMode is Optional: mode bits used to
- set permissions on created files by default. Must be an
- octal value between 0000 and 0777 or a decimal value between
- 0 and 511. YAML accepts both octal and decimal values,
- JSON requires decimal values for mode bits. Defaults to
- 0644. Directories within the path are not affected by
- this setting. This might be in conflict with other options
- that affect the file mode, like fsGroup, and the result
- can be other mode bits set.'
+ description: 'defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
format: int32
type: integer
items:
- description: items If unspecified, each key-value pair in
- the Data field of the referenced Secret will be projected
- into the volume as a file whose name is the key and content
- is the value. If specified, the listed keys will be projected
- into the specified paths, and unlisted keys will not be
- present. If a key is specified which is not present in
- the Secret, the volume setup will error unless it is marked
- optional. Paths must be relative and may not contain the
- '..' path or start with '..'.
+ description: items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
items:
description: Maps a string key to a path within a volume.
properties:
@@ -8752,22 +5675,11 @@ spec:
description: key is the key to project.
type: string
mode:
- description: 'mode is Optional: mode bits used to
- set permissions on this file. Must be an octal value
- between 0000 and 0777 or a decimal value between
- 0 and 511. YAML accepts both octal and decimal values,
- JSON requires decimal values for mode bits. If not
- specified, the volume defaultMode will be used.
- This might be in conflict with other options that
- affect the file mode, like fsGroup, and the result
- can be other mode bits set.'
+ description: 'mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
format: int32
type: integer
path:
- description: path is the relative path of the file
- to map the key to. May not be an absolute path.
- May not contain the path element '..'. May not start
- with the string '..'.
+ description: path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
type: string
required:
- key
@@ -8775,76 +5687,50 @@ spec:
type: object
type: array
optional:
- description: optional field specify whether the Secret or
- its keys must be defined
+ description: optional field specify whether the Secret or its keys must be defined
type: boolean
secretName:
- description: 'secretName is the name of the secret in the
- pod''s namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
+ description: 'secretName is the name of the secret in the pod''s namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
type: string
type: object
storageos:
- description: storageOS represents a StorageOS volume attached
- and mounted on Kubernetes nodes.
+ description: storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
properties:
fsType:
- description: fsType is the filesystem type to mount. Must
- be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4"
- if unspecified.
+ description: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
type: string
readOnly:
- description: readOnly defaults to false (read/write). ReadOnly
- here will force the ReadOnly setting in VolumeMounts.
+ description: readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
type: boolean
secretRef:
- description: secretRef specifies the secret to use for obtaining
- the StorageOS API credentials. If not specified, default
- values will be attempted.
+ description: secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
x-kubernetes-map-type: atomic
volumeName:
- description: volumeName is the human-readable name of the
- StorageOS volume. Volume names are only unique within
- a namespace.
+ description: volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
type: string
volumeNamespace:
- description: volumeNamespace specifies the scope of the
- volume within StorageOS. If no namespace is specified
- then the Pod's namespace will be used. This allows the
- Kubernetes name scoping to be mirrored within StorageOS
- for tighter integration. Set VolumeName to any name to
- override the default behaviour. Set to "default" if you
- are not using namespaces within StorageOS. Namespaces
- that do not pre-exist within StorageOS will be created.
+ description: volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.
type: string
type: object
vsphereVolume:
- description: vsphereVolume represents a vSphere volume attached
- and mounted on kubelets host machine
+ description: vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
properties:
fsType:
- description: fsType is filesystem type to mount. Must be
- a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4"
- if unspecified.
+ description: fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
type: string
storagePolicyID:
- description: storagePolicyID is the storage Policy Based
- Management (SPBM) profile ID associated with the StoragePolicyName.
+ description: storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
type: string
storagePolicyName:
- description: storagePolicyName is the storage Policy Based
- Management (SPBM) profile name.
+ description: storagePolicyName is the storage Policy Based Management (SPBM) profile name.
type: string
volumePath:
- description: volumePath is the path that identifies vSphere
- volume vmdk
+ description: volumePath is the path that identifies vSphere volume vmdk
type: string
required:
- volumePath
@@ -8854,8 +5740,7 @@ spec:
type: object
type: array
walCompression:
- description: Enable compression of the write-ahead log using Snappy.
- This flag is only available in versions of Prometheus >= 2.11.0.
+ description: Enable compression of the write-ahead log using Snappy. This flag is only available in versions of Prometheus >= 2.11.0.
type: boolean
web:
description: Defines the web command line flags when starting Prometheus.
@@ -8867,50 +5752,34 @@ spec:
description: List of headers that can be added to HTTP responses.
properties:
contentSecurityPolicy:
- description: Set the Content-Security-Policy header to
- HTTP responses. Unset if blank.
+ description: Set the Content-Security-Policy header to HTTP responses. Unset if blank.
type: string
strictTransportSecurity:
- description: Set the Strict-Transport-Security header
- to HTTP responses. Unset if blank. Please make sure
- that you use this with care as this header might force
- browsers to load Prometheus and the other applications
- hosted on the same domain and subdomains over HTTPS.
- https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security
+ description: Set the Strict-Transport-Security header to HTTP responses. Unset if blank. Please make sure that you use this with care as this header might force browsers to load Prometheus and the other applications hosted on the same domain and subdomains over HTTPS. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security
type: string
xContentTypeOptions:
- description: Set the X-Content-Type-Options header to
- HTTP responses. Unset if blank. Accepted value is nosniff.
- https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options
+ description: Set the X-Content-Type-Options header to HTTP responses. Unset if blank. Accepted value is nosniff. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options
enum:
- ""
- NoSniff
type: string
xFrameOptions:
- description: Set the X-Frame-Options header to HTTP responses.
- Unset if blank. Accepted values are deny and sameorigin.
- https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options
+ description: Set the X-Frame-Options header to HTTP responses. Unset if blank. Accepted values are deny and sameorigin. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options
enum:
- ""
- Deny
- SameOrigin
type: string
xXSSProtection:
- description: Set the X-XSS-Protection header to all responses.
- Unset if blank. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection
+ description: Set the X-XSS-Protection header to all responses. Unset if blank. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection
type: string
type: object
http2:
- description: Enable HTTP/2 support. Note that HTTP/2 is only
- supported with TLS. When TLSConfig is not configured, HTTP/2
- will be disabled. Whenever the value of the field changes,
- a rolling update will be triggered.
+ description: Enable HTTP/2 support. Note that HTTP/2 is only supported with TLS. When TLSConfig is not configured, HTTP/2 will be disabled. Whenever the value of the field changes, a rolling update will be triggered.
type: boolean
type: object
maxConnections:
- description: Defines the maximum number of simultaneous connections
- A zero value means that Prometheus doesn't accept any incoming
- connection.
+ description: Defines the maximum number of simultaneous connections A zero value means that Prometheus doesn't accept any incoming connection.
format: int32
minimum: 0
type: integer
@@ -8924,20 +5793,16 @@ spec:
description: Contains the TLS certificate for the server.
properties:
configMap:
- description: ConfigMap containing data to use for the
- targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its
- key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
@@ -8947,17 +5812,13 @@ spec:
description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -8965,32 +5826,24 @@ spec:
x-kubernetes-map-type: atomic
type: object
cipherSuites:
- description: 'List of supported cipher suites for TLS versions
- up to TLS 1.2. If empty, Go default cipher suites are used.
- Available cipher suites are documented in the go documentation:
- https://golang.org/pkg/crypto/tls/#pkg-constants'
+ description: 'List of supported cipher suites for TLS versions up to TLS 1.2. If empty, Go default cipher suites are used. Available cipher suites are documented in the go documentation: https://golang.org/pkg/crypto/tls/#pkg-constants'
items:
type: string
type: array
client_ca:
- description: Contains the CA certificate for client certificate
- authentication to the server.
+ description: Contains the CA certificate for client certificate authentication to the server.
properties:
configMap:
- description: ConfigMap containing data to use for the
- targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its
- key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
@@ -9000,17 +5853,13 @@ spec:
description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -9018,14 +5867,10 @@ spec:
x-kubernetes-map-type: atomic
type: object
clientAuthType:
- description: 'Server policy for client authentication. Maps
- to ClientAuth Policies. For more detail on clientAuth options:
- https://golang.org/pkg/crypto/tls/#ClientAuthType'
+ description: 'Server policy for client authentication. Maps to ClientAuth Policies. For more detail on clientAuth options: https://golang.org/pkg/crypto/tls/#ClientAuthType'
type: string
curvePreferences:
- description: 'Elliptic curves that will be used in an ECDHE
- handshake, in preference order. Available curves are documented
- in the go documentation: https://golang.org/pkg/crypto/tls/#CurveID'
+ description: 'Elliptic curves that will be used in an ECDHE handshake, in preference order. Available curves are documented in the go documentation: https://golang.org/pkg/crypto/tls/#CurveID'
items:
type: string
type: array
@@ -9033,34 +5878,26 @@ spec:
description: Secret containing the TLS key for the server.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
maxVersion:
- description: Maximum TLS version that is acceptable. Defaults
- to TLS13.
+ description: Maximum TLS version that is acceptable. Defaults to TLS13.
type: string
minVersion:
- description: Minimum TLS version that is acceptable. Defaults
- to TLS12.
+ description: Minimum TLS version that is acceptable. Defaults to TLS12.
type: string
preferServerCipherSuites:
- description: Controls whether the server selects the client's
- most preferred cipher suite, or the server's most preferred
- cipher suite. If true then the server's preference, as expressed
- in the order of elements in cipherSuites, is used.
+ description: Controls whether the server selects the client's most preferred cipher suite, or the server's most preferred cipher suite. If true then the server's preference, as expressed in the order of elements in cipherSuites, is used.
type: boolean
required:
- cert
@@ -9069,35 +5906,26 @@ spec:
type: object
type: object
status:
- description: 'Most recent observed status of the Prometheus cluster. Read-only.
- More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status'
+ description: 'Most recent observed status of the Prometheus cluster. Read-only. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status'
properties:
availableReplicas:
- description: Total number of available pods (ready for at least minReadySeconds)
- targeted by this Prometheus deployment.
+ description: Total number of available pods (ready for at least minReadySeconds) targeted by this Prometheus deployment.
format: int32
type: integer
conditions:
description: The current state of the Prometheus deployment.
items:
- description: Condition represents the state of the resources associated
- with the Prometheus or Alertmanager resource.
+ description: Condition represents the state of the resources associated with the Prometheus or Alertmanager resource.
properties:
lastTransitionTime:
- description: lastTransitionTime is the time of the last update
- to the current status property.
+ description: lastTransitionTime is the time of the last update to the current status property.
format: date-time
type: string
message:
- description: Human-readable message indicating details for the
- condition's last transition.
+ description: Human-readable message indicating details for the condition's last transition.
type: string
observedGeneration:
- description: ObservedGeneration represents the .metadata.generation
- that the condition was set based upon. For instance, if `.metadata.generation`
- is currently 12, but the `.status.conditions[].observedGeneration`
- is 9, the condition is out of date with respect to the current
- state of the instance.
+ description: ObservedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if `.metadata.generation` is currently 12, but the `.status.conditions[].observedGeneration` is 9, the condition is out of date with respect to the current state of the instance.
format: int64
type: integer
reason:
@@ -9119,22 +5947,18 @@ spec:
- type
x-kubernetes-list-type: map
paused:
- description: Represents whether any actions on the underlying managed
- objects are being performed. Only delete actions will be performed.
+ description: Represents whether any actions on the underlying managed objects are being performed. Only delete actions will be performed.
type: boolean
replicas:
- description: Total number of non-terminated pods targeted by this
- Prometheus deployment (their labels match the selector).
+ description: Total number of non-terminated pods targeted by this Prometheus deployment (their labels match the selector).
format: int32
type: integer
shardStatuses:
- description: The list has one entry per shard. Each entry provides
- a summary of the shard status.
+ description: The list has one entry per shard. Each entry provides a summary of the shard status.
items:
properties:
availableReplicas:
- description: Total number of available pods (ready for at least
- minReadySeconds) targeted by this shard.
+ description: Total number of available pods (ready for at least minReadySeconds) targeted by this shard.
format: int32
type: integer
replicas:
@@ -9145,13 +5969,11 @@ spec:
description: Identifier of the shard.
type: string
unavailableReplicas:
- description: Total number of unavailable pods targeted by this
- shard.
+ description: Total number of unavailable pods targeted by this shard.
format: int32
type: integer
updatedReplicas:
- description: Total number of non-terminated pods targeted by
- this shard that have the desired spec.
+ description: Total number of non-terminated pods targeted by this shard that have the desired spec.
format: int32
type: integer
required:
@@ -9166,13 +5988,11 @@ spec:
- shardID
x-kubernetes-list-type: map
unavailableReplicas:
- description: Total number of unavailable pods targeted by this Prometheus
- deployment.
+ description: Total number of unavailable pods targeted by this Prometheus deployment.
format: int32
type: integer
updatedReplicas:
- description: Total number of non-terminated pods targeted by this
- Prometheus deployment that have the desired version spec.
+ description: Total number of non-terminated pods targeted by this Prometheus deployment that have the desired version spec.
format: int32
type: integer
required:
diff --git a/manifests/setup/0prometheusruleCustomResourceDefinition.yaml b/manifests/setup/0prometheusruleCustomResourceDefinition.yaml
index fa0ba06c95060449c13c281d51a344e7ab43bdf6..0df120a6c4ebc42b78bc56c3794c4095cbe0d654 100644
--- a/manifests/setup/0prometheusruleCustomResourceDefinition.yaml
+++ b/manifests/setup/0prometheusruleCustomResourceDefinition.yaml
@@ -21,18 +21,13 @@ spec:
- name: v1
schema:
openAPIV3Schema:
- description: PrometheusRule defines recording and alerting rules for a Prometheus
- instance
+ description: PrometheusRule defines recording and alerting rules for a Prometheus instance
properties:
apiVersion:
- description: 'APIVersion defines the versioned schema of this representation
- of an object. Servers should convert recognized schemas to the latest
- internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+ description: 'APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: 'Kind is a string value representing the REST resource this
- object represents. Servers may infer this from the endpoint the client
- submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+ description: 'Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
@@ -42,12 +37,10 @@ spec:
groups:
description: Content of Prometheus rule file
items:
- description: RuleGroup is a list of sequentially evaluated recording
- and alerting rules.
+ description: RuleGroup is a list of sequentially evaluated recording and alerting rules.
properties:
interval:
- description: Interval determines how often rules in the group
- are evaluated.
+ description: Interval determines how often rules in the group are evaluated.
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
name:
@@ -55,27 +48,21 @@ spec:
minLength: 1
type: string
partial_response_strategy:
- description: 'PartialResponseStrategy is only used by ThanosRuler
- and will be ignored by Prometheus instances. More info: https://github.com/thanos-io/thanos/blob/main/docs/components/rule.md#partial-response'
+ description: 'PartialResponseStrategy is only used by ThanosRuler and will be ignored by Prometheus instances. More info: https://github.com/thanos-io/thanos/blob/main/docs/components/rule.md#partial-response'
pattern: ^(?i)(abort|warn)?$
type: string
rules:
description: List of alerting and recording rules.
items:
- description: 'Rule describes an alerting or recording rule
- See Prometheus documentation: [alerting](https://www.prometheus.io/docs/prometheus/latest/configuration/alerting_rules/)
- or [recording](https://www.prometheus.io/docs/prometheus/latest/configuration/recording_rules/#recording-rules)
- rule'
+ description: 'Rule describes an alerting or recording rule See Prometheus documentation: [alerting](https://www.prometheus.io/docs/prometheus/latest/configuration/alerting_rules/) or [recording](https://www.prometheus.io/docs/prometheus/latest/configuration/recording_rules/#recording-rules) rule'
properties:
alert:
- description: Name of the alert. Must be a valid label
- value. Only one of `record` and `alert` must be set.
+ description: Name of the alert. Must be a valid label value. Only one of `record` and `alert` must be set.
type: string
annotations:
additionalProperties:
type: string
- description: Annotations to add to each alert. Only valid
- for alerting rules.
+ description: Annotations to add to each alert. Only valid for alerting rules.
type: object
expr:
anyOf:
@@ -84,8 +71,7 @@ spec:
description: PromQL expression to evaluate.
x-kubernetes-int-or-string: true
for:
- description: Alerts are considered firing once they have
- been returned for this long.
+ description: Alerts are considered firing once they have been returned for this long.
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
labels:
@@ -94,9 +80,7 @@ spec:
description: Labels to add or overwrite.
type: object
record:
- description: Name of the time series to output to. Must
- be a valid metric name. Only one of `record` and `alert`
- must be set.
+ description: Name of the time series to output to. Must be a valid metric name. Only one of `record` and `alert` must be set.
type: string
required:
- expr
diff --git a/manifests/setup/0servicemonitorCustomResourceDefinition.yaml b/manifests/setup/0servicemonitorCustomResourceDefinition.yaml
index 3a5b7d4c7bc7c44b7b06ae8d7b023179f4df5e51..2fc6963fa12edcb882b927cb3148c0dedfbbe5dd 100644
--- a/manifests/setup/0servicemonitorCustomResourceDefinition.yaml
+++ b/manifests/setup/0servicemonitorCustomResourceDefinition.yaml
@@ -24,103 +24,81 @@ spec:
description: ServiceMonitor defines monitoring for a set of services.
properties:
apiVersion:
- description: 'APIVersion defines the versioned schema of this representation
- of an object. Servers should convert recognized schemas to the latest
- internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+ description: 'APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: 'Kind is a string value representing the REST resource this
- object represents. Servers may infer this from the endpoint the client
- submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+ description: 'Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
spec:
- description: Specification of desired Service selection for target discovery
- by Prometheus.
+ description: Specification of desired Service selection for target discovery by Prometheus.
properties:
attachMetadata:
- description: Attaches node metadata to discovered targets. Requires
- Prometheus v2.37.0 and above.
+ description: Attaches node metadata to discovered targets. Requires Prometheus v2.37.0 and above.
properties:
node:
- description: When set to true, Prometheus must have permissions
- to get Nodes.
+ description: When set to true, Prometheus must have permissions to get Nodes.
type: boolean
type: object
endpoints:
description: A list of endpoints allowed as part of this ServiceMonitor.
items:
- description: Endpoint defines a scrapeable endpoint serving Prometheus
- metrics.
+ description: Endpoint defines a scrapeable endpoint serving Prometheus metrics.
properties:
authorization:
description: Authorization section for this endpoint
properties:
credentials:
- description: The secret's key that contains the credentials
- of the request
+ description: The secret's key that contains the credentials of the request
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
type:
- description: Set the authentication type. Defaults to Bearer,
- Basic will cause an error
+ description: Set the authentication type. Defaults to Bearer, Basic will cause an error
type: string
type: object
basicAuth:
- description: 'BasicAuth allow an endpoint to authenticate over
- basic authentication More info: https://prometheus.io/docs/operating/configuration/#endpoints'
+ description: 'BasicAuth allow an endpoint to authenticate over basic authentication More info: https://prometheus.io/docs/operating/configuration/#endpoints'
properties:
password:
- description: The secret in the service monitor namespace
- that contains the password for authentication.
+ description: The secret in the service monitor namespace that contains the password for authentication.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
username:
- description: The secret in the service monitor namespace
- that contains the username for authentication.
+ description: The secret in the service monitor namespace that contains the username for authentication.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -131,21 +109,16 @@ spec:
description: File to read bearer token for scraping targets.
type: string
bearerTokenSecret:
- description: Secret to mount to read bearer token for scraping
- targets. The secret needs to be in the same namespace as the
- service monitor and accessible by the Prometheus Operator.
+ description: Secret to mount to read bearer token for scraping targets. The secret needs to be in the same namespace as the service monitor and accessible by the Prometheus Operator.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -155,40 +128,29 @@ spec:
description: Whether to enable HTTP2.
type: boolean
filterRunning:
- description: 'Drop pods that are not running. (Failed, Succeeded).
- Enabled by default. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase'
+ description: 'Drop pods that are not running. (Failed, Succeeded). Enabled by default. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase'
type: boolean
followRedirects:
- description: FollowRedirects configures whether scrape requests
- follow HTTP 3xx redirects.
+ description: FollowRedirects configures whether scrape requests follow HTTP 3xx redirects.
type: boolean
honorLabels:
- description: HonorLabels chooses the metric's labels on collisions
- with target labels.
+ description: HonorLabels chooses the metric's labels on collisions with target labels.
type: boolean
honorTimestamps:
- description: HonorTimestamps controls whether Prometheus respects
- the timestamps present in scraped data.
+ description: HonorTimestamps controls whether Prometheus respects the timestamps present in scraped data.
type: boolean
interval:
- description: Interval at which metrics should be scraped If
- not specified Prometheus' global scrape interval is used.
+ description: Interval at which metrics should be scraped If not specified Prometheus' global scrape interval is used.
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
metricRelabelings:
- description: MetricRelabelConfigs to apply to samples before
- ingestion.
+ description: MetricRelabelConfigs to apply to samples before ingestion.
items:
- description: 'RelabelConfig allows dynamic rewriting of the
- label set, being applied to samples before ingestion. It
- defines `<metric_relabel_configs>`-section of Prometheus
- configuration. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs'
+ description: 'RelabelConfig allows dynamic rewriting of the label set, being applied to samples before ingestion. It defines `<metric_relabel_configs>`-section of Prometheus configuration. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs'
properties:
action:
default: replace
- description: Action to perform based on regex matching.
- Default is 'replace'. uppercase and lowercase actions
- require Prometheus >= 2.36.
+ description: Action to perform based on regex matching. Default is 'replace'. uppercase and lowercase actions require Prometheus >= 2.36.
enum:
- replace
- Replace
@@ -214,65 +176,47 @@ spec:
- DropEqual
type: string
modulus:
- description: Modulus to take of the hash of the source
- label values.
+ description: Modulus to take of the hash of the source label values.
format: int64
type: integer
regex:
- description: Regular expression against which the extracted
- value is matched. Default is '(.*)'
+ description: Regular expression against which the extracted value is matched. Default is '(.*)'
type: string
replacement:
- description: Replacement value against which a regex replace
- is performed if the regular expression matches. Regex
- capture groups are available. Default is '$1'
+ description: Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Default is '$1'
type: string
separator:
- description: Separator placed between concatenated source
- label values. default is ';'.
+ description: Separator placed between concatenated source label values. default is ';'.
type: string
sourceLabels:
- description: The source labels select values from existing
- labels. Their content is concatenated using the configured
- separator and matched against the configured regular
- expression for the replace, keep, and drop actions.
+ description: The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions.
items:
- description: LabelName is a valid Prometheus label name
- which may only contain ASCII letters, numbers, as
- well as underscores.
+ description: LabelName is a valid Prometheus label name which may only contain ASCII letters, numbers, as well as underscores.
pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$
type: string
type: array
targetLabel:
- description: Label to which the resulting value is written
- in a replace action. It is mandatory for replace actions.
- Regex capture groups are available.
+ description: Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available.
type: string
type: object
type: array
oauth2:
- description: OAuth2 for the URL. Only valid in Prometheus versions
- 2.27.0 and newer.
+ description: OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer.
properties:
clientId:
- description: The secret or configmap containing the OAuth2
- client id
+ description: The secret or configmap containing the OAuth2 client id
properties:
configMap:
- description: ConfigMap containing data to use for the
- targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its
- key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
@@ -282,17 +226,13 @@ spec:
description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -303,16 +243,13 @@ spec:
description: The secret containing the OAuth2 client secret
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -345,34 +282,22 @@ spec:
description: Optional HTTP URL parameters
type: object
path:
- description: HTTP path to scrape for metrics. If empty, Prometheus
- uses the default value (e.g. `/metrics`).
+ description: HTTP path to scrape for metrics. If empty, Prometheus uses the default value (e.g. `/metrics`).
type: string
port:
- description: Name of the service port this endpoint refers to.
- Mutually exclusive with targetPort.
+ description: Name of the service port this endpoint refers to. Mutually exclusive with targetPort.
type: string
proxyUrl:
- description: ProxyURL eg http://proxyserver:2195 Directs scrapes
- to proxy through this endpoint.
+ description: ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint.
type: string
relabelings:
- description: 'RelabelConfigs to apply to samples before scraping.
- Prometheus Operator automatically adds relabelings for a few
- standard Kubernetes fields. The original scrape job''s name
- is available via the `__tmp_prometheus_job_name` label. More
- info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config'
+ description: 'RelabelConfigs to apply to samples before scraping. Prometheus Operator automatically adds relabelings for a few standard Kubernetes fields. The original scrape job''s name is available via the `__tmp_prometheus_job_name` label. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config'
items:
- description: 'RelabelConfig allows dynamic rewriting of the
- label set, being applied to samples before ingestion. It
- defines `<metric_relabel_configs>`-section of Prometheus
- configuration. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs'
+ description: 'RelabelConfig allows dynamic rewriting of the label set, being applied to samples before ingestion. It defines `<metric_relabel_configs>`-section of Prometheus configuration. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs'
properties:
action:
default: replace
- description: Action to perform based on regex matching.
- Default is 'replace'. uppercase and lowercase actions
- require Prometheus >= 2.36.
+ description: Action to perform based on regex matching. Default is 'replace'. uppercase and lowercase actions require Prometheus >= 2.36.
enum:
- replace
- Replace
@@ -398,39 +323,27 @@ spec:
- DropEqual
type: string
modulus:
- description: Modulus to take of the hash of the source
- label values.
+ description: Modulus to take of the hash of the source label values.
format: int64
type: integer
regex:
- description: Regular expression against which the extracted
- value is matched. Default is '(.*)'
+ description: Regular expression against which the extracted value is matched. Default is '(.*)'
type: string
replacement:
- description: Replacement value against which a regex replace
- is performed if the regular expression matches. Regex
- capture groups are available. Default is '$1'
+ description: Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Default is '$1'
type: string
separator:
- description: Separator placed between concatenated source
- label values. default is ';'.
+ description: Separator placed between concatenated source label values. default is ';'.
type: string
sourceLabels:
- description: The source labels select values from existing
- labels. Their content is concatenated using the configured
- separator and matched against the configured regular
- expression for the replace, keep, and drop actions.
+ description: The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions.
items:
- description: LabelName is a valid Prometheus label name
- which may only contain ASCII letters, numbers, as
- well as underscores.
+ description: LabelName is a valid Prometheus label name which may only contain ASCII letters, numbers, as well as underscores.
pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$
type: string
type: array
targetLabel:
- description: Label to which the resulting value is written
- in a replace action. It is mandatory for replace actions.
- Regex capture groups are available.
+ description: Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available.
type: string
type: object
type: array
@@ -438,41 +351,32 @@ spec:
description: HTTP scheme to use for scraping.
type: string
scrapeTimeout:
- description: Timeout after which the scrape is ended If not
- specified, the Prometheus global scrape timeout is used unless
- it is less than `Interval` in which the latter is used.
+ description: Timeout after which the scrape is ended If not specified, the Prometheus global scrape timeout is used unless it is less than `Interval` in which the latter is used.
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
targetPort:
anyOf:
- type: integer
- type: string
- description: Name or number of the target port of the Pod behind
- the Service, the port must be specified with container port
- property. Mutually exclusive with port.
+ description: Name or number of the target port of the Pod behind the Service, the port must be specified with container port property. Mutually exclusive with port.
x-kubernetes-int-or-string: true
tlsConfig:
description: TLS configuration to use when scraping the endpoint
properties:
ca:
- description: Certificate authority used when verifying server
- certificates.
+ description: Certificate authority used when verifying server certificates.
properties:
configMap:
- description: ConfigMap containing data to use for the
- targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its
- key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
@@ -482,17 +386,13 @@ spec:
description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -500,27 +400,22 @@ spec:
x-kubernetes-map-type: atomic
type: object
caFile:
- description: Path to the CA cert in the Prometheus container
- to use for the targets.
+ description: Path to the CA cert in the Prometheus container to use for the targets.
type: string
cert:
description: Client certificate to present when doing client-authentication.
properties:
configMap:
- description: ConfigMap containing data to use for the
- targets.
+ description: ConfigMap containing data to use for the targets.
properties:
key:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its
- key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
@@ -530,17 +425,13 @@ spec:
description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key
- must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -548,31 +439,25 @@ spec:
x-kubernetes-map-type: atomic
type: object
certFile:
- description: Path to the client cert file in the Prometheus
- container for the targets.
+ description: Path to the client cert file in the Prometheus container for the targets.
type: string
insecureSkipVerify:
description: Disable target certificate validation.
type: boolean
keyFile:
- description: Path to the client key file in the Prometheus
- container for the targets.
+ description: Path to the client key file in the Prometheus container for the targets.
type: string
keySecret:
- description: Secret containing the client key file for the
- targets.
+ description: Secret containing the client key file for the targets.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -585,38 +470,25 @@ spec:
type: object
type: array
jobLabel:
- description: "JobLabel selects the label from the associated Kubernetes
- service which will be used as the `job` label for all metrics. \n
- For example: If in `ServiceMonitor.spec.jobLabel: foo` and in `Service.metadata.labels.foo:
- bar`, then the `job=\"bar\"` label is added to all metrics. \n If
- the value of this field is empty or if the label doesn't exist for
- the given Service, the `job` label of the metrics defaults to the
- name of the Kubernetes Service."
+ description: "JobLabel selects the label from the associated Kubernetes service which will be used as the `job` label for all metrics. \n For example: If in `ServiceMonitor.spec.jobLabel: foo` and in `Service.metadata.labels.foo: bar`, then the `job=\"bar\"` label is added to all metrics. \n If the value of this field is empty or if the label doesn't exist for the given Service, the `job` label of the metrics defaults to the name of the Kubernetes Service."
type: string
labelLimit:
- description: Per-scrape limit on number of labels that will be accepted
- for a sample. Only valid in Prometheus versions 2.27.0 and newer.
+ description: Per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.
format: int64
type: integer
labelNameLengthLimit:
- description: Per-scrape limit on length of labels name that will be
- accepted for a sample. Only valid in Prometheus versions 2.27.0
- and newer.
+ description: Per-scrape limit on length of labels name that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.
format: int64
type: integer
labelValueLengthLimit:
- description: Per-scrape limit on length of labels value that will
- be accepted for a sample. Only valid in Prometheus versions 2.27.0
- and newer.
+ description: Per-scrape limit on length of labels value that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.
format: int64
type: integer
namespaceSelector:
- description: Selector to select which namespaces the Kubernetes Endpoints
- objects are discovered from.
+ description: Selector to select which namespaces the Kubernetes Endpoints objects are discovered from.
properties:
any:
- description: Boolean describing whether all namespaces are selected
- in contrast to a list restricting them.
+ description: Boolean describing whether all namespaces are selected in contrast to a list restricting them.
type: boolean
matchNames:
description: List of namespace names to select from.
@@ -625,42 +497,30 @@ spec:
type: array
type: object
podTargetLabels:
- description: PodTargetLabels transfers labels on the Kubernetes `Pod`
- onto the created metrics.
+ description: PodTargetLabels transfers labels on the Kubernetes `Pod` onto the created metrics.
items:
type: string
type: array
sampleLimit:
- description: SampleLimit defines per-scrape limit on number of scraped
- samples that will be accepted.
+ description: SampleLimit defines per-scrape limit on number of scraped samples that will be accepted.
format: int64
type: integer
selector:
description: Selector to select Endpoints objects.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements.
- The requirements are ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a selector that
- contains values, a key, and an operator that relates the key
- and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the selector applies
- to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship to
- a set of values. Valid operators are In, NotIn, Exists
- and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string values. If the
- operator is In or NotIn, the values array must be non-empty.
- If the operator is Exists or DoesNotExist, the values
- array must be empty. This array is replaced during a strategic
- merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -672,23 +532,17 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value} pairs. A single
- {key,value} in the matchLabels map is equivalent to an element
- of matchExpressions, whose key field is "key", the operator
- is "In", and the values array contains only "value". The requirements
- are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
targetLabels:
- description: TargetLabels transfers labels from the Kubernetes `Service`
- onto the created metrics.
+ description: TargetLabels transfers labels from the Kubernetes `Service` onto the created metrics.
items:
type: string
type: array
targetLimit:
- description: TargetLimit defines a limit on the number of scraped
- targets that will be accepted.
+ description: TargetLimit defines a limit on the number of scraped targets that will be accepted.
format: int64
type: integer
required:
diff --git a/manifests/setup/0thanosrulerCustomResourceDefinition.yaml b/manifests/setup/0thanosrulerCustomResourceDefinition.yaml
index ee460dbb2357d0ef19377cba9750a01ce5b20120..837188f664cb9679fbc5953cc5567cd855b0f850 100644
--- a/manifests/setup/0thanosrulerCustomResourceDefinition.yaml
+++ b/manifests/setup/0thanosrulerCustomResourceDefinition.yaml
@@ -37,31 +37,18 @@ spec:
description: ThanosRuler defines a ThanosRuler deployment.
properties:
apiVersion:
- description: 'APIVersion defines the versioned schema of this representation
- of an object. Servers should convert recognized schemas to the latest
- internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+ description: 'APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: 'Kind is a string value representing the REST resource this
- object represents. Servers may infer this from the endpoint the client
- submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+ description: 'Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
spec:
- description: 'Specification of the desired behavior of the ThanosRuler
- cluster. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status'
+ description: 'Specification of the desired behavior of the ThanosRuler cluster. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status'
properties:
additionalArgs:
- description: AdditionalArgs allows setting additional arguments for
- the ThanosRuler container. It is intended for e.g. activating hidden
- flags which are not supported by the dedicated configuration options
- yet. The arguments are passed as-is to the ThanosRuler container
- which may cause issues if they are invalid or not supported by the
- given ThanosRuler version. In case of an argument conflict (e.g.
- an argument which is already set by the operator itself) or when
- providing an invalid argument the reconciliation will fail and an
- error will be logged.
+ description: AdditionalArgs allows setting additional arguments for the ThanosRuler container. It is intended for e.g. activating hidden flags which are not supported by the dedicated configuration options yet. The arguments are passed as-is to the ThanosRuler container which may cause issues if they are invalid or not supported by the given ThanosRuler version. In case of an argument conflict (e.g. an argument which is already set by the operator itself) or when providing an invalid argument the reconciliation will fail and an error will be logged.
items:
description: Argument as part of the AdditionalArgs list.
properties:
@@ -70,8 +57,7 @@ spec:
minLength: 1
type: string
value:
- description: Argument value, e.g. 30s. Can be empty for name-only
- arguments (e.g. --storage.tsdb.no-lockfile)
+ description: Argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile)
type: string
required:
- name
@@ -81,59 +67,29 @@ spec:
description: If specified, the pod's scheduling constraints.
properties:
nodeAffinity:
- description: Describes node affinity scheduling rules for the
- pod.
+ description: Describes node affinity scheduling rules for the pod.
properties:
preferredDuringSchedulingIgnoredDuringExecution:
- description: The scheduler will prefer to schedule pods to
- nodes that satisfy the affinity expressions specified by
- this field, but it may choose a node that violates one or
- more of the expressions. The node that is most preferred
- is the one with the greatest sum of weights, i.e. for each
- node that meets all of the scheduling requirements (resource
- request, requiredDuringScheduling affinity expressions,
- etc.), compute a sum by iterating through the elements of
- this field and adding "weight" to the sum if the node matches
- the corresponding matchExpressions; the node(s) with the
- highest sum are the most preferred.
+ description: The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.
items:
- description: An empty preferred scheduling term matches
- all objects with implicit weight 0 (i.e. it's a no-op).
- A null preferred scheduling term matches no objects (i.e.
- is also a no-op).
+ description: An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
properties:
preference:
- description: A node selector term, associated with the
- corresponding weight.
+ description: A node selector term, associated with the corresponding weight.
properties:
matchExpressions:
- description: A list of node selector requirements
- by node's labels.
+ description: A list of node selector requirements by node's labels.
items:
- description: A node selector requirement is a
- selector that contains values, a key, and an
- operator that relates the key and values.
+ description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: The label key that the selector
- applies to.
+ description: The label key that the selector applies to.
type: string
operator:
- description: Represents a key's relationship
- to a set of values. Valid operators are
- In, NotIn, Exists, DoesNotExist. Gt, and
- Lt.
+ description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
type: string
values:
- description: An array of string values. If
- the operator is In or NotIn, the values
- array must be non-empty. If the operator
- is Exists or DoesNotExist, the values array
- must be empty. If the operator is Gt or
- Lt, the values array must have a single
- element, which will be interpreted as an
- integer. This array is replaced during a
- strategic merge patch.
+ description: An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -143,33 +99,18 @@ spec:
type: object
type: array
matchFields:
- description: A list of node selector requirements
- by node's fields.
+ description: A list of node selector requirements by node's fields.
items:
- description: A node selector requirement is a
- selector that contains values, a key, and an
- operator that relates the key and values.
+ description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: The label key that the selector
- applies to.
+ description: The label key that the selector applies to.
type: string
operator:
- description: Represents a key's relationship
- to a set of values. Valid operators are
- In, NotIn, Exists, DoesNotExist. Gt, and
- Lt.
+ description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
type: string
values:
- description: An array of string values. If
- the operator is In or NotIn, the values
- array must be non-empty. If the operator
- is Exists or DoesNotExist, the values array
- must be empty. If the operator is Gt or
- Lt, the values array must have a single
- element, which will be interpreted as an
- integer. This array is replaced during a
- strategic merge patch.
+ description: An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -181,8 +122,7 @@ spec:
type: object
x-kubernetes-map-type: atomic
weight:
- description: Weight associated with matching the corresponding
- nodeSelectorTerm, in the range 1-100.
+ description: Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
format: int32
type: integer
required:
@@ -191,50 +131,26 @@ spec:
type: object
type: array
requiredDuringSchedulingIgnoredDuringExecution:
- description: If the affinity requirements specified by this
- field are not met at scheduling time, the pod will not be
- scheduled onto the node. If the affinity requirements specified
- by this field cease to be met at some point during pod execution
- (e.g. due to an update), the system may or may not try to
- eventually evict the pod from its node.
+ description: If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.
properties:
nodeSelectorTerms:
- description: Required. A list of node selector terms.
- The terms are ORed.
+ description: Required. A list of node selector terms. The terms are ORed.
items:
- description: A null or empty node selector term matches
- no objects. The requirements of them are ANDed. The
- TopologySelectorTerm type implements a subset of the
- NodeSelectorTerm.
+ description: A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
properties:
matchExpressions:
- description: A list of node selector requirements
- by node's labels.
+ description: A list of node selector requirements by node's labels.
items:
- description: A node selector requirement is a
- selector that contains values, a key, and an
- operator that relates the key and values.
+ description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: The label key that the selector
- applies to.
+ description: The label key that the selector applies to.
type: string
operator:
- description: Represents a key's relationship
- to a set of values. Valid operators are
- In, NotIn, Exists, DoesNotExist. Gt, and
- Lt.
+ description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
type: string
values:
- description: An array of string values. If
- the operator is In or NotIn, the values
- array must be non-empty. If the operator
- is Exists or DoesNotExist, the values array
- must be empty. If the operator is Gt or
- Lt, the values array must have a single
- element, which will be interpreted as an
- integer. This array is replaced during a
- strategic merge patch.
+ description: An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -244,33 +160,18 @@ spec:
type: object
type: array
matchFields:
- description: A list of node selector requirements
- by node's fields.
+ description: A list of node selector requirements by node's fields.
items:
- description: A node selector requirement is a
- selector that contains values, a key, and an
- operator that relates the key and values.
+ description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: The label key that the selector
- applies to.
+ description: The label key that the selector applies to.
type: string
operator:
- description: Represents a key's relationship
- to a set of values. Valid operators are
- In, NotIn, Exists, DoesNotExist. Gt, and
- Lt.
+ description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
type: string
values:
- description: An array of string values. If
- the operator is In or NotIn, the values
- array must be non-empty. If the operator
- is Exists or DoesNotExist, the values array
- must be empty. If the operator is Gt or
- Lt, the values array must have a single
- element, which will be interpreted as an
- integer. This array is replaced during a
- strategic merge patch.
+ description: An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -288,61 +189,32 @@ spec:
x-kubernetes-map-type: atomic
type: object
podAffinity:
- description: Describes pod affinity scheduling rules (e.g. co-locate
- this pod in the same node, zone, etc. as some other pod(s)).
+ description: Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
properties:
preferredDuringSchedulingIgnoredDuringExecution:
- description: The scheduler will prefer to schedule pods to
- nodes that satisfy the affinity expressions specified by
- this field, but it may choose a node that violates one or
- more of the expressions. The node that is most preferred
- is the one with the greatest sum of weights, i.e. for each
- node that meets all of the scheduling requirements (resource
- request, requiredDuringScheduling affinity expressions,
- etc.), compute a sum by iterating through the elements of
- this field and adding "weight" to the sum if the node has
- pods which matches the corresponding podAffinityTerm; the
- node(s) with the highest sum are the most preferred.
+ description: The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
items:
- description: The weights of all of the matched WeightedPodAffinityTerm
- fields are added per-node to find the most preferred node(s)
+ description: The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
properties:
podAffinityTerm:
- description: Required. A pod affinity term, associated
- with the corresponding weight.
+ description: Required. A pod affinity term, associated with the corresponding weight.
properties:
labelSelector:
- description: A label query over a set of resources,
- in this case pods.
+ description: A label query over a set of resources, in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label
- selector requirements. The requirements are
- ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement
- is a selector that contains values, a key,
- and an operator that relates the key and
- values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that
- the selector applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's
- relationship to a set of values. Valid
- operators are In, NotIn, Exists and
- DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string
- values. If the operator is In or NotIn,
- the values array must be non-empty.
- If the operator is Exists or DoesNotExist,
- the values array must be empty. This
- array is replaced during a strategic
- merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -354,52 +226,26 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value}
- pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions,
- whose key field is "key", the operator is
- "In", and the values array contains only "value".
- The requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
namespaceSelector:
- description: A label query over the set of namespaces
- that the term applies to. The term is applied
- to the union of the namespaces selected by this
- field and the ones listed in the namespaces field.
- null selector and null or empty namespaces list
- means "this pod's namespace". An empty selector
- ({}) matches all namespaces.
+ description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
properties:
matchExpressions:
- description: matchExpressions is a list of label
- selector requirements. The requirements are
- ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement
- is a selector that contains values, a key,
- and an operator that relates the key and
- values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that
- the selector applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's
- relationship to a set of values. Valid
- operators are In, NotIn, Exists and
- DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string
- values. If the operator is In or NotIn,
- the values array must be non-empty.
- If the operator is Exists or DoesNotExist,
- the values array must be empty. This
- array is replaced during a strategic
- merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -411,40 +257,23 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value}
- pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions,
- whose key field is "key", the operator is
- "In", and the values array contains only "value".
- The requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
namespaces:
- description: namespaces specifies a static list
- of namespace names that the term applies to. The
- term is applied to the union of the namespaces
- listed in this field and the ones selected by
- namespaceSelector. null or empty namespaces list
- and null namespaceSelector means "this pod's namespace".
+ description: namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity)
- or not co-located (anti-affinity) with the pods
- matching the labelSelector in the specified namespaces,
- where co-located is defined as running on a node
- whose value of the label with key topologyKey
- matches that of any node on which any of the selected
- pods is running. Empty topologyKey is not allowed.
+ description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
type: string
required:
- topologyKey
type: object
weight:
- description: weight associated with matching the corresponding
- podAffinityTerm, in the range 1-100.
+ description: weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
format: int32
type: integer
required:
@@ -453,52 +282,26 @@ spec:
type: object
type: array
requiredDuringSchedulingIgnoredDuringExecution:
- description: If the affinity requirements specified by this
- field are not met at scheduling time, the pod will not be
- scheduled onto the node. If the affinity requirements specified
- by this field cease to be met at some point during pod execution
- (e.g. due to a pod label update), the system may or may
- not try to eventually evict the pod from its node. When
- there are multiple elements, the lists of nodes corresponding
- to each podAffinityTerm are intersected, i.e. all terms
- must be satisfied.
+ description: If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
items:
- description: Defines a set of pods (namely those matching
- the labelSelector relative to the given namespace(s))
- that this pod should be co-located (affinity) or not co-located
- (anti-affinity) with, where co-located is defined as running
- on a node whose value of the label with key <topologyKey>
- matches that of any node on which a pod of the set of
- pods is running
+ description: Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
properties:
labelSelector:
- description: A label query over a set of resources,
- in this case pods.
+ description: A label query over a set of resources, in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label
- selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a
- selector that contains values, a key, and an
- operator that relates the key and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the
- selector applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship
- to a set of values. Valid operators are
- In, NotIn, Exists and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string
- values. If the operator is In or NotIn,
- the values array must be non-empty. If the
- operator is Exists or DoesNotExist, the
- values array must be empty. This array is
- replaced during a strategic merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -510,47 +313,26 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value}
- pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions,
- whose key field is "key", the operator is "In",
- and the values array contains only "value". The
- requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
namespaceSelector:
- description: A label query over the set of namespaces
- that the term applies to. The term is applied to the
- union of the namespaces selected by this field and
- the ones listed in the namespaces field. null selector
- and null or empty namespaces list means "this pod's
- namespace". An empty selector ({}) matches all namespaces.
+ description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
properties:
matchExpressions:
- description: matchExpressions is a list of label
- selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a
- selector that contains values, a key, and an
- operator that relates the key and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the
- selector applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship
- to a set of values. Valid operators are
- In, NotIn, Exists and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string
- values. If the operator is In or NotIn,
- the values array must be non-empty. If the
- operator is Exists or DoesNotExist, the
- values array must be empty. This array is
- replaced during a strategic merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -562,33 +344,17 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value}
- pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions,
- whose key field is "key", the operator is "In",
- and the values array contains only "value". The
- requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
namespaces:
- description: namespaces specifies a static list of namespace
- names that the term applies to. The term is applied
- to the union of the namespaces listed in this field
- and the ones selected by namespaceSelector. null or
- empty namespaces list and null namespaceSelector means
- "this pod's namespace".
+ description: namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity)
- or not co-located (anti-affinity) with the pods matching
- the labelSelector in the specified namespaces, where
- co-located is defined as running on a node whose value
- of the label with key topologyKey matches that of
- any node on which any of the selected pods is running.
- Empty topologyKey is not allowed.
+ description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
type: string
required:
- topologyKey
@@ -596,62 +362,32 @@ spec:
type: array
type: object
podAntiAffinity:
- description: Describes pod anti-affinity scheduling rules (e.g.
- avoid putting this pod in the same node, zone, etc. as some
- other pod(s)).
+ description: Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
properties:
preferredDuringSchedulingIgnoredDuringExecution:
- description: The scheduler will prefer to schedule pods to
- nodes that satisfy the anti-affinity expressions specified
- by this field, but it may choose a node that violates one
- or more of the expressions. The node that is most preferred
- is the one with the greatest sum of weights, i.e. for each
- node that meets all of the scheduling requirements (resource
- request, requiredDuringScheduling anti-affinity expressions,
- etc.), compute a sum by iterating through the elements of
- this field and adding "weight" to the sum if the node has
- pods which matches the corresponding podAffinityTerm; the
- node(s) with the highest sum are the most preferred.
+ description: The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
items:
- description: The weights of all of the matched WeightedPodAffinityTerm
- fields are added per-node to find the most preferred node(s)
+ description: The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
properties:
podAffinityTerm:
- description: Required. A pod affinity term, associated
- with the corresponding weight.
+ description: Required. A pod affinity term, associated with the corresponding weight.
properties:
labelSelector:
- description: A label query over a set of resources,
- in this case pods.
+ description: A label query over a set of resources, in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label
- selector requirements. The requirements are
- ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement
- is a selector that contains values, a key,
- and an operator that relates the key and
- values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that
- the selector applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's
- relationship to a set of values. Valid
- operators are In, NotIn, Exists and
- DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string
- values. If the operator is In or NotIn,
- the values array must be non-empty.
- If the operator is Exists or DoesNotExist,
- the values array must be empty. This
- array is replaced during a strategic
- merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -663,52 +399,26 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value}
- pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions,
- whose key field is "key", the operator is
- "In", and the values array contains only "value".
- The requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
namespaceSelector:
- description: A label query over the set of namespaces
- that the term applies to. The term is applied
- to the union of the namespaces selected by this
- field and the ones listed in the namespaces field.
- null selector and null or empty namespaces list
- means "this pod's namespace". An empty selector
- ({}) matches all namespaces.
+ description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
properties:
matchExpressions:
- description: matchExpressions is a list of label
- selector requirements. The requirements are
- ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement
- is a selector that contains values, a key,
- and an operator that relates the key and
- values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that
- the selector applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's
- relationship to a set of values. Valid
- operators are In, NotIn, Exists and
- DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string
- values. If the operator is In or NotIn,
- the values array must be non-empty.
- If the operator is Exists or DoesNotExist,
- the values array must be empty. This
- array is replaced during a strategic
- merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -720,40 +430,23 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value}
- pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions,
- whose key field is "key", the operator is
- "In", and the values array contains only "value".
- The requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
namespaces:
- description: namespaces specifies a static list
- of namespace names that the term applies to. The
- term is applied to the union of the namespaces
- listed in this field and the ones selected by
- namespaceSelector. null or empty namespaces list
- and null namespaceSelector means "this pod's namespace".
+ description: namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity)
- or not co-located (anti-affinity) with the pods
- matching the labelSelector in the specified namespaces,
- where co-located is defined as running on a node
- whose value of the label with key topologyKey
- matches that of any node on which any of the selected
- pods is running. Empty topologyKey is not allowed.
+ description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
type: string
required:
- topologyKey
type: object
weight:
- description: weight associated with matching the corresponding
- podAffinityTerm, in the range 1-100.
+ description: weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
format: int32
type: integer
required:
@@ -762,52 +455,26 @@ spec:
type: object
type: array
requiredDuringSchedulingIgnoredDuringExecution:
- description: If the anti-affinity requirements specified by
- this field are not met at scheduling time, the pod will
- not be scheduled onto the node. If the anti-affinity requirements
- specified by this field cease to be met at some point during
- pod execution (e.g. due to a pod label update), the system
- may or may not try to eventually evict the pod from its
- node. When there are multiple elements, the lists of nodes
- corresponding to each podAffinityTerm are intersected, i.e.
- all terms must be satisfied.
+ description: If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
items:
- description: Defines a set of pods (namely those matching
- the labelSelector relative to the given namespace(s))
- that this pod should be co-located (affinity) or not co-located
- (anti-affinity) with, where co-located is defined as running
- on a node whose value of the label with key <topologyKey>
- matches that of any node on which a pod of the set of
- pods is running
+ description: Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
properties:
labelSelector:
- description: A label query over a set of resources,
- in this case pods.
+ description: A label query over a set of resources, in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label
- selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a
- selector that contains values, a key, and an
- operator that relates the key and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the
- selector applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship
- to a set of values. Valid operators are
- In, NotIn, Exists and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string
- values. If the operator is In or NotIn,
- the values array must be non-empty. If the
- operator is Exists or DoesNotExist, the
- values array must be empty. This array is
- replaced during a strategic merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -819,47 +486,26 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value}
- pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions,
- whose key field is "key", the operator is "In",
- and the values array contains only "value". The
- requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
namespaceSelector:
- description: A label query over the set of namespaces
- that the term applies to. The term is applied to the
- union of the namespaces selected by this field and
- the ones listed in the namespaces field. null selector
- and null or empty namespaces list means "this pod's
- namespace". An empty selector ({}) matches all namespaces.
+ description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
properties:
matchExpressions:
- description: matchExpressions is a list of label
- selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a
- selector that contains values, a key, and an
- operator that relates the key and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the
- selector applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship
- to a set of values. Valid operators are
- In, NotIn, Exists and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string
- values. If the operator is In or NotIn,
- the values array must be non-empty. If the
- operator is Exists or DoesNotExist, the
- values array must be empty. This array is
- replaced during a strategic merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -871,33 +517,17 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value}
- pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions,
- whose key field is "key", the operator is "In",
- and the values array contains only "value". The
- requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
namespaces:
- description: namespaces specifies a static list of namespace
- names that the term applies to. The term is applied
- to the union of the namespaces listed in this field
- and the ones selected by namespaceSelector. null or
- empty namespaces list and null namespaceSelector means
- "this pod's namespace".
+ description: namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity)
- or not co-located (anti-affinity) with the pods matching
- the labelSelector in the specified namespaces, where
- co-located is defined as running on a node whose value
- of the label with key topologyKey matches that of
- any node on which any of the selected pods is running.
- Empty topologyKey is not allowed.
+ description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
type: string
required:
- topologyKey
@@ -906,35 +536,24 @@ spec:
type: object
type: object
alertDropLabels:
- description: AlertDropLabels configure the label names which should
- be dropped in ThanosRuler alerts. The replica label `thanos_ruler_replica`
- will always be dropped in alerts.
+ description: AlertDropLabels configure the label names which should be dropped in ThanosRuler alerts. The replica label `thanos_ruler_replica` will always be dropped in alerts.
items:
type: string
type: array
alertQueryUrl:
- description: The external Query URL the Thanos Ruler will set in the
- 'Source' field of all alerts. Maps to the '--alert.query-url' CLI
- arg.
+ description: The external Query URL the Thanos Ruler will set in the 'Source' field of all alerts. Maps to the '--alert.query-url' CLI arg.
type: string
alertRelabelConfigFile:
- description: AlertRelabelConfigFile specifies the path of the alert
- relabeling configuration file. When used alongside with AlertRelabelConfigs,
- alertRelabelConfigFile takes precedence.
+ description: AlertRelabelConfigFile specifies the path of the alert relabeling configuration file. When used alongside with AlertRelabelConfigs, alertRelabelConfigFile takes precedence.
type: string
alertRelabelConfigs:
- description: 'AlertRelabelConfigs configures alert relabeling in ThanosRuler.
- Alert relabel configurations must have the form as specified in
- the official Prometheus documentation: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs
- Alternative to AlertRelabelConfigFile, and lower order priority.'
+ description: 'AlertRelabelConfigs configures alert relabeling in ThanosRuler. Alert relabel configurations must have the form as specified in the official Prometheus documentation: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs Alternative to AlertRelabelConfigFile, and lower order priority.'
properties:
key:
- description: The key of the secret to select from. Must be a
- valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
description: Specify whether the Secret or its key must be defined
@@ -944,17 +563,13 @@ spec:
type: object
x-kubernetes-map-type: atomic
alertmanagersConfig:
- description: Define configuration for connecting to alertmanager. Only
- available with thanos v0.10.0 and higher. Maps to the `alertmanagers.config`
- arg.
+ description: Define configuration for connecting to alertmanager. Only available with thanos v0.10.0 and higher. Maps to the `alertmanagers.config` arg.
properties:
key:
- description: The key of the secret to select from. Must be a
- valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
description: Specify whether the Secret or its key must be defined
@@ -964,81 +579,38 @@ spec:
type: object
x-kubernetes-map-type: atomic
alertmanagersUrl:
- description: 'Define URLs to send alerts to Alertmanager. For Thanos
- v0.10.0 and higher, AlertManagersConfig should be used instead. Note:
- this field will be ignored if AlertManagersConfig is specified.
- Maps to the `alertmanagers.url` arg.'
+ description: 'Define URLs to send alerts to Alertmanager. For Thanos v0.10.0 and higher, AlertManagersConfig should be used instead. Note: this field will be ignored if AlertManagersConfig is specified. Maps to the `alertmanagers.url` arg.'
items:
type: string
type: array
containers:
- description: 'Containers allows injecting additional containers or
- modifying operator generated containers. This can be used to allow
- adding an authentication proxy to a ThanosRuler pod or to change
- the behavior of an operator generated container. Containers described
- here modify an operator generated container if they share the same
- name and modifications are done via a strategic merge patch. The
- current container names are: `thanos-ruler` and `config-reloader`.
- Overriding containers is entirely outside the scope of what the
- maintainers will support and by doing so, you accept that this behaviour
- may break at any time without notice.'
+ description: 'Containers allows injecting additional containers or modifying operator generated containers. This can be used to allow adding an authentication proxy to a ThanosRuler pod or to change the behavior of an operator generated container. Containers described here modify an operator generated container if they share the same name and modifications are done via a strategic merge patch. The current container names are: `thanos-ruler` and `config-reloader`. Overriding containers is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice.'
items:
- description: A single application container that you want to run
- within a pod.
+ description: A single application container that you want to run within a pod.
properties:
args:
- description: 'Arguments to the entrypoint. The container image''s
- CMD is used if this is not provided. Variable references $(VAR_NAME)
- are expanded using the container''s environment. If a variable
- cannot be resolved, the reference in the input string will
- be unchanged. Double $$ are reduced to a single $, which allows
- for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references
- will never be expanded, regardless of whether the variable
- exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
+ description: 'Arguments to the entrypoint. The container image''s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container''s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
command:
- description: 'Entrypoint array. Not executed within a shell.
- The container image''s ENTRYPOINT is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container''s
- environment. If a variable cannot be resolved, the reference
- in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax:
- i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
- Escaped references will never be expanded, regardless of whether
- the variable exists or not. Cannot be updated. More info:
- https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
+ description: 'Entrypoint array. Not executed within a shell. The container image''s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container''s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
env:
- description: List of environment variables to set in the container.
- Cannot be updated.
+ description: List of environment variables to set in the container. Cannot be updated.
items:
- description: EnvVar represents an environment variable present
- in a Container.
+ description: EnvVar represents an environment variable present in a Container.
properties:
name:
- description: Name of the environment variable. Must be
- a C_IDENTIFIER.
+ description: Name of the environment variable. Must be a C_IDENTIFIER.
type: string
value:
- description: 'Variable references $(VAR_NAME) are expanded
- using the previously defined environment variables in
- the container and any service environment variables.
- If a variable cannot be resolved, the reference in the
- input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME)
- syntax: i.e. "$$(VAR_NAME)" will produce the string
- literal "$(VAR_NAME)". Escaped references will never
- be expanded, regardless of whether the variable exists
- or not. Defaults to "".'
+ description: 'Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".'
type: string
valueFrom:
- description: Source for the environment variable's value.
- Cannot be used if value is not empty.
+ description: Source for the environment variable's value. Cannot be used if value is not empty.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -1047,55 +619,39 @@ spec:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or
- its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
fieldRef:
- description: 'Selects a field of the pod: supports
- metadata.name, metadata.namespace, `metadata.labels[''<KEY>'']`,
- `metadata.annotations[''<KEY>'']`, spec.nodeName,
- spec.serviceAccountName, status.hostIP, status.podIP,
- status.podIPs.'
+ description: 'Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels[''<KEY>'']`, `metadata.annotations[''<KEY>'']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.'
properties:
apiVersion:
- description: Version of the schema the FieldPath
- is written in terms of, defaults to "v1".
+ description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
type: string
fieldPath:
- description: Path of the field to select in the
- specified API version.
+ description: Path of the field to select in the specified API version.
type: string
required:
- fieldPath
type: object
x-kubernetes-map-type: atomic
resourceFieldRef:
- description: 'Selects a resource of the container:
- only resources limits and requests (limits.cpu,
- limits.memory, limits.ephemeral-storage, requests.cpu,
- requests.memory and requests.ephemeral-storage)
- are currently supported.'
+ description: 'Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.'
properties:
containerName:
- description: 'Container name: required for volumes,
- optional for env vars'
+ description: 'Container name: required for volumes, optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format of the
- exposed resources, defaults to "1"
+ description: Specifies the output format of the exposed resources, defaults to "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
@@ -1106,22 +662,16 @@ spec:
type: object
x-kubernetes-map-type: atomic
secretKeyRef:
- description: Selects a key of a secret in the pod's
- namespace
+ description: Selects a key of a secret in the pod's namespace
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its
- key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -1133,42 +683,29 @@ spec:
type: object
type: array
envFrom:
- description: List of sources to populate environment variables
- in the container. The keys defined within a source must be
- a C_IDENTIFIER. All invalid keys will be reported as an event
- when the container is starting. When a key exists in multiple
- sources, the value associated with the last source will take
- precedence. Values defined by an Env with a duplicate key
- will take precedence. Cannot be updated.
+ description: List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
items:
- description: EnvFromSource represents the source of a set
- of ConfigMaps
+ description: EnvFromSource represents the source of a set of ConfigMaps
properties:
configMapRef:
description: The ConfigMap to select from
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap must be
- defined
+ description: Specify whether the ConfigMap must be defined
type: boolean
type: object
x-kubernetes-map-type: atomic
prefix:
- description: An optional identifier to prepend to each
- key in the ConfigMap. Must be a C_IDENTIFIER.
+ description: An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
type: string
secretRef:
description: The Secret to select from
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
description: Specify whether the Secret must be defined
@@ -1178,40 +715,22 @@ spec:
type: object
type: array
image:
- description: 'Container image name. More info: https://kubernetes.io/docs/concepts/containers/images
- This field is optional to allow higher level config management
- to default or override container images in workload controllers
- like Deployments and StatefulSets.'
+ description: 'Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.'
type: string
imagePullPolicy:
- description: 'Image pull policy. One of Always, Never, IfNotPresent.
- Defaults to Always if :latest tag is specified, or IfNotPresent
- otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
+ description: 'Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
- description: Actions that the management system should take
- in response to container lifecycle events. Cannot be updated.
+ description: Actions that the management system should take in response to container lifecycle events. Cannot be updated.
properties:
postStart:
- description: 'PostStart is called immediately after a container
- is created. If the handler fails, the container is terminated
- and restarted according to its restart policy. Other management
- of the container blocks until the hook completes. More
- info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
+ description: 'PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: Command is the command line to execute
- inside the container, the working directory for
- the command is root ('/') in the container's
- filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions
- ('|', etc) won't work. To use a shell, you need
- to explicitly call out to that shell. Exit status
- of 0 is treated as live/healthy and non-zero is
- unhealthy.
+ description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
@@ -1220,16 +739,12 @@ spec:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to
- the pod IP. You probably want to set "Host" in
- httpHeaders instead.
+ description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request.
- HTTP allows repeated headers.
+ description: Custom headers to set in the request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header
- to be used in HTTP probes
+ description: HTTPHeader describes a custom header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -1249,65 +764,38 @@ spec:
anyOf:
- type: integer
- type: string
- description: Name or number of the port to access
- on the container. Number must be in the range
- 1 to 65535. Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the
- host. Defaults to HTTP.
+ description: Scheme to use for connecting to the host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: Deprecated. TCPSocket is NOT supported
- as a LifecycleHandler and kept for the backward compatibility.
- There are no validation of this field and lifecycle
- hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.
properties:
host:
- description: 'Optional: Host name to connect to,
- defaults to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: Number or name of the port to access
- on the container. Number must be in the range
- 1 to 65535. Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
preStop:
- description: 'PreStop is called immediately before a container
- is terminated due to an API request or management event
- such as liveness/startup probe failure, preemption, resource
- contention, etc. The handler is not called if the container
- crashes or exits. The Pod''s termination grace period
- countdown begins before the PreStop hook is executed.
- Regardless of the outcome of the handler, the container
- will eventually terminate within the Pod''s termination
- grace period (unless delayed by finalizers). Other management
- of the container blocks until the hook completes or until
- the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
+ description: 'PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod''s termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod''s termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: Command is the command line to execute
- inside the container, the working directory for
- the command is root ('/') in the container's
- filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions
- ('|', etc) won't work. To use a shell, you need
- to explicitly call out to that shell. Exit status
- of 0 is treated as live/healthy and non-zero is
- unhealthy.
+ description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
@@ -1316,16 +804,12 @@ spec:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to
- the pod IP. You probably want to set "Host" in
- httpHeaders instead.
+ description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request.
- HTTP allows repeated headers.
+ description: Custom headers to set in the request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header
- to be used in HTTP probes
+ description: HTTPHeader describes a custom header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -1345,34 +829,25 @@ spec:
anyOf:
- type: integer
- type: string
- description: Name or number of the port to access
- on the container. Number must be in the range
- 1 to 65535. Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the
- host. Defaults to HTTP.
+ description: Scheme to use for connecting to the host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: Deprecated. TCPSocket is NOT supported
- as a LifecycleHandler and kept for the backward compatibility.
- There are no validation of this field and lifecycle
- hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.
properties:
host:
- description: 'Optional: Host name to connect to,
- defaults to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: Number or name of the port to access
- on the container. Number must be in the range
- 1 to 65535. Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
@@ -1380,47 +855,30 @@ spec:
type: object
type: object
livenessProbe:
- description: 'Periodic probe of container liveness. Container
- will be restarted if the probe fails. Cannot be updated. More
- info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: Command is the command line to execute
- inside the container, the working directory for the
- command is root ('/') in the container's filesystem.
- The command is simply exec'd, it is not run inside
- a shell, so traditional shell instructions ('|', etc)
- won't work. To use a shell, you need to explicitly
- call out to that shell. Exit status of 0 is treated
- as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe
- to be considered failed after having succeeded. Defaults
- to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
format: int32
type: integer
grpc:
- description: GRPC specifies an action involving a GRPC port.
- This is a beta field and requires enabling GRPCContainerProbe
- feature gate.
+ description: GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.
properties:
port:
- description: Port number of the gRPC service. Number
- must be in the range 1 to 65535.
+ description: Port number of the gRPC service. Number must be in the range 1 to 65535.
format: int32
type: integer
service:
- description: "Service is the name of the service to
- place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
- \n If this is not specified, the default behavior
- is defined by gRPC."
+ description: "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). \n If this is not specified, the default behavior is defined by gRPC."
type: string
required:
- port
@@ -1429,16 +887,12 @@ spec:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to the
- pod IP. You probably want to set "Host" in httpHeaders
- instead.
+ description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP
- allows repeated headers.
+ description: Custom headers to set in the request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header
- to be used in HTTP probes
+ description: HTTPHeader describes a custom header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -1458,120 +912,75 @@ spec:
anyOf:
- type: integer
- type: string
- description: Name or number of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: 'Number of seconds after the container has
- started before liveness probes are initiated. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
format: int32
type: integer
successThreshold:
- description: Minimum consecutive successes for the probe
- to be considered successful after having failed. Defaults
- to 1. Must be 1 for liveness and startup. Minimum value
- is 1.
+ description: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
- description: TCPSocket specifies an action involving a TCP
- port.
+ description: TCPSocket specifies an action involving a TCP port.
properties:
host:
- description: 'Optional: Host name to connect to, defaults
- to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: Number or name of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: Optional duration in seconds the pod needs
- to terminate gracefully upon probe failure. The grace
- period is the duration in seconds after the processes
- running in the pod are sent a termination signal and the
- time when the processes are forcibly halted with a kill
- signal. Set this value longer than the expected cleanup
- time for your process. If this value is nil, the pod's
- terminationGracePeriodSeconds will be used. Otherwise,
- this value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates
- stop immediately via the kill signal (no opportunity to
- shut down). This is a beta field and requires enabling
- ProbeTerminationGracePeriod feature gate. Minimum value
- is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: 'Number of seconds after which the probe times
- out. Defaults to 1 second. Minimum value is 1. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
name:
- description: Name of the container specified as a DNS_LABEL.
- Each container in a pod must have a unique name (DNS_LABEL).
- Cannot be updated.
+ description: Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
type: string
ports:
- description: List of ports to expose from the container. Not
- specifying a port here DOES NOT prevent that port from being
- exposed. Any port which is listening on the default "0.0.0.0"
- address inside a container will be accessible from the network.
- Modifying this array with strategic merge patch may corrupt
- the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255.
- Cannot be updated.
+ description: List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.
items:
- description: ContainerPort represents a network port in a
- single container.
+ description: ContainerPort represents a network port in a single container.
properties:
containerPort:
- description: Number of port to expose on the pod's IP
- address. This must be a valid port number, 0 < x < 65536.
+ description: Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
format: int32
type: integer
hostIP:
description: What host IP to bind the external port to.
type: string
hostPort:
- description: Number of port to expose on the host. If
- specified, this must be a valid port number, 0 < x <
- 65536. If HostNetwork is specified, this must match
- ContainerPort. Most containers do not need this.
+ description: Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.
format: int32
type: integer
name:
- description: If specified, this must be an IANA_SVC_NAME
- and unique within the pod. Each named port in a pod
- must have a unique name. Name for the port that can
- be referred to by services.
+ description: If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
type: string
protocol:
default: TCP
- description: Protocol for port. Must be UDP, TCP, or SCTP.
- Defaults to "TCP".
+ description: Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".
type: string
required:
- containerPort
@@ -1582,47 +991,30 @@ spec:
- protocol
x-kubernetes-list-type: map
readinessProbe:
- description: 'Periodic probe of container service readiness.
- Container will be removed from service endpoints if the probe
- fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: Command is the command line to execute
- inside the container, the working directory for the
- command is root ('/') in the container's filesystem.
- The command is simply exec'd, it is not run inside
- a shell, so traditional shell instructions ('|', etc)
- won't work. To use a shell, you need to explicitly
- call out to that shell. Exit status of 0 is treated
- as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe
- to be considered failed after having succeeded. Defaults
- to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
format: int32
type: integer
grpc:
- description: GRPC specifies an action involving a GRPC port.
- This is a beta field and requires enabling GRPCContainerProbe
- feature gate.
+ description: GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.
properties:
port:
- description: Port number of the gRPC service. Number
- must be in the range 1 to 65535.
+ description: Port number of the gRPC service. Number must be in the range 1 to 65535.
format: int32
type: integer
service:
- description: "Service is the name of the service to
- place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
- \n If this is not specified, the default behavior
- is defined by gRPC."
+ description: "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). \n If this is not specified, the default behavior is defined by gRPC."
type: string
required:
- port
@@ -1631,16 +1023,12 @@ spec:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to the
- pod IP. You probably want to set "Host" in httpHeaders
- instead.
+ description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP
- allows repeated headers.
+ description: Custom headers to set in the request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header
- to be used in HTTP probes
+ description: HTTPHeader describes a custom header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -1660,95 +1048,60 @@ spec:
anyOf:
- type: integer
- type: string
- description: Name or number of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: 'Number of seconds after the container has
- started before liveness probes are initiated. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
format: int32
type: integer
successThreshold:
- description: Minimum consecutive successes for the probe
- to be considered successful after having failed. Defaults
- to 1. Must be 1 for liveness and startup. Minimum value
- is 1.
+ description: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
- description: TCPSocket specifies an action involving a TCP
- port.
+ description: TCPSocket specifies an action involving a TCP port.
properties:
host:
- description: 'Optional: Host name to connect to, defaults
- to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: Number or name of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: Optional duration in seconds the pod needs
- to terminate gracefully upon probe failure. The grace
- period is the duration in seconds after the processes
- running in the pod are sent a termination signal and the
- time when the processes are forcibly halted with a kill
- signal. Set this value longer than the expected cleanup
- time for your process. If this value is nil, the pod's
- terminationGracePeriodSeconds will be used. Otherwise,
- this value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates
- stop immediately via the kill signal (no opportunity to
- shut down). This is a beta field and requires enabling
- ProbeTerminationGracePeriod feature gate. Minimum value
- is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: 'Number of seconds after which the probe times
- out. Defaults to 1 second. Minimum value is 1. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
resources:
- description: 'Compute Resources required by this container.
- Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
properties:
claims:
- description: "Claims lists the names of resources, defined
- in spec.resourceClaims, that are used by this container.
- \n This is an alpha field and requires enabling the DynamicResourceAllocation
- feature gate. \n This field is immutable."
+ description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable."
items:
description: ResourceClaim references one entry in PodSpec.ResourceClaims.
properties:
name:
- description: Name must match the name of one entry
- in pod.spec.resourceClaims of the Pod where this
- field is used. It makes that resource available
- inside a container.
+ description: Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
type: string
required:
- name
@@ -1764,8 +1117,7 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute
- resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -1774,236 +1126,121 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Requests describes the minimum amount of compute
- resources required. If Requests is omitted for a container,
- it defaults to Limits if that is explicitly specified,
- otherwise to an implementation-defined value. More info:
- https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
securityContext:
- description: 'SecurityContext defines the security options the
- container should be run with. If set, the fields of SecurityContext
- override the equivalent fields of PodSecurityContext. More
- info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
+ description: 'SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
properties:
allowPrivilegeEscalation:
- description: 'AllowPrivilegeEscalation controls whether
- a process can gain more privileges than its parent process.
- This bool directly controls if the no_new_privs flag will
- be set on the container process. AllowPrivilegeEscalation
- is true always when the container is: 1) run as Privileged
- 2) has CAP_SYS_ADMIN Note that this field cannot be set
- when spec.os.name is windows.'
+ description: 'AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.'
type: boolean
capabilities:
- description: The capabilities to add/drop when running containers.
- Defaults to the default set of capabilities granted by
- the container runtime. Note that this field cannot be
- set when spec.os.name is windows.
+ description: The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.
properties:
add:
description: Added capabilities
items:
- description: Capability represent POSIX capabilities
- type
+ description: Capability represent POSIX capabilities type
type: string
type: array
drop:
description: Removed capabilities
items:
- description: Capability represent POSIX capabilities
- type
+ description: Capability represent POSIX capabilities type
type: string
type: array
type: object
privileged:
- description: Run container in privileged mode. Processes
- in privileged containers are essentially equivalent to
- root on the host. Defaults to false. Note that this field
- cannot be set when spec.os.name is windows.
+ description: Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.
type: boolean
procMount:
- description: procMount denotes the type of proc mount to
- use for the containers. The default is DefaultProcMount
- which uses the container runtime defaults for readonly
- paths and masked paths. This requires the ProcMountType
- feature flag to be enabled. Note that this field cannot
- be set when spec.os.name is windows.
+ description: procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.
type: string
readOnlyRootFilesystem:
- description: Whether this container has a read-only root
- filesystem. Default is false. Note that this field cannot
- be set when spec.os.name is windows.
+ description: Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.
type: boolean
runAsGroup:
- description: The GID to run the entrypoint of the container
- process. Uses runtime default if unset. May also be set
- in PodSecurityContext. If set in both SecurityContext
- and PodSecurityContext, the value specified in SecurityContext
- takes precedence. Note that this field cannot be set when
- spec.os.name is windows.
+ description: The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
format: int64
type: integer
runAsNonRoot:
- description: Indicates that the container must run as a
- non-root user. If true, the Kubelet will validate the
- image at runtime to ensure that it does not run as UID
- 0 (root) and fail to start the container if it does. If
- unset or false, no such validation will be performed.
- May also be set in PodSecurityContext. If set in both
- SecurityContext and PodSecurityContext, the value specified
- in SecurityContext takes precedence.
+ description: Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
type: boolean
runAsUser:
- description: The UID to run the entrypoint of the container
- process. Defaults to user specified in image metadata
- if unspecified. May also be set in PodSecurityContext. If
- set in both SecurityContext and PodSecurityContext, the
- value specified in SecurityContext takes precedence. Note
- that this field cannot be set when spec.os.name is windows.
+ description: The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
format: int64
type: integer
seLinuxOptions:
- description: The SELinux context to be applied to the container.
- If unspecified, the container runtime will allocate a
- random SELinux context for each container. May also be
- set in PodSecurityContext. If set in both SecurityContext
- and PodSecurityContext, the value specified in SecurityContext
- takes precedence. Note that this field cannot be set when
- spec.os.name is windows.
+ description: The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
properties:
level:
- description: Level is SELinux level label that applies
- to the container.
+ description: Level is SELinux level label that applies to the container.
type: string
role:
- description: Role is a SELinux role label that applies
- to the container.
+ description: Role is a SELinux role label that applies to the container.
type: string
type:
- description: Type is a SELinux type label that applies
- to the container.
+ description: Type is a SELinux type label that applies to the container.
type: string
user:
- description: User is a SELinux user label that applies
- to the container.
+ description: User is a SELinux user label that applies to the container.
type: string
type: object
seccompProfile:
- description: The seccomp options to use by this container.
- If seccomp options are provided at both the pod & container
- level, the container options override the pod options.
- Note that this field cannot be set when spec.os.name is
- windows.
+ description: The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
properties:
localhostProfile:
- description: localhostProfile indicates a profile defined
- in a file on the node should be used. The profile
- must be preconfigured on the node to work. Must be
- a descending path, relative to the kubelet's configured
- seccomp profile location. Must only be set if type
- is "Localhost".
+ description: localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost".
type: string
type:
- description: "type indicates which kind of seccomp profile
- will be applied. Valid options are: \n Localhost -
- a profile defined in a file on the node should be
- used. RuntimeDefault - the container runtime default
- profile should be used. Unconfined - no profile should
- be applied."
+ description: "type indicates which kind of seccomp profile will be applied. Valid options are: \n Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied."
type: string
required:
- type
type: object
windowsOptions:
- description: The Windows specific settings applied to all
- containers. If unspecified, the options from the PodSecurityContext
- will be used. If set in both SecurityContext and PodSecurityContext,
- the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is
- linux.
+ description: The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
properties:
gmsaCredentialSpec:
- description: GMSACredentialSpec is where the GMSA admission
- webhook (https://github.com/kubernetes-sigs/windows-gmsa)
- inlines the contents of the GMSA credential spec named
- by the GMSACredentialSpecName field.
+ description: GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.
type: string
gmsaCredentialSpecName:
- description: GMSACredentialSpecName is the name of the
- GMSA credential spec to use.
+ description: GMSACredentialSpecName is the name of the GMSA credential spec to use.
type: string
hostProcess:
- description: HostProcess determines if a container should
- be run as a 'Host Process' container. This field is
- alpha-level and will only be honored by components
- that enable the WindowsHostProcessContainers feature
- flag. Setting this field without the feature flag
- will result in errors when validating the Pod. All
- of a Pod's containers must have the same effective
- HostProcess value (it is not allowed to have a mix
- of HostProcess containers and non-HostProcess containers). In
- addition, if HostProcess is true then HostNetwork
- must also be set to true.
+ description: HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.
type: boolean
runAsUserName:
- description: The UserName in Windows to run the entrypoint
- of the container process. Defaults to the user specified
- in image metadata if unspecified. May also be set
- in PodSecurityContext. If set in both SecurityContext
- and PodSecurityContext, the value specified in SecurityContext
- takes precedence.
+ description: The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
type: string
type: object
type: object
startupProbe:
- description: 'StartupProbe indicates that the Pod has successfully
- initialized. If specified, no other probes are executed until
- this completes successfully. If this probe fails, the Pod
- will be restarted, just as if the livenessProbe failed. This
- can be used to provide different probe parameters at the beginning
- of a Pod''s lifecycle, when it might take a long time to load
- data or warm a cache, than during steady-state operation.
- This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod''s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: Command is the command line to execute
- inside the container, the working directory for the
- command is root ('/') in the container's filesystem.
- The command is simply exec'd, it is not run inside
- a shell, so traditional shell instructions ('|', etc)
- won't work. To use a shell, you need to explicitly
- call out to that shell. Exit status of 0 is treated
- as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe
- to be considered failed after having succeeded. Defaults
- to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
format: int32
type: integer
grpc:
- description: GRPC specifies an action involving a GRPC port.
- This is a beta field and requires enabling GRPCContainerProbe
- feature gate.
+ description: GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.
properties:
port:
- description: Port number of the gRPC service. Number
- must be in the range 1 to 65535.
+ description: Port number of the gRPC service. Number must be in the range 1 to 65535.
format: int32
type: integer
service:
- description: "Service is the name of the service to
- place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
- \n If this is not specified, the default behavior
- is defined by gRPC."
+ description: "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). \n If this is not specified, the default behavior is defined by gRPC."
type: string
required:
- port
@@ -2012,16 +1249,12 @@ spec:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to the
- pod IP. You probably want to set "Host" in httpHeaders
- instead.
+ description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP
- allows repeated headers.
+ description: Custom headers to set in the request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header
- to be used in HTTP probes
+ description: HTTPHeader describes a custom header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -2041,133 +1274,75 @@ spec:
anyOf:
- type: integer
- type: string
- description: Name or number of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: 'Number of seconds after the container has
- started before liveness probes are initiated. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
format: int32
type: integer
successThreshold:
- description: Minimum consecutive successes for the probe
- to be considered successful after having failed. Defaults
- to 1. Must be 1 for liveness and startup. Minimum value
- is 1.
+ description: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
- description: TCPSocket specifies an action involving a TCP
- port.
+ description: TCPSocket specifies an action involving a TCP port.
properties:
host:
- description: 'Optional: Host name to connect to, defaults
- to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: Number or name of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: Optional duration in seconds the pod needs
- to terminate gracefully upon probe failure. The grace
- period is the duration in seconds after the processes
- running in the pod are sent a termination signal and the
- time when the processes are forcibly halted with a kill
- signal. Set this value longer than the expected cleanup
- time for your process. If this value is nil, the pod's
- terminationGracePeriodSeconds will be used. Otherwise,
- this value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates
- stop immediately via the kill signal (no opportunity to
- shut down). This is a beta field and requires enabling
- ProbeTerminationGracePeriod feature gate. Minimum value
- is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: 'Number of seconds after which the probe times
- out. Defaults to 1 second. Minimum value is 1. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
stdin:
- description: Whether this container should allocate a buffer
- for stdin in the container runtime. If this is not set, reads
- from stdin in the container will always result in EOF. Default
- is false.
+ description: Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
type: boolean
stdinOnce:
- description: Whether the container runtime should close the
- stdin channel after it has been opened by a single attach.
- When stdin is true the stdin stream will remain open across
- multiple attach sessions. If stdinOnce is set to true, stdin
- is opened on container start, is empty until the first client
- attaches to stdin, and then remains open and accepts data
- until the client disconnects, at which time stdin is closed
- and remains closed until the container is restarted. If this
- flag is false, a container processes that reads from stdin
- will never receive an EOF. Default is false
+ description: Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
type: boolean
terminationMessagePath:
- description: 'Optional: Path at which the file to which the
- container''s termination message will be written is mounted
- into the container''s filesystem. Message written is intended
- to be brief final status, such as an assertion failure message.
- Will be truncated by the node if greater than 4096 bytes.
- The total message length across all containers will be limited
- to 12kb. Defaults to /dev/termination-log. Cannot be updated.'
+ description: 'Optional: Path at which the file to which the container''s termination message will be written is mounted into the container''s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.'
type: string
terminationMessagePolicy:
- description: Indicate how the termination message should be
- populated. File will use the contents of terminationMessagePath
- to populate the container status message on both success and
- failure. FallbackToLogsOnError will use the last chunk of
- container log output if the termination message file is empty
- and the container exited with an error. The log output is
- limited to 2048 bytes or 80 lines, whichever is smaller. Defaults
- to File. Cannot be updated.
+ description: Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
type: string
tty:
- description: Whether this container should allocate a TTY for
- itself, also requires 'stdin' to be true. Default is false.
+ description: Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
type: boolean
volumeDevices:
- description: volumeDevices is the list of block devices to be
- used by the container.
+ description: volumeDevices is the list of block devices to be used by the container.
items:
- description: volumeDevice describes a mapping of a raw block
- device within a container.
+ description: volumeDevice describes a mapping of a raw block device within a container.
properties:
devicePath:
- description: devicePath is the path inside of the container
- that the device will be mapped to.
+ description: devicePath is the path inside of the container that the device will be mapped to.
type: string
name:
- description: name must match the name of a persistentVolumeClaim
- in the pod
+ description: name must match the name of a persistentVolumeClaim in the pod
type: string
required:
- devicePath
@@ -2175,40 +1350,27 @@ spec:
type: object
type: array
volumeMounts:
- description: Pod volumes to mount into the container's filesystem.
- Cannot be updated.
+ description: Pod volumes to mount into the container's filesystem. Cannot be updated.
items:
- description: VolumeMount describes a mounting of a Volume
- within a container.
+ description: VolumeMount describes a mounting of a Volume within a container.
properties:
mountPath:
- description: Path within the container at which the volume
- should be mounted. Must not contain ':'.
+ description: Path within the container at which the volume should be mounted. Must not contain ':'.
type: string
mountPropagation:
- description: mountPropagation determines how mounts are
- propagated from the host to container and the other
- way around. When not set, MountPropagationNone is used.
- This field is beta in 1.10.
+ description: mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.
type: string
name:
description: This must match the Name of a Volume.
type: string
readOnly:
- description: Mounted read-only if true, read-write otherwise
- (false or unspecified). Defaults to false.
+ description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
type: boolean
subPath:
- description: Path within the volume from which the container's
- volume should be mounted. Defaults to "" (volume's root).
+ description: Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
type: string
subPathExpr:
- description: Expanded path within the volume from which
- the container's volume should be mounted. Behaves similarly
- to SubPath but environment variable references $(VAR_NAME)
- are expanded using the container's environment. Defaults
- to "" (volume's root). SubPathExpr and SubPath are mutually
- exclusive.
+ description: Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.
type: string
required:
- mountPath
@@ -2216,18 +1378,14 @@ spec:
type: object
type: array
workingDir:
- description: Container's working directory. If not specified,
- the container runtime's default will be used, which might
- be configured in the container image. Cannot be updated.
+ description: Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.
type: string
required:
- name
type: object
type: array
enforcedNamespaceLabel:
- description: EnforcedNamespaceLabel enforces adding a namespace label
- of origin for each alert and metric that is user created. The label
- value will always be the namespace of the object that is being created.
+ description: EnforcedNamespaceLabel enforces adding a namespace label of origin for each alert and metric that is user created. The label value will always be the namespace of the object that is being created.
type: string
evaluationInterval:
default: 15s
@@ -2235,23 +1393,18 @@ spec:
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
excludedFromEnforcement:
- description: List of references to PrometheusRule objects to be excluded
- from enforcing a namespace label of origin. Applies only if enforcedNamespaceLabel
- set to true.
+ description: List of references to PrometheusRule objects to be excluded from enforcing a namespace label of origin. Applies only if enforcedNamespaceLabel set to true.
items:
- description: ObjectReference references a PodMonitor, ServiceMonitor,
- Probe or PrometheusRule object.
+ description: ObjectReference references a PodMonitor, ServiceMonitor, Probe or PrometheusRule object.
properties:
group:
default: monitoring.coreos.com
- description: Group of the referent. When not specified, it defaults
- to `monitoring.coreos.com`
+ description: Group of the referent. When not specified, it defaults to `monitoring.coreos.com`
enum:
- monitoring.coreos.com
type: string
name:
- description: Name of the referent. When not set, all resources
- are matched.
+ description: Name of the referent. When not set, all resources are matched.
type: string
namespace:
description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
@@ -2271,19 +1424,13 @@ spec:
type: object
type: array
externalPrefix:
- description: The external URL the Thanos Ruler instances will be available
- under. This is necessary to generate correct URLs. This is necessary
- if Thanos Ruler is not served from root of a DNS name.
+ description: The external URL the Thanos Ruler instances will be available under. This is necessary to generate correct URLs. This is necessary if Thanos Ruler is not served from root of a DNS name.
type: string
grpcServerTlsConfig:
- description: 'GRPCServerTLSConfig configures the gRPC server from
- which Thanos Querier reads recorded rule data. Note: Currently only
- the CAFile, CertFile, and KeyFile fields are supported. Maps to
- the ''--grpc-server-tls-*'' CLI args.'
+ description: 'GRPCServerTLSConfig configures the gRPC server from which Thanos Querier reads recorded rule data. Note: Currently only the CAFile, CertFile, and KeyFile fields are supported. Maps to the ''--grpc-server-tls-*'' CLI args.'
properties:
ca:
- description: Certificate authority used when verifying server
- certificates.
+ description: Certificate authority used when verifying server certificates.
properties:
configMap:
description: ConfigMap containing data to use for the targets.
@@ -2292,12 +1439,10 @@ spec:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its key
- must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
@@ -2307,16 +1452,13 @@ spec:
description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -2324,8 +1466,7 @@ spec:
x-kubernetes-map-type: atomic
type: object
caFile:
- description: Path to the CA cert in the Prometheus container to
- use for the targets.
+ description: Path to the CA cert in the Prometheus container to use for the targets.
type: string
cert:
description: Client certificate to present when doing client-authentication.
@@ -2337,12 +1478,10 @@ spec:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its key
- must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
@@ -2352,16 +1491,13 @@ spec:
description: Secret containing data to use for the targets.
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must
- be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -2369,30 +1505,25 @@ spec:
x-kubernetes-map-type: atomic
type: object
certFile:
- description: Path to the client cert file in the Prometheus container
- for the targets.
+ description: Path to the client cert file in the Prometheus container for the targets.
type: string
insecureSkipVerify:
description: Disable target certificate validation.
type: boolean
keyFile:
- description: Path to the client key file in the Prometheus container
- for the targets.
+ description: Path to the client key file in the Prometheus container for the targets.
type: string
keySecret:
description: Secret containing the client key file for the targets.
properties:
key:
- description: The key of the secret to select from. Must be
- a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be
- defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -2405,8 +1536,7 @@ spec:
hostAliases:
description: Pods' hostAliases configuration
items:
- description: HostAlias holds the mapping between IP and hostnames
- that will be injected as an entry in the pod's hosts file.
+ description: HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.
properties:
hostnames:
description: Hostnames for the above IP address.
@@ -2428,9 +1558,7 @@ spec:
description: Thanos container image URL.
type: string
imagePullPolicy:
- description: Image pull policy for the 'thanos', 'init-config-reloader'
- and 'config-reloader' containers. See https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy
- for more details.
+ description: Image pull policy for the 'thanos', 'init-config-reloader' and 'config-reloader' containers. See https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy for more details.
enum:
- ""
- Always
@@ -2438,86 +1566,44 @@ spec:
- IfNotPresent
type: string
imagePullSecrets:
- description: An optional list of references to secrets in the same
- namespace to use for pulling thanos images from registries see http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod
+ description: An optional list of references to secrets in the same namespace to use for pulling thanos images from registries see http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod
items:
- description: LocalObjectReference contains enough information to
- let you locate the referenced object inside the same namespace.
+ description: LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
x-kubernetes-map-type: atomic
type: array
initContainers:
- description: 'InitContainers allows adding initContainers to the pod
- definition. Those can be used to e.g. fetch secrets for injection
- into the ThanosRuler configuration from external sources. Any errors
- during the execution of an initContainer will lead to a restart
- of the Pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
- Using initContainers for any use case other then secret fetching
- is entirely outside the scope of what the maintainers will support
- and by doing so, you accept that this behaviour may break at any
- time without notice.'
+ description: 'InitContainers allows adding initContainers to the pod definition. Those can be used to e.g. fetch secrets for injection into the ThanosRuler configuration from external sources. Any errors during the execution of an initContainer will lead to a restart of the Pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ Using initContainers for any use case other then secret fetching is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice.'
items:
- description: A single application container that you want to run
- within a pod.
+ description: A single application container that you want to run within a pod.
properties:
args:
- description: 'Arguments to the entrypoint. The container image''s
- CMD is used if this is not provided. Variable references $(VAR_NAME)
- are expanded using the container''s environment. If a variable
- cannot be resolved, the reference in the input string will
- be unchanged. Double $$ are reduced to a single $, which allows
- for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references
- will never be expanded, regardless of whether the variable
- exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
+ description: 'Arguments to the entrypoint. The container image''s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container''s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
command:
- description: 'Entrypoint array. Not executed within a shell.
- The container image''s ENTRYPOINT is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container''s
- environment. If a variable cannot be resolved, the reference
- in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax:
- i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
- Escaped references will never be expanded, regardless of whether
- the variable exists or not. Cannot be updated. More info:
- https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
+ description: 'Entrypoint array. Not executed within a shell. The container image''s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container''s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
env:
- description: List of environment variables to set in the container.
- Cannot be updated.
+ description: List of environment variables to set in the container. Cannot be updated.
items:
- description: EnvVar represents an environment variable present
- in a Container.
+ description: EnvVar represents an environment variable present in a Container.
properties:
name:
- description: Name of the environment variable. Must be
- a C_IDENTIFIER.
+ description: Name of the environment variable. Must be a C_IDENTIFIER.
type: string
value:
- description: 'Variable references $(VAR_NAME) are expanded
- using the previously defined environment variables in
- the container and any service environment variables.
- If a variable cannot be resolved, the reference in the
- input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME)
- syntax: i.e. "$$(VAR_NAME)" will produce the string
- literal "$(VAR_NAME)". Escaped references will never
- be expanded, regardless of whether the variable exists
- or not. Defaults to "".'
+ description: 'Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".'
type: string
valueFrom:
- description: Source for the environment variable's value.
- Cannot be used if value is not empty.
+ description: Source for the environment variable's value. Cannot be used if value is not empty.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -2526,55 +1612,39 @@ spec:
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or
- its key must be defined
+ description: Specify whether the ConfigMap or its key must be defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
fieldRef:
- description: 'Selects a field of the pod: supports
- metadata.name, metadata.namespace, `metadata.labels[''<KEY>'']`,
- `metadata.annotations[''<KEY>'']`, spec.nodeName,
- spec.serviceAccountName, status.hostIP, status.podIP,
- status.podIPs.'
+ description: 'Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels[''<KEY>'']`, `metadata.annotations[''<KEY>'']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.'
properties:
apiVersion:
- description: Version of the schema the FieldPath
- is written in terms of, defaults to "v1".
+ description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
type: string
fieldPath:
- description: Path of the field to select in the
- specified API version.
+ description: Path of the field to select in the specified API version.
type: string
required:
- fieldPath
type: object
x-kubernetes-map-type: atomic
resourceFieldRef:
- description: 'Selects a resource of the container:
- only resources limits and requests (limits.cpu,
- limits.memory, limits.ephemeral-storage, requests.cpu,
- requests.memory and requests.ephemeral-storage)
- are currently supported.'
+ description: 'Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.'
properties:
containerName:
- description: 'Container name: required for volumes,
- optional for env vars'
+ description: 'Container name: required for volumes, optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format of the
- exposed resources, defaults to "1"
+ description: Specifies the output format of the exposed resources, defaults to "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
@@ -2585,22 +1655,16 @@ spec:
type: object
x-kubernetes-map-type: atomic
secretKeyRef:
- description: Selects a key of a secret in the pod's
- namespace
+ description: Selects a key of a secret in the pod's namespace
properties:
key:
- description: The key of the secret to select from. Must
- be a valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its
- key must be defined
+ description: Specify whether the Secret or its key must be defined
type: boolean
required:
- key
@@ -2612,42 +1676,29 @@ spec:
type: object
type: array
envFrom:
- description: List of sources to populate environment variables
- in the container. The keys defined within a source must be
- a C_IDENTIFIER. All invalid keys will be reported as an event
- when the container is starting. When a key exists in multiple
- sources, the value associated with the last source will take
- precedence. Values defined by an Env with a duplicate key
- will take precedence. Cannot be updated.
+ description: List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
items:
- description: EnvFromSource represents the source of a set
- of ConfigMaps
+ description: EnvFromSource represents the source of a set of ConfigMaps
properties:
configMapRef:
description: The ConfigMap to select from
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap must be
- defined
+ description: Specify whether the ConfigMap must be defined
type: boolean
type: object
x-kubernetes-map-type: atomic
prefix:
- description: An optional identifier to prepend to each
- key in the ConfigMap. Must be a C_IDENTIFIER.
+ description: An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
type: string
secretRef:
description: The Secret to select from
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
description: Specify whether the Secret must be defined
@@ -2657,40 +1708,22 @@ spec:
type: object
type: array
image:
- description: 'Container image name. More info: https://kubernetes.io/docs/concepts/containers/images
- This field is optional to allow higher level config management
- to default or override container images in workload controllers
- like Deployments and StatefulSets.'
+ description: 'Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.'
type: string
imagePullPolicy:
- description: 'Image pull policy. One of Always, Never, IfNotPresent.
- Defaults to Always if :latest tag is specified, or IfNotPresent
- otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
+ description: 'Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
- description: Actions that the management system should take
- in response to container lifecycle events. Cannot be updated.
+ description: Actions that the management system should take in response to container lifecycle events. Cannot be updated.
properties:
postStart:
- description: 'PostStart is called immediately after a container
- is created. If the handler fails, the container is terminated
- and restarted according to its restart policy. Other management
- of the container blocks until the hook completes. More
- info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
+ description: 'PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: Command is the command line to execute
- inside the container, the working directory for
- the command is root ('/') in the container's
- filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions
- ('|', etc) won't work. To use a shell, you need
- to explicitly call out to that shell. Exit status
- of 0 is treated as live/healthy and non-zero is
- unhealthy.
+ description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
@@ -2699,16 +1732,12 @@ spec:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to
- the pod IP. You probably want to set "Host" in
- httpHeaders instead.
+ description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request.
- HTTP allows repeated headers.
+ description: Custom headers to set in the request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header
- to be used in HTTP probes
+ description: HTTPHeader describes a custom header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -2728,65 +1757,38 @@ spec:
anyOf:
- type: integer
- type: string
- description: Name or number of the port to access
- on the container. Number must be in the range
- 1 to 65535. Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the
- host. Defaults to HTTP.
+ description: Scheme to use for connecting to the host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: Deprecated. TCPSocket is NOT supported
- as a LifecycleHandler and kept for the backward compatibility.
- There are no validation of this field and lifecycle
- hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.
properties:
host:
- description: 'Optional: Host name to connect to,
- defaults to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: Number or name of the port to access
- on the container. Number must be in the range
- 1 to 65535. Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
preStop:
- description: 'PreStop is called immediately before a container
- is terminated due to an API request or management event
- such as liveness/startup probe failure, preemption, resource
- contention, etc. The handler is not called if the container
- crashes or exits. The Pod''s termination grace period
- countdown begins before the PreStop hook is executed.
- Regardless of the outcome of the handler, the container
- will eventually terminate within the Pod''s termination
- grace period (unless delayed by finalizers). Other management
- of the container blocks until the hook completes or until
- the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
+ description: 'PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod''s termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod''s termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: Command is the command line to execute
- inside the container, the working directory for
- the command is root ('/') in the container's
- filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions
- ('|', etc) won't work. To use a shell, you need
- to explicitly call out to that shell. Exit status
- of 0 is treated as live/healthy and non-zero is
- unhealthy.
+ description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
@@ -2795,16 +1797,12 @@ spec:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to
- the pod IP. You probably want to set "Host" in
- httpHeaders instead.
+ description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request.
- HTTP allows repeated headers.
+ description: Custom headers to set in the request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header
- to be used in HTTP probes
+ description: HTTPHeader describes a custom header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -2824,34 +1822,25 @@ spec:
anyOf:
- type: integer
- type: string
- description: Name or number of the port to access
- on the container. Number must be in the range
- 1 to 65535. Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the
- host. Defaults to HTTP.
+ description: Scheme to use for connecting to the host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: Deprecated. TCPSocket is NOT supported
- as a LifecycleHandler and kept for the backward compatibility.
- There are no validation of this field and lifecycle
- hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.
properties:
host:
- description: 'Optional: Host name to connect to,
- defaults to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: Number or name of the port to access
- on the container. Number must be in the range
- 1 to 65535. Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
@@ -2859,47 +1848,30 @@ spec:
type: object
type: object
livenessProbe:
- description: 'Periodic probe of container liveness. Container
- will be restarted if the probe fails. Cannot be updated. More
- info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: Command is the command line to execute
- inside the container, the working directory for the
- command is root ('/') in the container's filesystem.
- The command is simply exec'd, it is not run inside
- a shell, so traditional shell instructions ('|', etc)
- won't work. To use a shell, you need to explicitly
- call out to that shell. Exit status of 0 is treated
- as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe
- to be considered failed after having succeeded. Defaults
- to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
format: int32
type: integer
grpc:
- description: GRPC specifies an action involving a GRPC port.
- This is a beta field and requires enabling GRPCContainerProbe
- feature gate.
+ description: GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.
properties:
port:
- description: Port number of the gRPC service. Number
- must be in the range 1 to 65535.
+ description: Port number of the gRPC service. Number must be in the range 1 to 65535.
format: int32
type: integer
service:
- description: "Service is the name of the service to
- place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
- \n If this is not specified, the default behavior
- is defined by gRPC."
+ description: "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). \n If this is not specified, the default behavior is defined by gRPC."
type: string
required:
- port
@@ -2908,16 +1880,12 @@ spec:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to the
- pod IP. You probably want to set "Host" in httpHeaders
- instead.
+ description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP
- allows repeated headers.
+ description: Custom headers to set in the request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header
- to be used in HTTP probes
+ description: HTTPHeader describes a custom header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -2937,120 +1905,75 @@ spec:
anyOf:
- type: integer
- type: string
- description: Name or number of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: 'Number of seconds after the container has
- started before liveness probes are initiated. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
format: int32
type: integer
successThreshold:
- description: Minimum consecutive successes for the probe
- to be considered successful after having failed. Defaults
- to 1. Must be 1 for liveness and startup. Minimum value
- is 1.
+ description: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
- description: TCPSocket specifies an action involving a TCP
- port.
+ description: TCPSocket specifies an action involving a TCP port.
properties:
host:
- description: 'Optional: Host name to connect to, defaults
- to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: Number or name of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: Optional duration in seconds the pod needs
- to terminate gracefully upon probe failure. The grace
- period is the duration in seconds after the processes
- running in the pod are sent a termination signal and the
- time when the processes are forcibly halted with a kill
- signal. Set this value longer than the expected cleanup
- time for your process. If this value is nil, the pod's
- terminationGracePeriodSeconds will be used. Otherwise,
- this value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates
- stop immediately via the kill signal (no opportunity to
- shut down). This is a beta field and requires enabling
- ProbeTerminationGracePeriod feature gate. Minimum value
- is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: 'Number of seconds after which the probe times
- out. Defaults to 1 second. Minimum value is 1. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
name:
- description: Name of the container specified as a DNS_LABEL.
- Each container in a pod must have a unique name (DNS_LABEL).
- Cannot be updated.
+ description: Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
type: string
ports:
- description: List of ports to expose from the container. Not
- specifying a port here DOES NOT prevent that port from being
- exposed. Any port which is listening on the default "0.0.0.0"
- address inside a container will be accessible from the network.
- Modifying this array with strategic merge patch may corrupt
- the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255.
- Cannot be updated.
+ description: List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.
items:
- description: ContainerPort represents a network port in a
- single container.
+ description: ContainerPort represents a network port in a single container.
properties:
containerPort:
- description: Number of port to expose on the pod's IP
- address. This must be a valid port number, 0 < x < 65536.
+ description: Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
format: int32
type: integer
hostIP:
description: What host IP to bind the external port to.
type: string
hostPort:
- description: Number of port to expose on the host. If
- specified, this must be a valid port number, 0 < x <
- 65536. If HostNetwork is specified, this must match
- ContainerPort. Most containers do not need this.
+ description: Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.
format: int32
type: integer
name:
- description: If specified, this must be an IANA_SVC_NAME
- and unique within the pod. Each named port in a pod
- must have a unique name. Name for the port that can
- be referred to by services.
+ description: If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
type: string
protocol:
default: TCP
- description: Protocol for port. Must be UDP, TCP, or SCTP.
- Defaults to "TCP".
+ description: Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".
type: string
required:
- containerPort
@@ -3061,47 +1984,30 @@ spec:
- protocol
x-kubernetes-list-type: map
readinessProbe:
- description: 'Periodic probe of container service readiness.
- Container will be removed from service endpoints if the probe
- fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: Command is the command line to execute
- inside the container, the working directory for the
- command is root ('/') in the container's filesystem.
- The command is simply exec'd, it is not run inside
- a shell, so traditional shell instructions ('|', etc)
- won't work. To use a shell, you need to explicitly
- call out to that shell. Exit status of 0 is treated
- as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe
- to be considered failed after having succeeded. Defaults
- to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
format: int32
type: integer
grpc:
- description: GRPC specifies an action involving a GRPC port.
- This is a beta field and requires enabling GRPCContainerProbe
- feature gate.
+ description: GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.
properties:
port:
- description: Port number of the gRPC service. Number
- must be in the range 1 to 65535.
+ description: Port number of the gRPC service. Number must be in the range 1 to 65535.
format: int32
type: integer
service:
- description: "Service is the name of the service to
- place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
- \n If this is not specified, the default behavior
- is defined by gRPC."
+ description: "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). \n If this is not specified, the default behavior is defined by gRPC."
type: string
required:
- port
@@ -3110,16 +2016,12 @@ spec:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to the
- pod IP. You probably want to set "Host" in httpHeaders
- instead.
+ description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP
- allows repeated headers.
+ description: Custom headers to set in the request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header
- to be used in HTTP probes
+ description: HTTPHeader describes a custom header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -3139,95 +2041,60 @@ spec:
anyOf:
- type: integer
- type: string
- description: Name or number of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: 'Number of seconds after the container has
- started before liveness probes are initiated. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
format: int32
type: integer
successThreshold:
- description: Minimum consecutive successes for the probe
- to be considered successful after having failed. Defaults
- to 1. Must be 1 for liveness and startup. Minimum value
- is 1.
+ description: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
- description: TCPSocket specifies an action involving a TCP
- port.
+ description: TCPSocket specifies an action involving a TCP port.
properties:
host:
- description: 'Optional: Host name to connect to, defaults
- to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: Number or name of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: Optional duration in seconds the pod needs
- to terminate gracefully upon probe failure. The grace
- period is the duration in seconds after the processes
- running in the pod are sent a termination signal and the
- time when the processes are forcibly halted with a kill
- signal. Set this value longer than the expected cleanup
- time for your process. If this value is nil, the pod's
- terminationGracePeriodSeconds will be used. Otherwise,
- this value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates
- stop immediately via the kill signal (no opportunity to
- shut down). This is a beta field and requires enabling
- ProbeTerminationGracePeriod feature gate. Minimum value
- is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: 'Number of seconds after which the probe times
- out. Defaults to 1 second. Minimum value is 1. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
resources:
- description: 'Compute Resources required by this container.
- Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
properties:
claims:
- description: "Claims lists the names of resources, defined
- in spec.resourceClaims, that are used by this container.
- \n This is an alpha field and requires enabling the DynamicResourceAllocation
- feature gate. \n This field is immutable."
+ description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable."
items:
description: ResourceClaim references one entry in PodSpec.ResourceClaims.
properties:
name:
- description: Name must match the name of one entry
- in pod.spec.resourceClaims of the Pod where this
- field is used. It makes that resource available
- inside a container.
+ description: Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
type: string
required:
- name
@@ -3243,8 +2110,7 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute
- resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -3253,236 +2119,121 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Requests describes the minimum amount of compute
- resources required. If Requests is omitted for a container,
- it defaults to Limits if that is explicitly specified,
- otherwise to an implementation-defined value. More info:
- https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
securityContext:
- description: 'SecurityContext defines the security options the
- container should be run with. If set, the fields of SecurityContext
- override the equivalent fields of PodSecurityContext. More
- info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
+ description: 'SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
properties:
allowPrivilegeEscalation:
- description: 'AllowPrivilegeEscalation controls whether
- a process can gain more privileges than its parent process.
- This bool directly controls if the no_new_privs flag will
- be set on the container process. AllowPrivilegeEscalation
- is true always when the container is: 1) run as Privileged
- 2) has CAP_SYS_ADMIN Note that this field cannot be set
- when spec.os.name is windows.'
+ description: 'AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.'
type: boolean
capabilities:
- description: The capabilities to add/drop when running containers.
- Defaults to the default set of capabilities granted by
- the container runtime. Note that this field cannot be
- set when spec.os.name is windows.
+ description: The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.
properties:
add:
description: Added capabilities
items:
- description: Capability represent POSIX capabilities
- type
+ description: Capability represent POSIX capabilities type
type: string
type: array
drop:
description: Removed capabilities
items:
- description: Capability represent POSIX capabilities
- type
+ description: Capability represent POSIX capabilities type
type: string
type: array
type: object
privileged:
- description: Run container in privileged mode. Processes
- in privileged containers are essentially equivalent to
- root on the host. Defaults to false. Note that this field
- cannot be set when spec.os.name is windows.
+ description: Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.
type: boolean
procMount:
- description: procMount denotes the type of proc mount to
- use for the containers. The default is DefaultProcMount
- which uses the container runtime defaults for readonly
- paths and masked paths. This requires the ProcMountType
- feature flag to be enabled. Note that this field cannot
- be set when spec.os.name is windows.
+ description: procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.
type: string
readOnlyRootFilesystem:
- description: Whether this container has a read-only root
- filesystem. Default is false. Note that this field cannot
- be set when spec.os.name is windows.
+ description: Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.
type: boolean
runAsGroup:
- description: The GID to run the entrypoint of the container
- process. Uses runtime default if unset. May also be set
- in PodSecurityContext. If set in both SecurityContext
- and PodSecurityContext, the value specified in SecurityContext
- takes precedence. Note that this field cannot be set when
- spec.os.name is windows.
+ description: The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
format: int64
type: integer
runAsNonRoot:
- description: Indicates that the container must run as a
- non-root user. If true, the Kubelet will validate the
- image at runtime to ensure that it does not run as UID
- 0 (root) and fail to start the container if it does. If
- unset or false, no such validation will be performed.
- May also be set in PodSecurityContext. If set in both
- SecurityContext and PodSecurityContext, the value specified
- in SecurityContext takes precedence.
+ description: Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
type: boolean
runAsUser:
- description: The UID to run the entrypoint of the container
- process. Defaults to user specified in image metadata
- if unspecified. May also be set in PodSecurityContext. If
- set in both SecurityContext and PodSecurityContext, the
- value specified in SecurityContext takes precedence. Note
- that this field cannot be set when spec.os.name is windows.
+ description: The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
format: int64
type: integer
seLinuxOptions:
- description: The SELinux context to be applied to the container.
- If unspecified, the container runtime will allocate a
- random SELinux context for each container. May also be
- set in PodSecurityContext. If set in both SecurityContext
- and PodSecurityContext, the value specified in SecurityContext
- takes precedence. Note that this field cannot be set when
- spec.os.name is windows.
+ description: The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
properties:
level:
- description: Level is SELinux level label that applies
- to the container.
+ description: Level is SELinux level label that applies to the container.
type: string
role:
- description: Role is a SELinux role label that applies
- to the container.
+ description: Role is a SELinux role label that applies to the container.
type: string
type:
- description: Type is a SELinux type label that applies
- to the container.
+ description: Type is a SELinux type label that applies to the container.
type: string
user:
- description: User is a SELinux user label that applies
- to the container.
+ description: User is a SELinux user label that applies to the container.
type: string
type: object
seccompProfile:
- description: The seccomp options to use by this container.
- If seccomp options are provided at both the pod & container
- level, the container options override the pod options.
- Note that this field cannot be set when spec.os.name is
- windows.
+ description: The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
properties:
localhostProfile:
- description: localhostProfile indicates a profile defined
- in a file on the node should be used. The profile
- must be preconfigured on the node to work. Must be
- a descending path, relative to the kubelet's configured
- seccomp profile location. Must only be set if type
- is "Localhost".
+ description: localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost".
type: string
type:
- description: "type indicates which kind of seccomp profile
- will be applied. Valid options are: \n Localhost -
- a profile defined in a file on the node should be
- used. RuntimeDefault - the container runtime default
- profile should be used. Unconfined - no profile should
- be applied."
+ description: "type indicates which kind of seccomp profile will be applied. Valid options are: \n Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied."
type: string
required:
- type
type: object
windowsOptions:
- description: The Windows specific settings applied to all
- containers. If unspecified, the options from the PodSecurityContext
- will be used. If set in both SecurityContext and PodSecurityContext,
- the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is
- linux.
+ description: The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
properties:
gmsaCredentialSpec:
- description: GMSACredentialSpec is where the GMSA admission
- webhook (https://github.com/kubernetes-sigs/windows-gmsa)
- inlines the contents of the GMSA credential spec named
- by the GMSACredentialSpecName field.
+ description: GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.
type: string
gmsaCredentialSpecName:
- description: GMSACredentialSpecName is the name of the
- GMSA credential spec to use.
+ description: GMSACredentialSpecName is the name of the GMSA credential spec to use.
type: string
hostProcess:
- description: HostProcess determines if a container should
- be run as a 'Host Process' container. This field is
- alpha-level and will only be honored by components
- that enable the WindowsHostProcessContainers feature
- flag. Setting this field without the feature flag
- will result in errors when validating the Pod. All
- of a Pod's containers must have the same effective
- HostProcess value (it is not allowed to have a mix
- of HostProcess containers and non-HostProcess containers). In
- addition, if HostProcess is true then HostNetwork
- must also be set to true.
+ description: HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.
type: boolean
runAsUserName:
- description: The UserName in Windows to run the entrypoint
- of the container process. Defaults to the user specified
- in image metadata if unspecified. May also be set
- in PodSecurityContext. If set in both SecurityContext
- and PodSecurityContext, the value specified in SecurityContext
- takes precedence.
+ description: The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
type: string
type: object
type: object
startupProbe:
- description: 'StartupProbe indicates that the Pod has successfully
- initialized. If specified, no other probes are executed until
- this completes successfully. If this probe fails, the Pod
- will be restarted, just as if the livenessProbe failed. This
- can be used to provide different probe parameters at the beginning
- of a Pod''s lifecycle, when it might take a long time to load
- data or warm a cache, than during steady-state operation.
- This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod''s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: Command is the command line to execute
- inside the container, the working directory for the
- command is root ('/') in the container's filesystem.
- The command is simply exec'd, it is not run inside
- a shell, so traditional shell instructions ('|', etc)
- won't work. To use a shell, you need to explicitly
- call out to that shell. Exit status of 0 is treated
- as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe
- to be considered failed after having succeeded. Defaults
- to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
format: int32
type: integer
grpc:
- description: GRPC specifies an action involving a GRPC port.
- This is a beta field and requires enabling GRPCContainerProbe
- feature gate.
+ description: GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.
properties:
port:
- description: Port number of the gRPC service. Number
- must be in the range 1 to 65535.
+ description: Port number of the gRPC service. Number must be in the range 1 to 65535.
format: int32
type: integer
service:
- description: "Service is the name of the service to
- place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
- \n If this is not specified, the default behavior
- is defined by gRPC."
+ description: "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). \n If this is not specified, the default behavior is defined by gRPC."
type: string
required:
- port
@@ -3491,16 +2242,12 @@ spec:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to the
- pod IP. You probably want to set "Host" in httpHeaders
- instead.
+ description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP
- allows repeated headers.
+ description: Custom headers to set in the request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header
- to be used in HTTP probes
+ description: HTTPHeader describes a custom header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -3520,133 +2267,75 @@ spec:
anyOf:
- type: integer
- type: string
- description: Name or number of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: 'Number of seconds after the container has
- started before liveness probes are initiated. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
format: int32
type: integer
successThreshold:
- description: Minimum consecutive successes for the probe
- to be considered successful after having failed. Defaults
- to 1. Must be 1 for liveness and startup. Minimum value
- is 1.
+ description: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
- description: TCPSocket specifies an action involving a TCP
- port.
+ description: TCPSocket specifies an action involving a TCP port.
properties:
host:
- description: 'Optional: Host name to connect to, defaults
- to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: Number or name of the port to access on
- the container. Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: Optional duration in seconds the pod needs
- to terminate gracefully upon probe failure. The grace
- period is the duration in seconds after the processes
- running in the pod are sent a termination signal and the
- time when the processes are forcibly halted with a kill
- signal. Set this value longer than the expected cleanup
- time for your process. If this value is nil, the pod's
- terminationGracePeriodSeconds will be used. Otherwise,
- this value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates
- stop immediately via the kill signal (no opportunity to
- shut down). This is a beta field and requires enabling
- ProbeTerminationGracePeriod feature gate. Minimum value
- is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: 'Number of seconds after which the probe times
- out. Defaults to 1 second. Minimum value is 1. More info:
- https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
+ description: 'Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
stdin:
- description: Whether this container should allocate a buffer
- for stdin in the container runtime. If this is not set, reads
- from stdin in the container will always result in EOF. Default
- is false.
+ description: Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
type: boolean
stdinOnce:
- description: Whether the container runtime should close the
- stdin channel after it has been opened by a single attach.
- When stdin is true the stdin stream will remain open across
- multiple attach sessions. If stdinOnce is set to true, stdin
- is opened on container start, is empty until the first client
- attaches to stdin, and then remains open and accepts data
- until the client disconnects, at which time stdin is closed
- and remains closed until the container is restarted. If this
- flag is false, a container processes that reads from stdin
- will never receive an EOF. Default is false
+ description: Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
type: boolean
terminationMessagePath:
- description: 'Optional: Path at which the file to which the
- container''s termination message will be written is mounted
- into the container''s filesystem. Message written is intended
- to be brief final status, such as an assertion failure message.
- Will be truncated by the node if greater than 4096 bytes.
- The total message length across all containers will be limited
- to 12kb. Defaults to /dev/termination-log. Cannot be updated.'
+ description: 'Optional: Path at which the file to which the container''s termination message will be written is mounted into the container''s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.'
type: string
terminationMessagePolicy:
- description: Indicate how the termination message should be
- populated. File will use the contents of terminationMessagePath
- to populate the container status message on both success and
- failure. FallbackToLogsOnError will use the last chunk of
- container log output if the termination message file is empty
- and the container exited with an error. The log output is
- limited to 2048 bytes or 80 lines, whichever is smaller. Defaults
- to File. Cannot be updated.
+ description: Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
type: string
tty:
- description: Whether this container should allocate a TTY for
- itself, also requires 'stdin' to be true. Default is false.
+ description: Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
type: boolean
volumeDevices:
- description: volumeDevices is the list of block devices to be
- used by the container.
+ description: volumeDevices is the list of block devices to be used by the container.
items:
- description: volumeDevice describes a mapping of a raw block
- device within a container.
+ description: volumeDevice describes a mapping of a raw block device within a container.
properties:
devicePath:
- description: devicePath is the path inside of the container
- that the device will be mapped to.
+ description: devicePath is the path inside of the container that the device will be mapped to.
type: string
name:
- description: name must match the name of a persistentVolumeClaim
- in the pod
+ description: name must match the name of a persistentVolumeClaim in the pod
type: string
required:
- devicePath
@@ -3654,40 +2343,27 @@ spec:
type: object
type: array
volumeMounts:
- description: Pod volumes to mount into the container's filesystem.
- Cannot be updated.
+ description: Pod volumes to mount into the container's filesystem. Cannot be updated.
items:
- description: VolumeMount describes a mounting of a Volume
- within a container.
+ description: VolumeMount describes a mounting of a Volume within a container.
properties:
mountPath:
- description: Path within the container at which the volume
- should be mounted. Must not contain ':'.
+ description: Path within the container at which the volume should be mounted. Must not contain ':'.
type: string
mountPropagation:
- description: mountPropagation determines how mounts are
- propagated from the host to container and the other
- way around. When not set, MountPropagationNone is used.
- This field is beta in 1.10.
+ description: mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.
type: string
name:
description: This must match the Name of a Volume.
type: string
readOnly:
- description: Mounted read-only if true, read-write otherwise
- (false or unspecified). Defaults to false.
+ description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
type: boolean
subPath:
- description: Path within the volume from which the container's
- volume should be mounted. Defaults to "" (volume's root).
+ description: Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
type: string
subPathExpr:
- description: Expanded path within the volume from which
- the container's volume should be mounted. Behaves similarly
- to SubPath but environment variable references $(VAR_NAME)
- are expanded using the container's environment. Defaults
- to "" (volume's root). SubPathExpr and SubPath are mutually
- exclusive.
+ description: Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.
type: string
required:
- mountPath
@@ -3695,9 +2371,7 @@ spec:
type: object
type: array
workingDir:
- description: Container's working directory. If not specified,
- the container runtime's default will be used, which might
- be configured in the container image. Cannot be updated.
+ description: Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.
type: string
required:
- name
@@ -3706,14 +2380,10 @@ spec:
labels:
additionalProperties:
type: string
- description: Labels configure the external label pairs to ThanosRuler.
- A default replica label `thanos_ruler_replica` will be always added as
- a label with the value of the pod's name and it will be dropped
- in the alerts.
+ description: Labels configure the external label pairs to ThanosRuler. A default replica label `thanos_ruler_replica` will be always added as a label with the value of the pod's name and it will be dropped in the alerts.
type: object
listenLocal:
- description: ListenLocal makes the Thanos ruler listen on loopback,
- so that it does not bind against the Pod IP.
+ description: ListenLocal makes the Thanos ruler listen on loopback, so that it does not bind against the Pod IP.
type: boolean
logFormat:
description: Log format for ThanosRuler to be configured with.
@@ -3732,12 +2402,7 @@ spec:
- error
type: string
minReadySeconds:
- description: Minimum number of seconds for which a newly created pod
- should be ready without any of its container crashing for it to
- be considered available. Defaults to 0 (pod will be considered available
- as soon as it is ready) This is an alpha field from kubernetes 1.22
- until 1.24 which requires enabling the StatefulSetMinReadySeconds
- feature gate.
+ description: Minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) This is an alpha field from kubernetes 1.22 until 1.24 which requires enabling the StatefulSetMinReadySeconds feature gate.
format: int32
type: integer
nodeSelector:
@@ -3746,16 +2411,13 @@ spec:
description: Define which Nodes the Pods are scheduled on.
type: object
objectStorageConfig:
- description: ObjectStorageConfig configures object storage in Thanos.
- Alternative to ObjectStorageConfigFile, and lower order priority.
+ description: ObjectStorageConfig configures object storage in Thanos. Alternative to ObjectStorageConfigFile, and lower order priority.
properties:
key:
- description: The key of the secret to select from. Must be a
- valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
description: Specify whether the Secret or its key must be defined
@@ -3765,60 +2427,39 @@ spec:
type: object
x-kubernetes-map-type: atomic
objectStorageConfigFile:
- description: ObjectStorageConfigFile specifies the path of the object
- storage configuration file. When used alongside with ObjectStorageConfig,
- ObjectStorageConfigFile takes precedence.
+ description: ObjectStorageConfigFile specifies the path of the object storage configuration file. When used alongside with ObjectStorageConfig, ObjectStorageConfigFile takes precedence.
type: string
paused:
- description: When a ThanosRuler deployment is paused, no actions except
- for deletion will be performed on the underlying objects.
+ description: When a ThanosRuler deployment is paused, no actions except for deletion will be performed on the underlying objects.
type: boolean
podMetadata:
- description: PodMetadata contains Labels and Annotations gets propagated
- to the thanos ruler pods.
+ description: PodMetadata contains Labels and Annotations gets propagated to the thanos ruler pods.
properties:
annotations:
additionalProperties:
type: string
- description: 'Annotations is an unstructured key value map stored
- with a resource that may be set by external tools to store and
- retrieve arbitrary metadata. They are not queryable and should
- be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations'
+ description: 'Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations'
type: object
labels:
additionalProperties:
type: string
- description: 'Map of string keys and values that can be used to
- organize and categorize (scope and select) objects. May match
- selectors of replication controllers and services. More info:
- http://kubernetes.io/docs/user-guide/labels'
+ description: 'Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels'
type: object
name:
- description: 'Name must be unique within a namespace. Is required
- when creating resources, although some resources may allow a
- client to request the generation of an appropriate name automatically.
- Name is primarily intended for creation idempotence and configuration
- definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names'
+ description: 'Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names'
type: string
type: object
portName:
default: web
- description: Port name used for the pods and governing service. Defaults
- to `web`.
+ description: Port name used for the pods and governing service. Defaults to `web`.
type: string
priorityClassName:
description: Priority class assigned to the Pods
type: string
prometheusRulesExcludedFromEnforce:
- description: 'PrometheusRulesExcludedFromEnforce - list of Prometheus
- rules to be excluded from enforcing of adding namespace labels.
- Works only if enforcedNamespaceLabel set to true. Make sure both
- ruleNamespace and ruleName are set for each pair Deprecated: use
- excludedFromEnforcement instead.'
+ description: 'PrometheusRulesExcludedFromEnforce - list of Prometheus rules to be excluded from enforcing of adding namespace labels. Works only if enforcedNamespaceLabel set to true. Make sure both ruleNamespace and ruleName are set for each pair Deprecated: use excludedFromEnforcement instead.'
items:
- description: PrometheusRuleExcludeConfig enables users to configure
- excluded PrometheusRule names and their namespaces to be ignored
- while enforcing namespace label for alerts and metrics.
+ description: PrometheusRuleExcludeConfig enables users to configure excluded PrometheusRule names and their namespaces to be ignored while enforcing namespace label for alerts and metrics.
properties:
ruleName:
description: RuleNamespace - name of excluded rule
@@ -3832,18 +2473,13 @@ spec:
type: object
type: array
queryConfig:
- description: Define configuration for connecting to thanos query instances.
- If this is defined, the QueryEndpoints field will be ignored. Maps
- to the `query.config` CLI argument. Only available with thanos v0.11.0
- and higher.
+ description: Define configuration for connecting to thanos query instances. If this is defined, the QueryEndpoints field will be ignored. Maps to the `query.config` CLI argument. Only available with thanos v0.11.0 and higher.
properties:
key:
- description: The key of the secret to select from. Must be a
- valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
description: Specify whether the Secret or its key must be defined
@@ -3853,8 +2489,7 @@ spec:
type: object
x-kubernetes-map-type: atomic
queryEndpoints:
- description: QueryEndpoints defines Thanos querier endpoints from
- which to query metrics. Maps to the --query flag of thanos ruler.
+ description: QueryEndpoints defines Thanos querier endpoints from which to query metrics. Maps to the --query flag of thanos ruler.
items:
type: string
type: array
@@ -3863,21 +2498,15 @@ spec:
format: int32
type: integer
resources:
- description: Resources defines the resource requirements for single
- Pods. If not provided, no requests/limits will be set
+ description: Resources defines the resource requirements for single Pods. If not provided, no requests/limits will be set
properties:
claims:
- description: "Claims lists the names of resources, defined in
- spec.resourceClaims, that are used by this container. \n This
- is an alpha field and requires enabling the DynamicResourceAllocation
- feature gate. \n This field is immutable."
+ description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable."
items:
description: ResourceClaim references one entry in PodSpec.ResourceClaims.
properties:
name:
- description: Name must match the name of one entry in pod.spec.resourceClaims
- of the Pod where this field is used. It makes that resource
- available inside a container.
+ description: Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
type: string
required:
- name
@@ -3893,8 +2522,7 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute resources
- allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -3903,50 +2531,33 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Requests describes the minimum amount of compute
- resources required. If Requests is omitted for a container,
- it defaults to Limits if that is explicitly specified, otherwise
- to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
retention:
default: 24h
- description: Time duration ThanosRuler shall retain data for. Default
- is '24h', and must match the regular expression `[0-9]+(ms|s|m|h|d|w|y)`
- (milliseconds seconds minutes hours days weeks years).
+ description: Time duration ThanosRuler shall retain data for. Default is '24h', and must match the regular expression `[0-9]+(ms|s|m|h|d|w|y)` (milliseconds seconds minutes hours days weeks years).
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
type: string
routePrefix:
- description: The route prefix ThanosRuler registers HTTP handlers
- for. This allows thanos UI to be served on a sub-path.
+ description: The route prefix ThanosRuler registers HTTP handlers for. This allows thanos UI to be served on a sub-path.
type: string
ruleNamespaceSelector:
- description: Namespaces to be selected for Rules discovery. If unspecified,
- only the same namespace as the ThanosRuler object is in is used.
+ description: Namespaces to be selected for Rules discovery. If unspecified, only the same namespace as the ThanosRuler object is in is used.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements.
- The requirements are ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a selector that
- contains values, a key, and an operator that relates the key
- and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the selector applies
- to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship to
- a set of values. Valid operators are In, NotIn, Exists
- and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string values. If the
- operator is In or NotIn, the values array must be non-empty.
- If the operator is Exists or DoesNotExist, the values
- array must be empty. This array is replaced during a strategic
- merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -3958,41 +2569,26 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value} pairs. A single
- {key,value} in the matchLabels map is equivalent to an element
- of matchExpressions, whose key field is "key", the operator
- is "In", and the values array contains only "value". The requirements
- are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
ruleSelector:
- description: A label selector to select which PrometheusRules to mount
- for alerting and recording.
+ description: A label selector to select which PrometheusRules to mount for alerting and recording.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements.
- The requirements are ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a selector that
- contains values, a key, and an operator that relates the key
- and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the selector applies
- to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship to
- a set of values. Valid operators are In, NotIn, Exists
- and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string values. If the
- operator is In or NotIn, the values array must be non-empty.
- If the operator is Exists or DoesNotExist, the values
- array must be empty. This array is replaced during a strategic
- merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -4004,132 +2600,67 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value} pairs. A single
- {key,value} in the matchLabels map is equivalent to an element
- of matchExpressions, whose key field is "key", the operator
- is "In", and the values array contains only "value". The requirements
- are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
securityContext:
- description: SecurityContext holds pod-level security attributes and
- common container settings. This defaults to the default PodSecurityContext.
+ description: SecurityContext holds pod-level security attributes and common container settings. This defaults to the default PodSecurityContext.
properties:
fsGroup:
- description: "A special supplemental group that applies to all
- containers in a pod. Some volume types allow the Kubelet to
- change the ownership of that volume to be owned by the pod:
- \n 1. The owning GID will be the FSGroup 2. The setgid bit is
- set (new files created in the volume will be owned by FSGroup)
- 3. The permission bits are OR'd with rw-rw---- \n If unset,
- the Kubelet will not modify the ownership and permissions of
- any volume. Note that this field cannot be set when spec.os.name
- is windows."
+ description: "A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: \n 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- \n If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows."
format: int64
type: integer
fsGroupChangePolicy:
- description: 'fsGroupChangePolicy defines behavior of changing
- ownership and permission of the volume before being exposed
- inside Pod. This field will only apply to volume types which
- support fsGroup based ownership(and permissions). It will have
- no effect on ephemeral volume types such as: secret, configmaps
- and emptydir. Valid values are "OnRootMismatch" and "Always".
- If not specified, "Always" is used. Note that this field cannot
- be set when spec.os.name is windows.'
+ description: 'fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. Note that this field cannot be set when spec.os.name is windows.'
type: string
runAsGroup:
- description: The GID to run the entrypoint of the container process.
- Uses runtime default if unset. May also be set in SecurityContext. If
- set in both SecurityContext and PodSecurityContext, the value
- specified in SecurityContext takes precedence for that container.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
format: int64
type: integer
runAsNonRoot:
- description: Indicates that the container must run as a non-root
- user. If true, the Kubelet will validate the image at runtime
- to ensure that it does not run as UID 0 (root) and fail to start
- the container if it does. If unset or false, no such validation
- will be performed. May also be set in SecurityContext. If set
- in both SecurityContext and PodSecurityContext, the value specified
- in SecurityContext takes precedence.
+ description: Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
type: boolean
runAsUser:
- description: The UID to run the entrypoint of the container process.
- Defaults to user specified in image metadata if unspecified.
- May also be set in SecurityContext. If set in both SecurityContext
- and PodSecurityContext, the value specified in SecurityContext
- takes precedence for that container. Note that this field cannot
- be set when spec.os.name is windows.
+ description: The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
format: int64
type: integer
seLinuxOptions:
- description: The SELinux context to be applied to all containers.
- If unspecified, the container runtime will allocate a random
- SELinux context for each container. May also be set in SecurityContext. If
- set in both SecurityContext and PodSecurityContext, the value
- specified in SecurityContext takes precedence for that container.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
properties:
level:
- description: Level is SELinux level label that applies to
- the container.
+ description: Level is SELinux level label that applies to the container.
type: string
role:
- description: Role is a SELinux role label that applies to
- the container.
+ description: Role is a SELinux role label that applies to the container.
type: string
type:
- description: Type is a SELinux type label that applies to
- the container.
+ description: Type is a SELinux type label that applies to the container.
type: string
user:
- description: User is a SELinux user label that applies to
- the container.
+ description: User is a SELinux user label that applies to the container.
type: string
type: object
seccompProfile:
- description: The seccomp options to use by the containers in this
- pod. Note that this field cannot be set when spec.os.name is
- windows.
+ description: The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.
properties:
localhostProfile:
- description: localhostProfile indicates a profile defined
- in a file on the node should be used. The profile must be
- preconfigured on the node to work. Must be a descending
- path, relative to the kubelet's configured seccomp profile
- location. Must only be set if type is "Localhost".
+ description: localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost".
type: string
type:
- description: "type indicates which kind of seccomp profile
- will be applied. Valid options are: \n Localhost - a profile
- defined in a file on the node should be used. RuntimeDefault
- - the container runtime default profile should be used.
- Unconfined - no profile should be applied."
+ description: "type indicates which kind of seccomp profile will be applied. Valid options are: \n Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied."
type: string
required:
- type
type: object
supplementalGroups:
- description: A list of groups applied to the first process run
- in each container, in addition to the container's primary GID,
- the fsGroup (if specified), and group memberships defined in
- the container image for the uid of the container process. If
- unspecified, no additional groups are added to any container.
- Note that group memberships defined in the container image for
- the uid of the container process are still effective, even if
- they are not included in this list. Note that this field cannot
- be set when spec.os.name is windows.
+ description: A list of groups applied to the first process run in each container, in addition to the container's primary GID, the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process. If unspecified, no additional groups are added to any container. Note that group memberships defined in the container image for the uid of the container process are still effective, even if they are not included in this list. Note that this field cannot be set when spec.os.name is windows.
items:
format: int64
type: integer
type: array
sysctls:
- description: Sysctls hold a list of namespaced sysctls used for
- the pod. Pods with unsupported sysctls (by the container runtime)
- might fail to launch. Note that this field cannot be set when
- spec.os.name is windows.
+ description: Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows.
items:
description: Sysctl defines a kernel parameter to be set
properties:
@@ -4145,150 +2676,73 @@ spec:
type: object
type: array
windowsOptions:
- description: The Windows specific settings applied to all containers.
- If unspecified, the options within a container's SecurityContext
- will be used. If set in both SecurityContext and PodSecurityContext,
- the value specified in SecurityContext takes precedence. Note
- that this field cannot be set when spec.os.name is linux.
+ description: The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
properties:
gmsaCredentialSpec:
- description: GMSACredentialSpec is where the GMSA admission
- webhook (https://github.com/kubernetes-sigs/windows-gmsa)
- inlines the contents of the GMSA credential spec named by
- the GMSACredentialSpecName field.
+ description: GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.
type: string
gmsaCredentialSpecName:
- description: GMSACredentialSpecName is the name of the GMSA
- credential spec to use.
+ description: GMSACredentialSpecName is the name of the GMSA credential spec to use.
type: string
hostProcess:
- description: HostProcess determines if a container should
- be run as a 'Host Process' container. This field is alpha-level
- and will only be honored by components that enable the WindowsHostProcessContainers
- feature flag. Setting this field without the feature flag
- will result in errors when validating the Pod. All of a
- Pod's containers must have the same effective HostProcess
- value (it is not allowed to have a mix of HostProcess containers
- and non-HostProcess containers). In addition, if HostProcess
- is true then HostNetwork must also be set to true.
+ description: HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.
type: boolean
runAsUserName:
- description: The UserName in Windows to run the entrypoint
- of the container process. Defaults to the user specified
- in image metadata if unspecified. May also be set in PodSecurityContext.
- If set in both SecurityContext and PodSecurityContext, the
- value specified in SecurityContext takes precedence.
+ description: The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
type: string
type: object
type: object
serviceAccountName:
- description: ServiceAccountName is the name of the ServiceAccount
- to use to run the Thanos Ruler Pods.
+ description: ServiceAccountName is the name of the ServiceAccount to use to run the Thanos Ruler Pods.
type: string
storage:
description: Storage spec to specify how storage shall be used.
properties:
disableMountSubPath:
- description: 'Deprecated: subPath usage will be disabled by default
- in a future release, this option will become unnecessary. DisableMountSubPath
- allows to remove any subPath usage in volume mounts.'
+ description: 'Deprecated: subPath usage will be disabled by default in a future release, this option will become unnecessary. DisableMountSubPath allows to remove any subPath usage in volume mounts.'
type: boolean
emptyDir:
- description: 'EmptyDirVolumeSource to be used by the StatefulSet.
- If specified, used in place of any volumeClaimTemplate. More
- info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir'
+ description: 'EmptyDirVolumeSource to be used by the StatefulSet. If specified, used in place of any volumeClaimTemplate. More info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir'
properties:
medium:
- description: 'medium represents what type of storage medium
- should back this directory. The default is "" which means
- to use the node''s default medium. Must be an empty string
- (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
+ description: 'medium represents what type of storage medium should back this directory. The default is "" which means to use the node''s default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
type: string
sizeLimit:
anyOf:
- type: integer
- type: string
- description: 'sizeLimit is the total amount of local storage
- required for this EmptyDir volume. The size limit is also
- applicable for memory medium. The maximum usage on memory
- medium EmptyDir would be the minimum value between the SizeLimit
- specified here and the sum of memory limits of all containers
- in a pod. The default is nil which means that the limit
- is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir'
+ description: 'sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir'
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
type: object
ephemeral:
- description: 'EphemeralVolumeSource to be used by the StatefulSet.
- This is a beta field in k8s 1.21, for lower versions, starting
- with k8s 1.19, it requires enabling the GenericEphemeralVolume
- feature gate. More info: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes'
+ description: 'EphemeralVolumeSource to be used by the StatefulSet. This is a beta field in k8s 1.21, for lower versions, starting with k8s 1.19, it requires enabling the GenericEphemeralVolume feature gate. More info: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes'
properties:
volumeClaimTemplate:
- description: "Will be used to create a stand-alone PVC to
- provision the volume. The pod in which this EphemeralVolumeSource
- is embedded will be the owner of the PVC, i.e. the PVC will
- be deleted together with the pod. The name of the PVC will
- be `<pod name>-<volume name>` where `<volume name>` is the
- name from the `PodSpec.Volumes` array entry. Pod validation
- will reject the pod if the concatenated name is not valid
- for a PVC (for example, too long). \n An existing PVC with
- that name that is not owned by the pod will *not* be used
- for the pod to avoid using an unrelated volume by mistake.
- Starting the pod is then blocked until the unrelated PVC
- is removed. If such a pre-created PVC is meant to be used
- by the pod, the PVC has to updated with an owner reference
- to the pod once the pod exists. Normally this should not
- be necessary, but it may be useful when manually reconstructing
- a broken cluster. \n This field is read-only and no changes
- will be made by Kubernetes to the PVC after it has been
- created. \n Required, must not be nil."
+ description: "Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `<pod name>-<volume name>` where `<volume name>` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). \n An existing PVC with that name that is not owned by the pod will *not* be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. \n This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. \n Required, must not be nil."
properties:
metadata:
- description: May contain labels and annotations that will
- be copied into the PVC when creating it. No other fields
- are allowed and will be rejected during validation.
+ description: May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.
type: object
spec:
- description: The specification for the PersistentVolumeClaim.
- The entire content is copied unchanged into the PVC
- that gets created from this template. The same fields
- as in a PersistentVolumeClaim are also valid here.
+ description: The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
properties:
accessModes:
- description: 'accessModes contains the desired access
- modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
+ description: 'accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
items:
type: string
type: array
dataSource:
- description: 'dataSource field can be used to specify
- either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
- * An existing PVC (PersistentVolumeClaim) If the
- provisioner or an external controller can support
- the specified data source, it will create a new
- volume based on the contents of the specified data
- source. When the AnyVolumeDataSource feature gate
- is enabled, dataSource contents will be copied to
- dataSourceRef, and dataSourceRef contents will be
- copied to dataSource when dataSourceRef.namespace
- is not specified. If the namespace is specified,
- then dataSourceRef will not be copied to dataSource.'
+ description: 'dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.'
properties:
apiGroup:
- description: APIGroup is the group for the resource
- being referenced. If APIGroup is not specified,
- the specified Kind must be in the core API group.
- For any other third-party types, APIGroup is
- required.
+ description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
type: string
kind:
- description: Kind is the type of resource being
- referenced
+ description: Kind is the type of resource being referenced
type: string
name:
- description: Name is the name of resource being
- referenced
+ description: Name is the name of resource being referenced
type: string
required:
- kind
@@ -4296,89 +2750,34 @@ spec:
type: object
x-kubernetes-map-type: atomic
dataSourceRef:
- description: 'dataSourceRef specifies the object from
- which to populate the volume with data, if a non-empty
- volume is desired. This may be any object from a
- non-empty API group (non core object) or a PersistentVolumeClaim
- object. When this field is specified, volume binding
- will only succeed if the type of the specified object
- matches some installed volume populator or dynamic
- provisioner. This field will replace the functionality
- of the dataSource field and as such if both fields
- are non-empty, they must have the same value. For
- backwards compatibility, when namespace isn''t specified
- in dataSourceRef, both fields (dataSource and dataSourceRef)
- will be set to the same value automatically if one
- of them is empty and the other is non-empty. When
- namespace is specified in dataSourceRef, dataSource
- isn''t set to the same value and must be empty.
- There are three important differences between dataSource
- and dataSourceRef: * While dataSource only allows
- two specific types of objects, dataSourceRef allows
- any non-core object, as well as PersistentVolumeClaim
- objects. * While dataSource ignores disallowed values
- (dropping them), dataSourceRef preserves all values,
- and generates an error if a disallowed value is
- specified. * While dataSource only allows local
- objects, dataSourceRef allows objects in any namespaces.
- (Beta) Using this field requires the AnyVolumeDataSource
- feature gate to be enabled. (Alpha) Using the namespace
- field of dataSourceRef requires the CrossNamespaceVolumeDataSource
- feature gate to be enabled.'
+ description: 'dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn''t specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn''t set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.'
properties:
apiGroup:
- description: APIGroup is the group for the resource
- being referenced. If APIGroup is not specified,
- the specified Kind must be in the core API group.
- For any other third-party types, APIGroup is
- required.
+ description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
type: string
kind:
- description: Kind is the type of resource being
- referenced
+ description: Kind is the type of resource being referenced
type: string
name:
- description: Name is the name of resource being
- referenced
+ description: Name is the name of resource being referenced
type: string
namespace:
- description: Namespace is the namespace of resource
- being referenced Note that when a namespace
- is specified, a gateway.networking.k8s.io/ReferenceGrant
- object is required in the referent namespace
- to allow that namespace's owner to accept the
- reference. See the ReferenceGrant documentation
- for details. (Alpha) This field requires the
- CrossNamespaceVolumeDataSource feature gate
- to be enabled.
+ description: Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
type: string
required:
- kind
- name
type: object
resources:
- description: 'resources represents the minimum resources
- the volume should have. If RecoverVolumeExpansionFailure
- feature is enabled users are allowed to specify
- resource requirements that are lower than previous
- value but must still be higher than capacity recorded
- in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
+ description: 'resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
properties:
claims:
- description: "Claims lists the names of resources,
- defined in spec.resourceClaims, that are used
- by this container. \n This is an alpha field
- and requires enabling the DynamicResourceAllocation
- feature gate. \n This field is immutable."
+ description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable."
items:
- description: ResourceClaim references one entry
- in PodSpec.ResourceClaims.
+ description: ResourceClaim references one entry in PodSpec.ResourceClaims.
properties:
name:
- description: Name must match the name of
- one entry in pod.spec.resourceClaims of
- the Pod where this field is used. It makes
- that resource available inside a container.
+ description: Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
type: string
required:
- name
@@ -4394,8 +2793,7 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount
- of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -4404,43 +2802,25 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Requests describes the minimum amount
- of compute resources required. If Requests is
- omitted for a container, it defaults to Limits
- if that is explicitly specified, otherwise to
- an implementation-defined value. More info:
- https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
selector:
- description: selector is a label query over volumes
- to consider for binding.
+ description: selector is a label query over volumes to consider for binding.
properties:
matchExpressions:
- description: matchExpressions is a list of label
- selector requirements. The requirements are
- ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is
- a selector that contains values, a key, and
- an operator that relates the key and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the
- selector applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's
- relationship to a set of values. Valid
- operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string
- values. If the operator is In or NotIn,
- the values array must be non-empty. If
- the operator is Exists or DoesNotExist,
- the values array must be empty. This array
- is replaced during a strategic merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -4452,27 +2832,18 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value}
- pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions,
- whose key field is "key", the operator is "In",
- and the values array contains only "value".
- The requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
storageClassName:
- description: 'storageClassName is the name of the
- StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
+ description: 'storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
type: string
volumeMode:
- description: volumeMode defines what type of volume
- is required by the claim. Value of Filesystem is
- implied when not included in claim spec.
+ description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
type: string
volumeName:
- description: volumeName is the binding reference to
- the PersistentVolume backing this claim.
+ description: volumeName is the binding reference to the PersistentVolume backing this claim.
type: string
type: object
required:
@@ -4480,81 +2851,44 @@ spec:
type: object
type: object
volumeClaimTemplate:
- description: A PVC spec to be used by the StatefulSet. The easiest
- way to use a volume that cannot be automatically provisioned
- (for whatever reason) is to use a label selector alongside manually
- created PersistentVolumes.
+ description: A PVC spec to be used by the StatefulSet. The easiest way to use a volume that cannot be automatically provisioned (for whatever reason) is to use a label selector alongside manually created PersistentVolumes.
properties:
apiVersion:
- description: 'APIVersion defines the versioned schema of this
- representation of an object. Servers should convert recognized
- schemas to the latest internal value, and may reject unrecognized
- values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+ description: 'APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: 'Kind is a string value representing the REST
- resource this object represents. Servers may infer this
- from the endpoint the client submits requests to. Cannot
- be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+ description: 'Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
- description: EmbeddedMetadata contains metadata relevant to
- an EmbeddedResource.
+ description: EmbeddedMetadata contains metadata relevant to an EmbeddedResource.
properties:
annotations:
additionalProperties:
type: string
- description: 'Annotations is an unstructured key value
- map stored with a resource that may be set by external
- tools to store and retrieve arbitrary metadata. They
- are not queryable and should be preserved when modifying
- objects. More info: http://kubernetes.io/docs/user-guide/annotations'
+ description: 'Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations'
type: object
labels:
additionalProperties:
type: string
- description: 'Map of string keys and values that can be
- used to organize and categorize (scope and select) objects.
- May match selectors of replication controllers and services.
- More info: http://kubernetes.io/docs/user-guide/labels'
+ description: 'Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels'
type: object
name:
- description: 'Name must be unique within a namespace.
- Is required when creating resources, although some resources
- may allow a client to request the generation of an appropriate
- name automatically. Name is primarily intended for creation
- idempotence and configuration definition. Cannot be
- updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names'
+ description: 'Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names'
type: string
type: object
spec:
- description: 'Spec defines the desired characteristics of
- a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
+ description: 'Spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
properties:
accessModes:
- description: 'accessModes contains the desired access
- modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
+ description: 'accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
items:
type: string
type: array
dataSource:
- description: 'dataSource field can be used to specify
- either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
- * An existing PVC (PersistentVolumeClaim) If the provisioner
- or an external controller can support the specified
- data source, it will create a new volume based on the
- contents of the specified data source. When the AnyVolumeDataSource
- feature gate is enabled, dataSource contents will be
- copied to dataSourceRef, and dataSourceRef contents
- will be copied to dataSource when dataSourceRef.namespace
- is not specified. If the namespace is specified, then
- dataSourceRef will not be copied to dataSource.'
+ description: 'dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.'
properties:
apiGroup:
- description: APIGroup is the group for the resource
- being referenced. If APIGroup is not specified,
- the specified Kind must be in the core API group.
- For any other third-party types, APIGroup is required.
+ description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
type: string
kind:
description: Kind is the type of resource being referenced
@@ -4568,40 +2902,10 @@ spec:
type: object
x-kubernetes-map-type: atomic
dataSourceRef:
- description: 'dataSourceRef specifies the object from
- which to populate the volume with data, if a non-empty
- volume is desired. This may be any object from a non-empty
- API group (non core object) or a PersistentVolumeClaim
- object. When this field is specified, volume binding
- will only succeed if the type of the specified object
- matches some installed volume populator or dynamic provisioner.
- This field will replace the functionality of the dataSource
- field and as such if both fields are non-empty, they
- must have the same value. For backwards compatibility,
- when namespace isn''t specified in dataSourceRef, both
- fields (dataSource and dataSourceRef) will be set to
- the same value automatically if one of them is empty
- and the other is non-empty. When namespace is specified
- in dataSourceRef, dataSource isn''t set to the same
- value and must be empty. There are three important differences
- between dataSource and dataSourceRef: * While dataSource
- only allows two specific types of objects, dataSourceRef
- allows any non-core object, as well as PersistentVolumeClaim
- objects. * While dataSource ignores disallowed values
- (dropping them), dataSourceRef preserves all values,
- and generates an error if a disallowed value is specified.
- * While dataSource only allows local objects, dataSourceRef
- allows objects in any namespaces. (Beta) Using this
- field requires the AnyVolumeDataSource feature gate
- to be enabled. (Alpha) Using the namespace field of
- dataSourceRef requires the CrossNamespaceVolumeDataSource
- feature gate to be enabled.'
+ description: 'dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn''t specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn''t set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.'
properties:
apiGroup:
- description: APIGroup is the group for the resource
- being referenced. If APIGroup is not specified,
- the specified Kind must be in the core API group.
- For any other third-party types, APIGroup is required.
+ description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
type: string
kind:
description: Kind is the type of resource being referenced
@@ -4610,42 +2914,22 @@ spec:
description: Name is the name of resource being referenced
type: string
namespace:
- description: Namespace is the namespace of resource
- being referenced Note that when a namespace is specified,
- a gateway.networking.k8s.io/ReferenceGrant object
- is required in the referent namespace to allow that
- namespace's owner to accept the reference. See the
- ReferenceGrant documentation for details. (Alpha)
- This field requires the CrossNamespaceVolumeDataSource
- feature gate to be enabled.
+ description: Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
type: string
required:
- kind
- name
type: object
resources:
- description: 'resources represents the minimum resources
- the volume should have. If RecoverVolumeExpansionFailure
- feature is enabled users are allowed to specify resource
- requirements that are lower than previous value but
- must still be higher than capacity recorded in the status
- field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
+ description: 'resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
properties:
claims:
- description: "Claims lists the names of resources,
- defined in spec.resourceClaims, that are used by
- this container. \n This is an alpha field and requires
- enabling the DynamicResourceAllocation feature gate.
- \n This field is immutable."
+ description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable."
items:
- description: ResourceClaim references one entry
- in PodSpec.ResourceClaims.
+ description: ResourceClaim references one entry in PodSpec.ResourceClaims.
properties:
name:
- description: Name must match the name of one
- entry in pod.spec.resourceClaims of the Pod
- where this field is used. It makes that resource
- available inside a container.
+ description: Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
type: string
required:
- name
@@ -4661,8 +2945,7 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount
- of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -4671,41 +2954,25 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Requests describes the minimum amount
- of compute resources required. If Requests is omitted
- for a container, it defaults to Limits if that is
- explicitly specified, otherwise to an implementation-defined
- value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
selector:
- description: selector is a label query over volumes to
- consider for binding.
+ description: selector is a label query over volumes to consider for binding.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector
- requirements. The requirements are ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a selector
- that contains values, a key, and an operator that
- relates the key and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the selector
- applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship
- to a set of values. Valid operators are In,
- NotIn, Exists and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string values.
- If the operator is In or NotIn, the values
- array must be non-empty. If the operator is
- Exists or DoesNotExist, the values array must
- be empty. This array is replaced during a
- strategic merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -4717,35 +2984,25 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value} pairs.
- A single {key,value} in the matchLabels map is equivalent
- to an element of matchExpressions, whose key field
- is "key", the operator is "In", and the values array
- contains only "value". The requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
storageClassName:
- description: 'storageClassName is the name of the StorageClass
- required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
+ description: 'storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
type: string
volumeMode:
- description: volumeMode defines what type of volume is
- required by the claim. Value of Filesystem is implied
- when not included in claim spec.
+ description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
type: string
volumeName:
- description: volumeName is the binding reference to the
- PersistentVolume backing this claim.
+ description: volumeName is the binding reference to the PersistentVolume backing this claim.
type: string
type: object
status:
- description: 'Status represents the current information/status
- of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
+ description: 'Status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
properties:
accessModes:
- description: 'accessModes contains the actual access modes
- the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
+ description: 'accessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
items:
type: string
type: array
@@ -4756,19 +3013,7 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: allocatedResources is the storage resource
- within AllocatedResources tracks the capacity allocated
- to a PVC. It may be larger than the actual capacity
- when a volume expansion operation is requested. For
- storage quota, the larger value from allocatedResources
- and PVC.spec.resources is used. If allocatedResources
- is not set, PVC.spec.resources alone is used for quota
- calculation. If a volume expansion capacity request
- is lowered, allocatedResources is only lowered if there
- are no expansion operations in progress and if the actual
- volume capacity is equal or lower than the requested
- capacity. This is an alpha field and requires enabling
- RecoverVolumeExpansionFailure feature.
+ description: allocatedResources is the storage resource within AllocatedResources tracks the capacity allocated to a PVC. It may be larger than the actual capacity when a volume expansion operation is requested. For storage quota, the larger value from allocatedResources and PVC.spec.resources is used. If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation. If a volume expansion capacity request is lowered, allocatedResources is only lowered if there are no expansion operations in progress and if the actual volume capacity is equal or lower than the requested capacity. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
type: object
capacity:
additionalProperties:
@@ -4777,43 +3022,31 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: capacity represents the actual resources
- of the underlying volume.
+ description: capacity represents the actual resources of the underlying volume.
type: object
conditions:
- description: conditions is the current Condition of persistent
- volume claim. If underlying persistent volume is being
- resized then the Condition will be set to 'ResizeStarted'.
+ description: conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'.
items:
- description: PersistentVolumeClaimCondition contails
- details about state of pvc
+ description: PersistentVolumeClaimCondition contails details about state of pvc
properties:
lastProbeTime:
- description: lastProbeTime is the time we probed
- the condition.
+ description: lastProbeTime is the time we probed the condition.
format: date-time
type: string
lastTransitionTime:
- description: lastTransitionTime is the time the
- condition transitioned from one status to another.
+ description: lastTransitionTime is the time the condition transitioned from one status to another.
format: date-time
type: string
message:
- description: message is the human-readable message
- indicating details about last transition.
+ description: message is the human-readable message indicating details about last transition.
type: string
reason:
- description: reason is a unique, this should be
- a short, machine understandable string that gives
- the reason for condition's last transition. If
- it reports "ResizeStarted" that means the underlying
- persistent volume is being resized.
+ description: reason is a unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "ResizeStarted" that means the underlying persistent volume is being resized.
type: string
status:
type: string
type:
- description: PersistentVolumeClaimConditionType
- is a valid value of PersistentVolumeClaimCondition.Type
+ description: PersistentVolumeClaimConditionType is a valid value of PersistentVolumeClaimCondition.Type
type: string
required:
- status
@@ -4824,11 +3057,7 @@ spec:
description: phase represents the current phase of PersistentVolumeClaim.
type: string
resizeStatus:
- description: resizeStatus stores status of resize operation.
- ResizeStatus is not set by default but when expansion
- is complete resizeStatus is set to empty string by resize
- controller or kubelet. This is an alpha field and requires
- enabling RecoverVolumeExpansionFailure feature.
+ description: resizeStatus stores status of resize operation. ResizeStatus is not set by default but when expansion is complete resizeStatus is set to empty string by resize controller or kubelet. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
type: string
type: object
type: object
@@ -4836,77 +3065,47 @@ spec:
tolerations:
description: If specified, the pod's tolerations.
items:
- description: The pod this Toleration is attached to tolerates any
- taint that matches the triple <key,value,effect> using the matching
- operator <operator>.
+ description: The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
properties:
effect:
- description: Effect indicates the taint effect to match. Empty
- means match all taint effects. When specified, allowed values
- are NoSchedule, PreferNoSchedule and NoExecute.
+ description: Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
type: string
key:
- description: Key is the taint key that the toleration applies
- to. Empty means match all taint keys. If the key is empty,
- operator must be Exists; this combination means to match all
- values and all keys.
+ description: Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
type: string
operator:
- description: Operator represents a key's relationship to the
- value. Valid operators are Exists and Equal. Defaults to Equal.
- Exists is equivalent to wildcard for value, so that a pod
- can tolerate all taints of a particular category.
+ description: Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
type: string
tolerationSeconds:
- description: TolerationSeconds represents the period of time
- the toleration (which must be of effect NoExecute, otherwise
- this field is ignored) tolerates the taint. By default, it
- is not set, which means tolerate the taint forever (do not
- evict). Zero and negative values will be treated as 0 (evict
- immediately) by the system.
+ description: TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
format: int64
type: integer
value:
- description: Value is the taint value the toleration matches
- to. If the operator is Exists, the value should be empty,
- otherwise just a regular string.
+ description: Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
type: string
type: object
type: array
topologySpreadConstraints:
description: If specified, the pod's topology spread constraints.
items:
- description: TopologySpreadConstraint specifies how to spread matching
- pods among the given topology.
+ description: TopologySpreadConstraint specifies how to spread matching pods among the given topology.
properties:
labelSelector:
- description: LabelSelector is used to find matching pods. Pods
- that match this label selector are counted to determine the
- number of pods in their corresponding topology domain.
+ description: LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector
- requirements. The requirements are ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a selector
- that contains values, a key, and an operator that relates
- the key and values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that the selector
- applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship
- to a set of values. Valid operators are In, NotIn,
- Exists and DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string values.
- If the operator is In or NotIn, the values array
- must be non-empty. If the operator is Exists or
- DoesNotExist, the values array must be empty. This
- array is replaced during a strategic merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -4918,122 +3117,35 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value} pairs.
- A single {key,value} in the matchLabels map is equivalent
- to an element of matchExpressions, whose key field is
- "key", the operator is "In", and the values array contains
- only "value". The requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
matchLabelKeys:
- description: MatchLabelKeys is a set of pod label keys to select
- the pods over which spreading will be calculated. The keys
- are used to lookup values from the incoming pod labels, those
- key-value labels are ANDed with labelSelector to select the
- group of existing pods over which spreading will be calculated
- for the incoming pod. Keys that don't exist in the incoming
- pod labels will be ignored. A null or empty list means only
- match against labelSelector.
+ description: MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated. The keys are used to lookup values from the incoming pod labels, those key-value labels are ANDed with labelSelector to select the group of existing pods over which spreading will be calculated for the incoming pod. Keys that don't exist in the incoming pod labels will be ignored. A null or empty list means only match against labelSelector.
items:
type: string
type: array
x-kubernetes-list-type: atomic
maxSkew:
- description: 'MaxSkew describes the degree to which pods may
- be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`,
- it is the maximum permitted difference between the number
- of matching pods in the target topology and the global minimum.
- The global minimum is the minimum number of matching pods
- in an eligible domain or zero if the number of eligible domains
- is less than MinDomains. For example, in a 3-zone cluster,
- MaxSkew is set to 1, and pods with the same labelSelector
- spread as 2/2/1: In this case, the global minimum is 1. |
- zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew
- is 1, incoming pod can only be scheduled to zone3 to become
- 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1)
- on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming
- pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`,
- it is used to give higher precedence to topologies that satisfy
- it. It''s a required field. Default value is 1 and 0 is not
- allowed.'
+ description: 'MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It''s a required field. Default value is 1 and 0 is not allowed.'
format: int32
type: integer
minDomains:
- description: "MinDomains indicates a minimum number of eligible
- domains. When the number of eligible domains with matching
- topology keys is less than minDomains, Pod Topology Spread
- treats \"global minimum\" as 0, and then the calculation of
- Skew is performed. And when the number of eligible domains
- with matching topology keys equals or greater than minDomains,
- this value has no effect on scheduling. As a result, when
- the number of eligible domains is less than minDomains, scheduler
- won't schedule more than maxSkew Pods to those domains. If
- value is nil, the constraint behaves as if MinDomains is equal
- to 1. Valid values are integers greater than 0. When value
- is not nil, WhenUnsatisfiable must be DoNotSchedule. \n For
- example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains
- is set to 5 and pods with the same labelSelector spread as
- 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P |
- The number of domains is less than 5(MinDomains), so \"global
- minimum\" is treated as 0. In this situation, new pod with
- the same labelSelector cannot be scheduled, because computed
- skew will be 3(3 - 0) if new Pod is scheduled to any of the
- three zones, it will violate MaxSkew. \n This is a beta field
- and requires the MinDomainsInPodTopologySpread feature gate
- to be enabled (enabled by default)."
+ description: "MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats \"global minimum\" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule. \n For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so \"global minimum\" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew. \n This is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default)."
format: int32
type: integer
nodeAffinityPolicy:
- description: "NodeAffinityPolicy indicates how we will treat
- Pod's nodeAffinity/nodeSelector when calculating pod topology
- spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector
- are included in the calculations. - Ignore: nodeAffinity/nodeSelector
- are ignored. All nodes are included in the calculations. \n
- If this value is nil, the behavior is equivalent to the Honor
- policy. This is a beta-level feature default enabled by the
- NodeInclusionPolicyInPodTopologySpread feature flag."
+ description: "NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations. \n If this value is nil, the behavior is equivalent to the Honor policy. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag."
type: string
nodeTaintsPolicy:
- description: "NodeTaintsPolicy indicates how we will treat node
- taints when calculating pod topology spread skew. Options
- are: - Honor: nodes without taints, along with tainted nodes
- for which the incoming pod has a toleration, are included.
- - Ignore: node taints are ignored. All nodes are included.
- \n If this value is nil, the behavior is equivalent to the
- Ignore policy. This is a beta-level feature default enabled
- by the NodeInclusionPolicyInPodTopologySpread feature flag."
+ description: "NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included. \n If this value is nil, the behavior is equivalent to the Ignore policy. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag."
type: string
topologyKey:
- description: TopologyKey is the key of node labels. Nodes that
- have a label with this key and identical values are considered
- to be in the same topology. We consider each <key, value>
- as a "bucket", and try to put balanced number of pods into
- each bucket. We define a domain as a particular instance of
- a topology. Also, we define an eligible domain as a domain
- whose nodes meet the requirements of nodeAffinityPolicy and
- nodeTaintsPolicy. e.g. If TopologyKey is "kubernetes.io/hostname",
- each Node is a domain of that topology. And, if TopologyKey
- is "topology.kubernetes.io/zone", each zone is a domain of
- that topology. It's a required field.
+ description: TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a "bucket", and try to put balanced number of pods into each bucket. We define a domain as a particular instance of a topology. Also, we define an eligible domain as a domain whose nodes meet the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. It's a required field.
type: string
whenUnsatisfiable:
- description: 'WhenUnsatisfiable indicates how to deal with a
- pod if it doesn''t satisfy the spread constraint. - DoNotSchedule
- (default) tells the scheduler not to schedule it. - ScheduleAnyway
- tells the scheduler to schedule the pod in any location, but
- giving higher precedence to topologies that would help reduce
- the skew. A constraint is considered "Unsatisfiable" for an
- incoming pod if and only if every possible node assignment
- for that pod would violate "MaxSkew" on some topology. For
- example, in a 3-zone cluster, MaxSkew is set to 1, and pods
- with the same labelSelector spread as 3/1/1: | zone1 | zone2
- | zone3 | | P P P | P | P | If WhenUnsatisfiable is
- set to DoNotSchedule, incoming pod can only be scheduled to
- zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on
- zone2(zone3) satisfies MaxSkew(1). In other words, the cluster
- can still be imbalanced, but scheduler won''t make it *more*
- imbalanced. It''s a required field.'
+ description: 'WhenUnsatisfiable indicates how to deal with a pod if it doesn''t satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won''t make it *more* imbalanced. It''s a required field.'
type: string
required:
- maxSkew
@@ -5042,17 +3154,13 @@ spec:
type: object
type: array
tracingConfig:
- description: TracingConfig configures tracing in Thanos. This is an
- experimental feature, it may change in any upcoming release in a
- breaking way.
+ description: TracingConfig configures tracing in Thanos. This is an experimental feature, it may change in any upcoming release in a breaking way.
properties:
key:
- description: The key of the secret to select from. Must be a
- valid secret key.
+ description: The key of the secret to select from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
description: Specify whether the Secret or its key must be defined
@@ -5062,101 +3170,68 @@ spec:
type: object
x-kubernetes-map-type: atomic
tracingConfigFile:
- description: TracingConfig specifies the path of the tracing configuration
- file. When used alongside with TracingConfig, TracingConfigFile
- takes precedence.
+ description: TracingConfig specifies the path of the tracing configuration file. When used alongside with TracingConfig, TracingConfigFile takes precedence.
type: string
version:
description: Version of Thanos to be deployed.
type: string
volumes:
- description: Volumes allows configuration of additional volumes on
- the output StatefulSet definition. Volumes specified will be appended
- to other volumes that are generated as a result of StorageSpec objects.
+ description: Volumes allows configuration of additional volumes on the output StatefulSet definition. Volumes specified will be appended to other volumes that are generated as a result of StorageSpec objects.
items:
- description: Volume represents a named volume in a pod that may
- be accessed by any container in the pod.
+ description: Volume represents a named volume in a pod that may be accessed by any container in the pod.
properties:
awsElasticBlockStore:
- description: 'awsElasticBlockStore represents an AWS Disk resource
- that is attached to a kubelet''s host machine and then exposed
- to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
+ description: 'awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet''s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
properties:
fsType:
- description: 'fsType is the filesystem type of the volume
- that you want to mount. Tip: Ensure that the filesystem
- type is supported by the host operating system. Examples:
- "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4"
- if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
- TODO: how do we prevent errors in the filesystem from
- compromising the machine'
+ description: 'fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine'
type: string
partition:
- description: 'partition is the partition in the volume that
- you want to mount. If omitted, the default is to mount
- by volume name. Examples: For volume /dev/sda1, you specify
- the partition as "1". Similarly, the volume partition
- for /dev/sda is "0" (or you can leave the property empty).'
+ description: 'partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).'
format: int32
type: integer
readOnly:
- description: 'readOnly value true will force the readOnly
- setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
+ description: 'readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
type: boolean
volumeID:
- description: 'volumeID is unique ID of the persistent disk
- resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
+ description: 'volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
type: string
required:
- volumeID
type: object
azureDisk:
- description: azureDisk represents an Azure Data Disk mount on
- the host and bind mount to the pod.
+ description: azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
properties:
cachingMode:
- description: 'cachingMode is the Host Caching mode: None,
- Read Only, Read Write.'
+ description: 'cachingMode is the Host Caching mode: None, Read Only, Read Write.'
type: string
diskName:
- description: diskName is the Name of the data disk in the
- blob storage
+ description: diskName is the Name of the data disk in the blob storage
type: string
diskURI:
- description: diskURI is the URI of data disk in the blob
- storage
+ description: diskURI is the URI of data disk in the blob storage
type: string
fsType:
- description: fsType is Filesystem type to mount. Must be
- a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4"
- if unspecified.
+ description: fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
type: string
kind:
- description: 'kind expected values are Shared: multiple
- blob disks per storage account Dedicated: single blob
- disk per storage account Managed: azure managed data
- disk (only in managed availability set). defaults to shared'
+ description: 'kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared'
type: string
readOnly:
- description: readOnly Defaults to false (read/write). ReadOnly
- here will force the ReadOnly setting in VolumeMounts.
+ description: readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
type: boolean
required:
- diskName
- diskURI
type: object
azureFile:
- description: azureFile represents an Azure File Service mount
- on the host and bind mount to the pod.
+ description: azureFile represents an Azure File Service mount on the host and bind mount to the pod.
properties:
readOnly:
- description: readOnly defaults to false (read/write). ReadOnly
- here will force the ReadOnly setting in VolumeMounts.
+ description: readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
type: boolean
secretName:
- description: secretName is the name of secret that contains
- Azure Storage Account Name and Key
+ description: secretName is the name of secret that contains Azure Storage Account Name and Key
type: string
shareName:
description: shareName is the azure share Name
@@ -5166,105 +3241,68 @@ spec:
- shareName
type: object
cephfs:
- description: cephFS represents a Ceph FS mount on the host that
- shares a pod's lifetime
+ description: cephFS represents a Ceph FS mount on the host that shares a pod's lifetime
properties:
monitors:
- description: 'monitors is Required: Monitors is a collection
- of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
+ description: 'monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
items:
type: string
type: array
path:
- description: 'path is Optional: Used as the mounted root,
- rather than the full Ceph tree, default is /'
+ description: 'path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /'
type: string
readOnly:
- description: 'readOnly is Optional: Defaults to false (read/write).
- ReadOnly here will force the ReadOnly setting in VolumeMounts.
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
+ description: 'readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
type: boolean
secretFile:
- description: 'secretFile is Optional: SecretFile is the
- path to key ring for User, default is /etc/ceph/user.secret
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
+ description: 'secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
type: string
secretRef:
- description: 'secretRef is Optional: SecretRef is reference
- to the authentication secret for User, default is empty.
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
+ description: 'secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
x-kubernetes-map-type: atomic
user:
- description: 'user is optional: User is the rados user name,
- default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
+ description: 'user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
type: string
required:
- monitors
type: object
cinder:
- description: 'cinder represents a cinder volume attached and
- mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
+ description: 'cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
properties:
fsType:
- description: 'fsType is the filesystem type to mount. Must
- be a filesystem type supported by the host operating system.
- Examples: "ext4", "xfs", "ntfs". Implicitly inferred to
- be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
+ description: 'fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
type: string
readOnly:
- description: 'readOnly defaults to false (read/write). ReadOnly
- here will force the ReadOnly setting in VolumeMounts.
- More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
+ description: 'readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
type: boolean
secretRef:
- description: 'secretRef is optional: points to a secret
- object containing parameters used to connect to OpenStack.'
+ description: 'secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
x-kubernetes-map-type: atomic
volumeID:
- description: 'volumeID used to identify the volume in cinder.
- More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
+ description: 'volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
type: string
required:
- volumeID
type: object
configMap:
- description: configMap represents a configMap that should populate
- this volume
+ description: configMap represents a configMap that should populate this volume
properties:
defaultMode:
- description: 'defaultMode is optional: mode bits used to
- set permissions on created files by default. Must be an
- octal value between 0000 and 0777 or a decimal value between
- 0 and 511. YAML accepts both octal and decimal values,
- JSON requires decimal values for mode bits. Defaults to
- 0644. Directories within the path are not affected by
- this setting. This might be in conflict with other options
- that affect the file mode, like fsGroup, and the result
- can be other mode bits set.'
+ description: 'defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
format: int32
type: integer
items:
- description: items if unspecified, each key-value pair in
- the Data field of the referenced ConfigMap will be projected
- into the volume as a file whose name is the key and content
- is the value. If specified, the listed keys will be projected
- into the specified paths, and unlisted keys will not be
- present. If a key is specified which is not present in
- the ConfigMap, the volume setup will error unless it is
- marked optional. Paths must be relative and may not contain
- the '..' path or start with '..'.
+ description: items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
items:
description: Maps a string key to a path within a volume.
properties:
@@ -5272,22 +3310,11 @@ spec:
description: key is the key to project.
type: string
mode:
- description: 'mode is Optional: mode bits used to
- set permissions on this file. Must be an octal value
- between 0000 and 0777 or a decimal value between
- 0 and 511. YAML accepts both octal and decimal values,
- JSON requires decimal values for mode bits. If not
- specified, the volume defaultMode will be used.
- This might be in conflict with other options that
- affect the file mode, like fsGroup, and the result
- can be other mode bits set.'
+ description: 'mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
format: int32
type: integer
path:
- description: path is the relative path of the file
- to map the key to. May not be an absolute path.
- May not contain the path element '..'. May not start
- with the string '..'.
+ description: path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
type: string
required:
- key
@@ -5295,135 +3322,84 @@ spec:
type: object
type: array
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: optional specify whether the ConfigMap or its
- keys must be defined
+ description: optional specify whether the ConfigMap or its keys must be defined
type: boolean
type: object
x-kubernetes-map-type: atomic
csi:
- description: csi (Container Storage Interface) represents ephemeral
- storage that is handled by certain external CSI drivers (Beta
- feature).
+ description: csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
properties:
driver:
- description: driver is the name of the CSI driver that handles
- this volume. Consult with your admin for the correct name
- as registered in the cluster.
+ description: driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.
type: string
fsType:
- description: fsType to mount. Ex. "ext4", "xfs", "ntfs".
- If not provided, the empty value is passed to the associated
- CSI driver which will determine the default filesystem
- to apply.
+ description: fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.
type: string
nodePublishSecretRef:
- description: nodePublishSecretRef is a reference to the
- secret object containing sensitive information to pass
- to the CSI driver to complete the CSI NodePublishVolume
- and NodeUnpublishVolume calls. This field is optional,
- and may be empty if no secret is required. If the secret
- object contains more than one secret, all secret references
- are passed.
+ description: nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
x-kubernetes-map-type: atomic
readOnly:
- description: readOnly specifies a read-only configuration
- for the volume. Defaults to false (read/write).
+ description: readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).
type: boolean
volumeAttributes:
additionalProperties:
type: string
- description: volumeAttributes stores driver-specific properties
- that are passed to the CSI driver. Consult your driver's
- documentation for supported values.
+ description: volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.
type: object
required:
- driver
type: object
downwardAPI:
- description: downwardAPI represents downward API about the pod
- that should populate this volume
+ description: downwardAPI represents downward API about the pod that should populate this volume
properties:
defaultMode:
- description: 'Optional: mode bits to use on created files
- by default. Must be a Optional: mode bits used to set
- permissions on created files by default. Must be an octal
- value between 0000 and 0777 or a decimal value between
- 0 and 511. YAML accepts both octal and decimal values,
- JSON requires decimal values for mode bits. Defaults to
- 0644. Directories within the path are not affected by
- this setting. This might be in conflict with other options
- that affect the file mode, like fsGroup, and the result
- can be other mode bits set.'
+ description: 'Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
format: int32
type: integer
items:
description: Items is a list of downward API volume file
items:
- description: DownwardAPIVolumeFile represents information
- to create the file containing the pod field
+ description: DownwardAPIVolumeFile represents information to create the file containing the pod field
properties:
fieldRef:
- description: 'Required: Selects a field of the pod:
- only annotations, labels, name and namespace are
- supported.'
+ description: 'Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.'
properties:
apiVersion:
- description: Version of the schema the FieldPath
- is written in terms of, defaults to "v1".
+ description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
type: string
fieldPath:
- description: Path of the field to select in the
- specified API version.
+ description: Path of the field to select in the specified API version.
type: string
required:
- fieldPath
type: object
x-kubernetes-map-type: atomic
mode:
- description: 'Optional: mode bits used to set permissions
- on this file, must be an octal value between 0000
- and 0777 or a decimal value between 0 and 511. YAML
- accepts both octal and decimal values, JSON requires
- decimal values for mode bits. If not specified,
- the volume defaultMode will be used. This might
- be in conflict with other options that affect the
- file mode, like fsGroup, and the result can be other
- mode bits set.'
+ description: 'Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
format: int32
type: integer
path:
- description: 'Required: Path is the relative path
- name of the file to be created. Must not be absolute
- or contain the ''..'' path. Must be utf-8 encoded.
- The first item of the relative path must not start
- with ''..'''
+ description: 'Required: Path is the relative path name of the file to be created. Must not be absolute or contain the ''..'' path. Must be utf-8 encoded. The first item of the relative path must not start with ''..'''
type: string
resourceFieldRef:
- description: 'Selects a resource of the container:
- only resources limits and requests (limits.cpu,
- limits.memory, requests.cpu and requests.memory)
- are currently supported.'
+ description: 'Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.'
properties:
containerName:
- description: 'Container name: required for volumes,
- optional for env vars'
+ description: 'Container name: required for volumes, optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format of the
- exposed resources, defaults to "1"
+ description: Specifies the output format of the exposed resources, defaults to "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
@@ -5439,114 +3415,47 @@ spec:
type: array
type: object
emptyDir:
- description: 'emptyDir represents a temporary directory that
- shares a pod''s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
+ description: 'emptyDir represents a temporary directory that shares a pod''s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
properties:
medium:
- description: 'medium represents what type of storage medium
- should back this directory. The default is "" which means
- to use the node''s default medium. Must be an empty string
- (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
+ description: 'medium represents what type of storage medium should back this directory. The default is "" which means to use the node''s default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
type: string
sizeLimit:
anyOf:
- type: integer
- type: string
- description: 'sizeLimit is the total amount of local storage
- required for this EmptyDir volume. The size limit is also
- applicable for memory medium. The maximum usage on memory
- medium EmptyDir would be the minimum value between the
- SizeLimit specified here and the sum of memory limits
- of all containers in a pod. The default is nil which means
- that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir'
+ description: 'sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir'
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
type: object
ephemeral:
- description: "ephemeral represents a volume that is handled
- by a cluster storage driver. The volume's lifecycle is tied
- to the pod that defines it - it will be created before the
- pod starts, and deleted when the pod is removed. \n Use this
- if: a) the volume is only needed while the pod runs, b) features
- of normal volumes like restoring from snapshot or capacity
- tracking are needed, c) the storage driver is specified through
- a storage class, and d) the storage driver supports dynamic
- volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource
- for more information on the connection between this volume
- type and PersistentVolumeClaim). \n Use PersistentVolumeClaim
- or one of the vendor-specific APIs for volumes that persist
- for longer than the lifecycle of an individual pod. \n Use
- CSI for light-weight local ephemeral volumes if the CSI driver
- is meant to be used that way - see the documentation of the
- driver for more information. \n A pod can use both types of
- ephemeral volumes and persistent volumes at the same time."
+ description: "ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. \n Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). \n Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. \n Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. \n A pod can use both types of ephemeral volumes and persistent volumes at the same time."
properties:
volumeClaimTemplate:
- description: "Will be used to create a stand-alone PVC to
- provision the volume. The pod in which this EphemeralVolumeSource
- is embedded will be the owner of the PVC, i.e. the PVC
- will be deleted together with the pod. The name of the
- PVC will be `<pod name>-<volume name>` where `<volume
- name>` is the name from the `PodSpec.Volumes` array entry.
- Pod validation will reject the pod if the concatenated
- name is not valid for a PVC (for example, too long). \n
- An existing PVC with that name that is not owned by the
- pod will *not* be used for the pod to avoid using an unrelated
- volume by mistake. Starting the pod is then blocked until
- the unrelated PVC is removed. If such a pre-created PVC
- is meant to be used by the pod, the PVC has to updated
- with an owner reference to the pod once the pod exists.
- Normally this should not be necessary, but it may be useful
- when manually reconstructing a broken cluster. \n This
- field is read-only and no changes will be made by Kubernetes
- to the PVC after it has been created. \n Required, must
- not be nil."
+ description: "Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `<pod name>-<volume name>` where `<volume name>` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). \n An existing PVC with that name that is not owned by the pod will *not* be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. \n This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. \n Required, must not be nil."
properties:
metadata:
- description: May contain labels and annotations that
- will be copied into the PVC when creating it. No other
- fields are allowed and will be rejected during validation.
+ description: May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.
type: object
spec:
- description: The specification for the PersistentVolumeClaim.
- The entire content is copied unchanged into the PVC
- that gets created from this template. The same fields
- as in a PersistentVolumeClaim are also valid here.
+ description: The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
properties:
accessModes:
- description: 'accessModes contains the desired access
- modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
+ description: 'accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
items:
type: string
type: array
dataSource:
- description: 'dataSource field can be used to specify
- either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
- * An existing PVC (PersistentVolumeClaim) If the
- provisioner or an external controller can support
- the specified data source, it will create a new
- volume based on the contents of the specified
- data source. When the AnyVolumeDataSource feature
- gate is enabled, dataSource contents will be copied
- to dataSourceRef, and dataSourceRef contents will
- be copied to dataSource when dataSourceRef.namespace
- is not specified. If the namespace is specified,
- then dataSourceRef will not be copied to dataSource.'
+ description: 'dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.'
properties:
apiGroup:
- description: APIGroup is the group for the resource
- being referenced. If APIGroup is not specified,
- the specified Kind must be in the core API
- group. For any other third-party types, APIGroup
- is required.
+ description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
type: string
kind:
- description: Kind is the type of resource being
- referenced
+ description: Kind is the type of resource being referenced
type: string
name:
- description: Name is the name of resource being
- referenced
+ description: Name is the name of resource being referenced
type: string
required:
- kind
@@ -5554,93 +3463,34 @@ spec:
type: object
x-kubernetes-map-type: atomic
dataSourceRef:
- description: 'dataSourceRef specifies the object
- from which to populate the volume with data, if
- a non-empty volume is desired. This may be any
- object from a non-empty API group (non core object)
- or a PersistentVolumeClaim object. When this field
- is specified, volume binding will only succeed
- if the type of the specified object matches some
- installed volume populator or dynamic provisioner.
- This field will replace the functionality of the
- dataSource field and as such if both fields are
- non-empty, they must have the same value. For
- backwards compatibility, when namespace isn''t
- specified in dataSourceRef, both fields (dataSource
- and dataSourceRef) will be set to the same value
- automatically if one of them is empty and the
- other is non-empty. When namespace is specified
- in dataSourceRef, dataSource isn''t set to the
- same value and must be empty. There are three
- important differences between dataSource and dataSourceRef:
- * While dataSource only allows two specific types
- of objects, dataSourceRef allows any non-core
- object, as well as PersistentVolumeClaim objects.
- * While dataSource ignores disallowed values (dropping
- them), dataSourceRef preserves all values, and
- generates an error if a disallowed value is specified.
- * While dataSource only allows local objects,
- dataSourceRef allows objects in any namespaces.
- (Beta) Using this field requires the AnyVolumeDataSource
- feature gate to be enabled. (Alpha) Using the
- namespace field of dataSourceRef requires the
- CrossNamespaceVolumeDataSource feature gate to
- be enabled.'
+ description: 'dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn''t specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn''t set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.'
properties:
apiGroup:
- description: APIGroup is the group for the resource
- being referenced. If APIGroup is not specified,
- the specified Kind must be in the core API
- group. For any other third-party types, APIGroup
- is required.
+ description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
type: string
kind:
- description: Kind is the type of resource being
- referenced
+ description: Kind is the type of resource being referenced
type: string
name:
- description: Name is the name of resource being
- referenced
+ description: Name is the name of resource being referenced
type: string
namespace:
- description: Namespace is the namespace of resource
- being referenced Note that when a namespace
- is specified, a gateway.networking.k8s.io/ReferenceGrant
- object is required in the referent namespace
- to allow that namespace's owner to accept
- the reference. See the ReferenceGrant documentation
- for details. (Alpha) This field requires the
- CrossNamespaceVolumeDataSource feature gate
- to be enabled.
+ description: Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
type: string
required:
- kind
- name
type: object
resources:
- description: 'resources represents the minimum resources
- the volume should have. If RecoverVolumeExpansionFailure
- feature is enabled users are allowed to specify
- resource requirements that are lower than previous
- value but must still be higher than capacity recorded
- in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
+ description: 'resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
properties:
claims:
- description: "Claims lists the names of resources,
- defined in spec.resourceClaims, that are used
- by this container. \n This is an alpha field
- and requires enabling the DynamicResourceAllocation
- feature gate. \n This field is immutable."
+ description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable."
items:
- description: ResourceClaim references one
- entry in PodSpec.ResourceClaims.
+ description: ResourceClaim references one entry in PodSpec.ResourceClaims.
properties:
name:
- description: Name must match the name
- of one entry in pod.spec.resourceClaims
- of the Pod where this field is used.
- It makes that resource available inside
- a container.
+ description: Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
type: string
required:
- name
@@ -5656,8 +3506,7 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount
- of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -5666,46 +3515,25 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Requests describes the minimum
- amount of compute resources required. If Requests
- is omitted for a container, it defaults to
- Limits if that is explicitly specified, otherwise
- to an implementation-defined value. More info:
- https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+ description: 'Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
selector:
- description: selector is a label query over volumes
- to consider for binding.
+ description: selector is a label query over volumes to consider for binding.
properties:
matchExpressions:
- description: matchExpressions is a list of label
- selector requirements. The requirements are
- ANDed.
+ description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement
- is a selector that contains values, a key,
- and an operator that relates the key and
- values.
+ description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
- description: key is the label key that
- the selector applies to.
+ description: key is the label key that the selector applies to.
type: string
operator:
- description: operator represents a key's
- relationship to a set of values. Valid
- operators are In, NotIn, Exists and
- DoesNotExist.
+ description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: values is an array of string
- values. If the operator is In or NotIn,
- the values array must be non-empty.
- If the operator is Exists or DoesNotExist,
- the values array must be empty. This
- array is replaced during a strategic
- merge patch.
+ description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
items:
type: string
type: array
@@ -5717,28 +3545,18 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: matchLabels is a map of {key,value}
- pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions,
- whose key field is "key", the operator is
- "In", and the values array contains only "value".
- The requirements are ANDed.
+ description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
storageClassName:
- description: 'storageClassName is the name of the
- StorageClass required by the claim. More info:
- https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
+ description: 'storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
type: string
volumeMode:
- description: volumeMode defines what type of volume
- is required by the claim. Value of Filesystem
- is implied when not included in claim spec.
+ description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
type: string
volumeName:
- description: volumeName is the binding reference
- to the PersistentVolume backing this claim.
+ description: volumeName is the binding reference to the PersistentVolume backing this claim.
type: string
type: object
required:
@@ -5746,74 +3564,51 @@ spec:
type: object
type: object
fc:
- description: fc represents a Fibre Channel resource that is
- attached to a kubelet's host machine and then exposed to the
- pod.
+ description: fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
properties:
fsType:
- description: 'fsType is the filesystem type to mount. Must
- be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4"
- if unspecified. TODO: how do we prevent errors in the
- filesystem from compromising the machine'
+ description: 'fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine'
type: string
lun:
description: 'lun is Optional: FC target lun number'
format: int32
type: integer
readOnly:
- description: 'readOnly is Optional: Defaults to false (read/write).
- ReadOnly here will force the ReadOnly setting in VolumeMounts.'
+ description: 'readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.'
type: boolean
targetWWNs:
- description: 'targetWWNs is Optional: FC target worldwide
- names (WWNs)'
+ description: 'targetWWNs is Optional: FC target worldwide names (WWNs)'
items:
type: string
type: array
wwids:
- description: 'wwids Optional: FC volume world wide identifiers
- (wwids) Either wwids or combination of targetWWNs and
- lun must be set, but not both simultaneously.'
+ description: 'wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.'
items:
type: string
type: array
type: object
flexVolume:
- description: flexVolume represents a generic volume resource
- that is provisioned/attached using an exec based plugin.
+ description: flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
properties:
driver:
- description: driver is the name of the driver to use for
- this volume.
+ description: driver is the name of the driver to use for this volume.
type: string
fsType:
- description: fsType is the filesystem type to mount. Must
- be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". The default filesystem depends
- on FlexVolume script.
+ description: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
type: string
options:
additionalProperties:
type: string
- description: 'options is Optional: this field holds extra
- command options if any.'
+ description: 'options is Optional: this field holds extra command options if any.'
type: object
readOnly:
- description: 'readOnly is Optional: defaults to false (read/write).
- ReadOnly here will force the ReadOnly setting in VolumeMounts.'
+ description: 'readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.'
type: boolean
secretRef:
- description: 'secretRef is Optional: secretRef is reference
- to the secret object containing sensitive information
- to pass to the plugin scripts. This may be empty if no
- secret object is specified. If the secret object contains
- more than one secret, all secrets are passed to the plugin
- scripts.'
+ description: 'secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
x-kubernetes-map-type: atomic
@@ -5821,184 +3616,120 @@ spec:
- driver
type: object
flocker:
- description: flocker represents a Flocker volume attached to
- a kubelet's host machine. This depends on the Flocker control
- service being running
+ description: flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
properties:
datasetName:
- description: datasetName is Name of the dataset stored as
- metadata -> name on the dataset for Flocker should be
- considered as deprecated
+ description: datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
type: string
datasetUUID:
- description: datasetUUID is the UUID of the dataset. This
- is unique identifier of a Flocker dataset
+ description: datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
type: string
type: object
gcePersistentDisk:
- description: 'gcePersistentDisk represents a GCE Disk resource
- that is attached to a kubelet''s host machine and then exposed
- to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
+ description: 'gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet''s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
properties:
fsType:
- description: 'fsType is filesystem type of the volume that
- you want to mount. Tip: Ensure that the filesystem type
- is supported by the host operating system. Examples: "ext4",
- "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
- TODO: how do we prevent errors in the filesystem from
- compromising the machine'
+ description: 'fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine'
type: string
partition:
- description: 'partition is the partition in the volume that
- you want to mount. If omitted, the default is to mount
- by volume name. Examples: For volume /dev/sda1, you specify
- the partition as "1". Similarly, the volume partition
- for /dev/sda is "0" (or you can leave the property empty).
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
+ description: 'partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
format: int32
type: integer
pdName:
- description: 'pdName is unique name of the PD resource in
- GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
+ description: 'pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
type: string
readOnly:
- description: 'readOnly here will force the ReadOnly setting
- in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
+ description: 'readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
type: boolean
required:
- pdName
type: object
gitRepo:
- description: 'gitRepo represents a git repository at a particular
- revision. DEPRECATED: GitRepo is deprecated. To provision
- a container with a git repo, mount an EmptyDir into an InitContainer
- that clones the repo using git, then mount the EmptyDir into
- the Pod''s container.'
+ description: 'gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod''s container.'
properties:
directory:
- description: directory is the target directory name. Must
- not contain or start with '..'. If '.' is supplied, the
- volume directory will be the git repository. Otherwise,
- if specified, the volume will contain the git repository
- in the subdirectory with the given name.
+ description: directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.
type: string
repository:
description: repository is the URL
type: string
revision:
- description: revision is the commit hash for the specified
- revision.
+ description: revision is the commit hash for the specified revision.
type: string
required:
- repository
type: object
glusterfs:
- description: 'glusterfs represents a Glusterfs mount on the
- host that shares a pod''s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md'
+ description: 'glusterfs represents a Glusterfs mount on the host that shares a pod''s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md'
properties:
endpoints:
- description: 'endpoints is the endpoint name that details
- Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
+ description: 'endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: string
path:
- description: 'path is the Glusterfs volume path. More info:
- https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
+ description: 'path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: string
readOnly:
- description: 'readOnly here will force the Glusterfs volume
- to be mounted with read-only permissions. Defaults to
- false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
+ description: 'readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: boolean
required:
- endpoints
- path
type: object
hostPath:
- description: 'hostPath represents a pre-existing file or directory
- on the host machine that is directly exposed to the container.
- This is generally used for system agents or other privileged
- things that are allowed to see the host machine. Most containers
- will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
- --- TODO(jonesdl) We need to restrict who can use host directory
- mounts and who can/can not mount host directories as read/write.'
+ description: 'hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.'
properties:
path:
- description: 'path of the directory on the host. If the
- path is a symlink, it will follow the link to the real
- path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
+ description: 'path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
type: string
type:
- description: 'type for HostPath Volume Defaults to "" More
- info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
+ description: 'type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
type: string
required:
- path
type: object
iscsi:
- description: 'iscsi represents an ISCSI Disk resource that is
- attached to a kubelet''s host machine and then exposed to
- the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md'
+ description: 'iscsi represents an ISCSI Disk resource that is attached to a kubelet''s host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md'
properties:
chapAuthDiscovery:
- description: chapAuthDiscovery defines whether support iSCSI
- Discovery CHAP authentication
+ description: chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
type: boolean
chapAuthSession:
- description: chapAuthSession defines whether support iSCSI
- Session CHAP authentication
+ description: chapAuthSession defines whether support iSCSI Session CHAP authentication
type: boolean
fsType:
- description: 'fsType is the filesystem type of the volume
- that you want to mount. Tip: Ensure that the filesystem
- type is supported by the host operating system. Examples:
- "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4"
- if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
- TODO: how do we prevent errors in the filesystem from
- compromising the machine'
+ description: 'fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine'
type: string
initiatorName:
- description: initiatorName is the custom iSCSI Initiator
- Name. If initiatorName is specified with iscsiInterface
- simultaneously, new iSCSI interface <target portal>:<volume
- name> will be created for the connection.
+ description: initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.
type: string
iqn:
description: iqn is the target iSCSI Qualified Name.
type: string
iscsiInterface:
- description: iscsiInterface is the interface Name that uses
- an iSCSI transport. Defaults to 'default' (tcp).
+ description: iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
type: string
lun:
description: lun represents iSCSI Target Lun number.
format: int32
type: integer
portals:
- description: portals is the iSCSI Target Portal List. The
- portal is either an IP or ip_addr:port if the port is
- other than default (typically TCP ports 860 and 3260).
+ description: portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
items:
type: string
type: array
readOnly:
- description: readOnly here will force the ReadOnly setting
- in VolumeMounts. Defaults to false.
+ description: readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
type: boolean
secretRef:
- description: secretRef is the CHAP Secret for iSCSI target
- and initiator authentication
+ description: secretRef is the CHAP Secret for iSCSI target and initiator authentication
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
x-kubernetes-map-type: atomic
targetPortal:
- description: targetPortal is iSCSI Target Portal. The Portal
- is either an IP or ip_addr:port if the port is other than
- default (typically TCP ports 860 and 3260).
+ description: targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
type: string
required:
- iqn
@@ -6006,77 +3737,56 @@ spec:
- targetPortal
type: object
name:
- description: 'name of the volume. Must be a DNS_LABEL and unique
- within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+ description: 'name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
type: string
nfs:
- description: 'nfs represents an NFS mount on the host that shares
- a pod''s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
+ description: 'nfs represents an NFS mount on the host that shares a pod''s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
properties:
path:
- description: 'path that is exported by the NFS server. More
- info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
+ description: 'path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: string
readOnly:
- description: 'readOnly here will force the NFS export to
- be mounted with read-only permissions. Defaults to false.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
+ description: 'readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: boolean
server:
- description: 'server is the hostname or IP address of the
- NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
+ description: 'server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: string
required:
- path
- server
type: object
persistentVolumeClaim:
- description: 'persistentVolumeClaimVolumeSource represents a
- reference to a PersistentVolumeClaim in the same namespace.
- More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
+ description: 'persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
properties:
claimName:
- description: 'claimName is the name of a PersistentVolumeClaim
- in the same namespace as the pod using this volume. More
- info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
+ description: 'claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
type: string
readOnly:
- description: readOnly Will force the ReadOnly setting in
- VolumeMounts. Default false.
+ description: readOnly Will force the ReadOnly setting in VolumeMounts. Default false.
type: boolean
required:
- claimName
type: object
photonPersistentDisk:
- description: photonPersistentDisk represents a PhotonController
- persistent disk attached and mounted on kubelets host machine
+ description: photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
properties:
fsType:
- description: fsType is the filesystem type to mount. Must
- be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4"
- if unspecified.
+ description: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
type: string
pdID:
- description: pdID is the ID that identifies Photon Controller
- persistent disk
+ description: pdID is the ID that identifies Photon Controller persistent disk
type: string
required:
- pdID
type: object
portworxVolume:
- description: portworxVolume represents a portworx volume attached
- and mounted on kubelets host machine
+ description: portworxVolume represents a portworx volume attached and mounted on kubelets host machine
properties:
fsType:
- description: fSType represents the filesystem type to mount
- Must be a filesystem type supported by the host operating
- system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4"
- if unspecified.
+ description: fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
type: string
readOnly:
- description: readOnly defaults to false (read/write). ReadOnly
- here will force the ReadOnly setting in VolumeMounts.
+ description: readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
type: boolean
volumeID:
description: volumeID uniquely identifies a Portworx volume
@@ -6085,69 +3795,34 @@ spec:
- volumeID
type: object
projected:
- description: projected items for all in one resources secrets,
- configmaps, and downward API
+ description: projected items for all in one resources secrets, configmaps, and downward API
properties:
defaultMode:
- description: defaultMode are the mode bits used to set permissions
- on created files by default. Must be an octal value between
- 0000 and 0777 or a decimal value between 0 and 511. YAML
- accepts both octal and decimal values, JSON requires decimal
- values for mode bits. Directories within the path are
- not affected by this setting. This might be in conflict
- with other options that affect the file mode, like fsGroup,
- and the result can be other mode bits set.
+ description: defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
format: int32
type: integer
sources:
description: sources is the list of volume projections
items:
- description: Projection that may be projected along with
- other supported volume types
+ description: Projection that may be projected along with other supported volume types
properties:
configMap:
- description: configMap information about the configMap
- data to project
+ description: configMap information about the configMap data to project
properties:
items:
- description: items if unspecified, each key-value
- pair in the Data field of the referenced ConfigMap
- will be projected into the volume as a file
- whose name is the key and content is the value.
- If specified, the listed keys will be projected
- into the specified paths, and unlisted keys
- will not be present. If a key is specified which
- is not present in the ConfigMap, the volume
- setup will error unless it is marked optional.
- Paths must be relative and may not contain the
- '..' path or start with '..'.
+ description: items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
items:
- description: Maps a string key to a path within
- a volume.
+ description: Maps a string key to a path within a volume.
properties:
key:
description: key is the key to project.
type: string
mode:
- description: 'mode is Optional: mode bits
- used to set permissions on this file.
- Must be an octal value between 0000 and
- 0777 or a decimal value between 0 and
- 511. YAML accepts both octal and decimal
- values, JSON requires decimal values for
- mode bits. If not specified, the volume
- defaultMode will be used. This might be
- in conflict with other options that affect
- the file mode, like fsGroup, and the result
- can be other mode bits set.'
+ description: 'mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
format: int32
type: integer
path:
- description: path is the relative path of
- the file to map the key to. May not be
- an absolute path. May not contain the
- path element '..'. May not start with
- the string '..'.
+ description: path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
type: string
required:
- key
@@ -6155,91 +3830,56 @@ spec:
type: object
type: array
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: optional specify whether the ConfigMap
- or its keys must be defined
+ description: optional specify whether the ConfigMap or its keys must be defined
type: boolean
type: object
x-kubernetes-map-type: atomic
downwardAPI:
- description: downwardAPI information about the downwardAPI
- data to project
+ description: downwardAPI information about the downwardAPI data to project
properties:
items:
- description: Items is a list of DownwardAPIVolume
- file
+ description: Items is a list of DownwardAPIVolume file
items:
- description: DownwardAPIVolumeFile represents
- information to create the file containing
- the pod field
+ description: DownwardAPIVolumeFile represents information to create the file containing the pod field
properties:
fieldRef:
- description: 'Required: Selects a field
- of the pod: only annotations, labels,
- name and namespace are supported.'
+ description: 'Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.'
properties:
apiVersion:
- description: Version of the schema the
- FieldPath is written in terms of,
- defaults to "v1".
+ description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
type: string
fieldPath:
- description: Path of the field to select
- in the specified API version.
+ description: Path of the field to select in the specified API version.
type: string
required:
- fieldPath
type: object
x-kubernetes-map-type: atomic
mode:
- description: 'Optional: mode bits used to
- set permissions on this file, must be
- an octal value between 0000 and 0777 or
- a decimal value between 0 and 511. YAML
- accepts both octal and decimal values,
- JSON requires decimal values for mode
- bits. If not specified, the volume defaultMode
- will be used. This might be in conflict
- with other options that affect the file
- mode, like fsGroup, and the result can
- be other mode bits set.'
+ description: 'Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
format: int32
type: integer
path:
- description: 'Required: Path is the relative
- path name of the file to be created. Must
- not be absolute or contain the ''..''
- path. Must be utf-8 encoded. The first
- item of the relative path must not start
- with ''..'''
+ description: 'Required: Path is the relative path name of the file to be created. Must not be absolute or contain the ''..'' path. Must be utf-8 encoded. The first item of the relative path must not start with ''..'''
type: string
resourceFieldRef:
- description: 'Selects a resource of the
- container: only resources limits and requests
- (limits.cpu, limits.memory, requests.cpu
- and requests.memory) are currently supported.'
+ description: 'Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.'
properties:
containerName:
- description: 'Container name: required
- for volumes, optional for env vars'
+ description: 'Container name: required for volumes, optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format
- of the exposed resources, defaults
- to "1"
+ description: Specifies the output format of the exposed resources, defaults to "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
- description: 'Required: resource to
- select'
+ description: 'Required: resource to select'
type: string
required:
- resource
@@ -6251,48 +3891,22 @@ spec:
type: array
type: object
secret:
- description: secret information about the secret data
- to project
+ description: secret information about the secret data to project
properties:
items:
- description: items if unspecified, each key-value
- pair in the Data field of the referenced Secret
- will be projected into the volume as a file
- whose name is the key and content is the value.
- If specified, the listed keys will be projected
- into the specified paths, and unlisted keys
- will not be present. If a key is specified which
- is not present in the Secret, the volume setup
- will error unless it is marked optional. Paths
- must be relative and may not contain the '..'
- path or start with '..'.
+ description: items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
items:
- description: Maps a string key to a path within
- a volume.
+ description: Maps a string key to a path within a volume.
properties:
key:
description: key is the key to project.
type: string
mode:
- description: 'mode is Optional: mode bits
- used to set permissions on this file.
- Must be an octal value between 0000 and
- 0777 or a decimal value between 0 and
- 511. YAML accepts both octal and decimal
- values, JSON requires decimal values for
- mode bits. If not specified, the volume
- defaultMode will be used. This might be
- in conflict with other options that affect
- the file mode, like fsGroup, and the result
- can be other mode bits set.'
+ description: 'mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
format: int32
type: integer
path:
- description: path is the relative path of
- the file to map the key to. May not be
- an absolute path. May not contain the
- path element '..'. May not start with
- the string '..'.
+ description: path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
type: string
required:
- key
@@ -6300,45 +3914,25 @@ spec:
type: object
type: array
name:
- description: 'Name of the referent. More info:
- https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind,
- uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: optional field specify whether the
- Secret or its key must be defined
+ description: optional field specify whether the Secret or its key must be defined
type: boolean
type: object
x-kubernetes-map-type: atomic
serviceAccountToken:
- description: serviceAccountToken is information about
- the serviceAccountToken data to project
+ description: serviceAccountToken is information about the serviceAccountToken data to project
properties:
audience:
- description: audience is the intended audience
- of the token. A recipient of a token must identify
- itself with an identifier specified in the audience
- of the token, and otherwise should reject the
- token. The audience defaults to the identifier
- of the apiserver.
+ description: audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.
type: string
expirationSeconds:
- description: expirationSeconds is the requested
- duration of validity of the service account
- token. As the token approaches expiration, the
- kubelet volume plugin will proactively rotate
- the service account token. The kubelet will
- start trying to rotate the token if the token
- is older than 80 percent of its time to live
- or if the token is older than 24 hours.Defaults
- to 1 hour and must be at least 10 minutes.
+ description: expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.
format: int64
type: integer
path:
- description: path is the path relative to the
- mount point of the file to project the token
- into.
+ description: path is the path relative to the mount point of the file to project the token into.
type: string
required:
- path
@@ -6347,148 +3941,105 @@ spec:
type: array
type: object
quobyte:
- description: quobyte represents a Quobyte mount on the host
- that shares a pod's lifetime
+ description: quobyte represents a Quobyte mount on the host that shares a pod's lifetime
properties:
group:
- description: group to map volume access to Default is no
- group
+ description: group to map volume access to Default is no group
type: string
readOnly:
- description: readOnly here will force the Quobyte volume
- to be mounted with read-only permissions. Defaults to
- false.
+ description: readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
type: boolean
registry:
- description: registry represents a single or multiple Quobyte
- Registry services specified as a string as host:port pair
- (multiple entries are separated with commas) which acts
- as the central registry for volumes
+ description: registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes
type: string
tenant:
- description: tenant owning the given Quobyte volume in the
- Backend Used with dynamically provisioned Quobyte volumes,
- value is set by the plugin
+ description: tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
type: string
user:
- description: user to map volume access to Defaults to serivceaccount
- user
+ description: user to map volume access to Defaults to serivceaccount user
type: string
volume:
- description: volume is a string that references an already
- created Quobyte volume by name.
+ description: volume is a string that references an already created Quobyte volume by name.
type: string
required:
- registry
- volume
type: object
rbd:
- description: 'rbd represents a Rados Block Device mount on the
- host that shares a pod''s lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md'
+ description: 'rbd represents a Rados Block Device mount on the host that shares a pod''s lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md'
properties:
fsType:
- description: 'fsType is the filesystem type of the volume
- that you want to mount. Tip: Ensure that the filesystem
- type is supported by the host operating system. Examples:
- "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4"
- if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd
- TODO: how do we prevent errors in the filesystem from
- compromising the machine'
+ description: 'fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine'
type: string
image:
- description: 'image is the rados image name. More info:
- https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
keyring:
- description: 'keyring is the path to key ring for RBDUser.
- Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
monitors:
- description: 'monitors is a collection of Ceph monitors.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
items:
type: string
type: array
pool:
- description: 'pool is the rados pool name. Default is rbd.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
readOnly:
- description: 'readOnly here will force the ReadOnly setting
- in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: boolean
secretRef:
- description: 'secretRef is name of the authentication secret
- for RBDUser. If provided overrides keyring. Default is
- nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
x-kubernetes-map-type: atomic
user:
- description: 'user is the rados user name. Default is admin.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
required:
- image
- monitors
type: object
scaleIO:
- description: scaleIO represents a ScaleIO persistent volume
- attached and mounted on Kubernetes nodes.
+ description: scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
properties:
fsType:
- description: fsType is the filesystem type to mount. Must
- be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Default is "xfs".
+ description: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".
type: string
gateway:
- description: gateway is the host address of the ScaleIO
- API Gateway.
+ description: gateway is the host address of the ScaleIO API Gateway.
type: string
protectionDomain:
- description: protectionDomain is the name of the ScaleIO
- Protection Domain for the configured storage.
+ description: protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
type: string
readOnly:
- description: readOnly Defaults to false (read/write). ReadOnly
- here will force the ReadOnly setting in VolumeMounts.
+ description: readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
type: boolean
secretRef:
- description: secretRef references to the secret for ScaleIO
- user and other sensitive information. If this is not provided,
- Login operation will fail.
+ description: secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
x-kubernetes-map-type: atomic
sslEnabled:
- description: sslEnabled Flag enable/disable SSL communication
- with Gateway, default false
+ description: sslEnabled Flag enable/disable SSL communication with Gateway, default false
type: boolean
storageMode:
- description: storageMode indicates whether the storage for
- a volume should be ThickProvisioned or ThinProvisioned.
- Default is ThinProvisioned.
+ description: storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
type: string
storagePool:
- description: storagePool is the ScaleIO Storage Pool associated
- with the protection domain.
+ description: storagePool is the ScaleIO Storage Pool associated with the protection domain.
type: string
system:
- description: system is the name of the storage system as
- configured in ScaleIO.
+ description: system is the name of the storage system as configured in ScaleIO.
type: string
volumeName:
- description: volumeName is the name of a volume already
- created in the ScaleIO system that is associated with
- this volume source.
+ description: volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.
type: string
required:
- gateway
@@ -6496,31 +4047,14 @@ spec:
- system
type: object
secret:
- description: 'secret represents a secret that should populate
- this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
+ description: 'secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
properties:
defaultMode:
- description: 'defaultMode is Optional: mode bits used to
- set permissions on created files by default. Must be an
- octal value between 0000 and 0777 or a decimal value between
- 0 and 511. YAML accepts both octal and decimal values,
- JSON requires decimal values for mode bits. Defaults to
- 0644. Directories within the path are not affected by
- this setting. This might be in conflict with other options
- that affect the file mode, like fsGroup, and the result
- can be other mode bits set.'
+ description: 'defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
format: int32
type: integer
items:
- description: items If unspecified, each key-value pair in
- the Data field of the referenced Secret will be projected
- into the volume as a file whose name is the key and content
- is the value. If specified, the listed keys will be projected
- into the specified paths, and unlisted keys will not be
- present. If a key is specified which is not present in
- the Secret, the volume setup will error unless it is marked
- optional. Paths must be relative and may not contain the
- '..' path or start with '..'.
+ description: items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
items:
description: Maps a string key to a path within a volume.
properties:
@@ -6528,22 +4062,11 @@ spec:
description: key is the key to project.
type: string
mode:
- description: 'mode is Optional: mode bits used to
- set permissions on this file. Must be an octal value
- between 0000 and 0777 or a decimal value between
- 0 and 511. YAML accepts both octal and decimal values,
- JSON requires decimal values for mode bits. If not
- specified, the volume defaultMode will be used.
- This might be in conflict with other options that
- affect the file mode, like fsGroup, and the result
- can be other mode bits set.'
+ description: 'mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.'
format: int32
type: integer
path:
- description: path is the relative path of the file
- to map the key to. May not be an absolute path.
- May not contain the path element '..'. May not start
- with the string '..'.
+ description: path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
type: string
required:
- key
@@ -6551,76 +4074,50 @@ spec:
type: object
type: array
optional:
- description: optional field specify whether the Secret or
- its keys must be defined
+ description: optional field specify whether the Secret or its keys must be defined
type: boolean
secretName:
- description: 'secretName is the name of the secret in the
- pod''s namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
+ description: 'secretName is the name of the secret in the pod''s namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
type: string
type: object
storageos:
- description: storageOS represents a StorageOS volume attached
- and mounted on Kubernetes nodes.
+ description: storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
properties:
fsType:
- description: fsType is the filesystem type to mount. Must
- be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4"
- if unspecified.
+ description: fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
type: string
readOnly:
- description: readOnly defaults to false (read/write). ReadOnly
- here will force the ReadOnly setting in VolumeMounts.
+ description: readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
type: boolean
secretRef:
- description: secretRef specifies the secret to use for obtaining
- the StorageOS API credentials. If not specified, default
- values will be attempted.
+ description: secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
x-kubernetes-map-type: atomic
volumeName:
- description: volumeName is the human-readable name of the
- StorageOS volume. Volume names are only unique within
- a namespace.
+ description: volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
type: string
volumeNamespace:
- description: volumeNamespace specifies the scope of the
- volume within StorageOS. If no namespace is specified
- then the Pod's namespace will be used. This allows the
- Kubernetes name scoping to be mirrored within StorageOS
- for tighter integration. Set VolumeName to any name to
- override the default behaviour. Set to "default" if you
- are not using namespaces within StorageOS. Namespaces
- that do not pre-exist within StorageOS will be created.
+ description: volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.
type: string
type: object
vsphereVolume:
- description: vsphereVolume represents a vSphere volume attached
- and mounted on kubelets host machine
+ description: vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
properties:
fsType:
- description: fsType is filesystem type to mount. Must be
- a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4"
- if unspecified.
+ description: fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
type: string
storagePolicyID:
- description: storagePolicyID is the storage Policy Based
- Management (SPBM) profile ID associated with the StoragePolicyName.
+ description: storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
type: string
storagePolicyName:
- description: storagePolicyName is the storage Policy Based
- Management (SPBM) profile name.
+ description: storagePolicyName is the storage Policy Based Management (SPBM) profile name.
type: string
volumePath:
- description: volumePath is the path that identifies vSphere
- volume vmdk
+ description: volumePath is the path that identifies vSphere volume vmdk
type: string
required:
- volumePath
@@ -6631,32 +4128,25 @@ spec:
type: array
type: object
status:
- description: 'Most recent observed status of the ThanosRuler cluster.
- Read-only. Not included when requesting from the apiserver, only from
- the ThanosRuler Operator API itself. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status'
+ description: 'Most recent observed status of the ThanosRuler cluster. Read-only. Not included when requesting from the apiserver, only from the ThanosRuler Operator API itself. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status'
properties:
availableReplicas:
- description: Total number of available pods (ready for at least minReadySeconds)
- targeted by this ThanosRuler deployment.
+ description: Total number of available pods (ready for at least minReadySeconds) targeted by this ThanosRuler deployment.
format: int32
type: integer
paused:
- description: Represents whether any actions on the underlying managed
- objects are being performed. Only delete actions will be performed.
+ description: Represents whether any actions on the underlying managed objects are being performed. Only delete actions will be performed.
type: boolean
replicas:
- description: Total number of non-terminated pods targeted by this
- ThanosRuler deployment (their labels match the selector).
+ description: Total number of non-terminated pods targeted by this ThanosRuler deployment (their labels match the selector).
format: int32
type: integer
unavailableReplicas:
- description: Total number of unavailable pods targeted by this ThanosRuler
- deployment.
+ description: Total number of unavailable pods targeted by this ThanosRuler deployment.
format: int32
type: integer
updatedReplicas:
- description: Total number of non-terminated pods targeted by this
- ThanosRuler deployment that have the desired version spec.
+ description: Total number of non-terminated pods targeted by this ThanosRuler deployment that have the desired version spec.
format: int32
type: integer
required:
diff --git a/scripts/go.mod b/scripts/go.mod
index b895eee52dde5d910c738565dee076f31f86d447..0c2fac9f7fc1d037bc01530152253ee584727cb1 100644
--- a/scripts/go.mod
+++ b/scripts/go.mod
@@ -4,7 +4,7 @@ go 1.18
require (
github.com/armosec/kubescape v1.0.139
- github.com/brancz/gojsontoyaml v0.0.0-20200602132005-3697ded27e8c
+ github.com/brancz/gojsontoyaml v0.1.0
github.com/bwplotka/mdox v0.9.1-0.20220718065926-6a6aac7d5d30
github.com/google/go-jsonnet v0.19.1
github.com/jsonnet-bundler/jsonnet-bundler v0.5.1
diff --git a/scripts/go.sum b/scripts/go.sum
index 07e065554ed4f291a7ce4e6abb5f7da9cb345a1b..4c51b49dde59c86fbfc8aeaf6a3c9e303b3952ac 100644
--- a/scripts/go.sum
+++ b/scripts/go.sum
@@ -250,8 +250,8 @@ github.com/bketelsen/crypt v0.0.4/go.mod h1:aI6NrJ0pMGgvZKL1iVgXLnfIFJtfV+bKCoqO
github.com/blang/semver v3.5.1+incompatible/go.mod h1:kRBLl5iJ+tD4TcOOxsy/0fnwebNt5EWlYSAyrTnjyyk=
github.com/boombuler/barcode v1.0.0/go.mod h1:paBWMcWSl3LHKBqUq+rly7CNSldXjb2rDl3JlRe0mD8=
github.com/bradfitz/go-smtpd v0.0.0-20170404230938-deb6d6237625/go.mod h1:HYsPBTaaSFSlLx/70C2HPIMNZpVV8+vt/A+FMnYP11g=
-github.com/brancz/gojsontoyaml v0.0.0-20200602132005-3697ded27e8c h1:hb6WqfcKQZlNx/vahy51SaIvKnoXD5609Nm0PC4msEM=
-github.com/brancz/gojsontoyaml v0.0.0-20200602132005-3697ded27e8c/go.mod h1:+00lOjYXPgMfxHVPvg9GDtc3BX5Xh5aFpB4gMB8gfMo=
+github.com/brancz/gojsontoyaml v0.1.0 h1:SdzR3+BCVOqaI42nFGTeaB7/2DgDM4fhuvRLqxatA8M=
+github.com/brancz/gojsontoyaml v0.1.0/go.mod h1:+ycZY94+V11XZBUaDEsbLr3hPNS/ZPrDVKKNUg3Sgvg=
github.com/briandowns/spinner v1.18.0 h1:SJs0maNOs4FqhBwiJ3Gr7Z1D39/rukIVGQvpNZVHVcM=
github.com/briandowns/spinner v1.18.0/go.mod h1:QOuQk7x+EaDASo80FEXwlwiA+j/PPIcX3FScO+3/ZPQ=
github.com/buger/jsonparser v0.0.0-20181115193947-bf1c66bbce23/go.mod h1:bbYlZJ7hK1yFx9hf58LP0zeX7UjIGs20ufpu3evjr+s=