diff --git a/manifests/grafana-dashboardDefinitions.yaml b/manifests/grafana-dashboardDefinitions.yaml
index 757147e9e795abd993d523e0f02333541285d1d0..9f02e45210f898390f2980e8f30d492432f6da90 100644
--- a/manifests/grafana-dashboardDefinitions.yaml
+++ b/manifests/grafana-dashboardDefinitions.yaml
@@ -1351,6 +1351,7 @@ items:
"threshold": 0
},
"datasource": "$datasource",
+ "description": "",
"fontSize": "80%",
"format": "Bps",
"gridPos": {
@@ -1396,6 +1397,7 @@ items:
"threshold": 0
},
"datasource": "$datasource",
+ "description": "",
"fontSize": "80%",
"format": "Bps",
"gridPos": {
@@ -1779,6 +1781,7 @@ items:
"threshold": 0
},
"datasource": "$datasource",
+ "description": "",
"fontSize": "80%",
"format": "Bps",
"gridPos": {
@@ -1824,6 +1827,7 @@ items:
"threshold": 0
},
"datasource": "$datasource",
+ "description": "",
"fontSize": "80%",
"format": "Bps",
"gridPos": {
@@ -18891,6 +18895,7 @@ items:
"threshold": 0
},
"datasource": "$datasource",
+ "description": "",
"fontSize": "80%",
"format": "Bps",
"gridPos": {
@@ -18936,6 +18941,7 @@ items:
"threshold": 0
},
"datasource": "$datasource",
+ "description": "",
"fontSize": "80%",
"format": "Bps",
"gridPos": {
@@ -19319,6 +19325,7 @@ items:
"threshold": 0
},
"datasource": "$datasource",
+ "description": "",
"fontSize": "80%",
"format": "Bps",
"gridPos": {
@@ -19364,6 +19371,7 @@ items:
"threshold": 0
},
"datasource": "$datasource",
+ "description": "",
"fontSize": "80%",
"format": "Bps",
"gridPos": {
@@ -31604,6 +31612,7 @@ items:
"threshold": 0
},
"datasource": "$datasource",
+ "description": "",
"fontSize": "80%",
"format": "Bps",
"gridPos": {
@@ -31649,6 +31658,7 @@ items:
"threshold": 0
},
"datasource": "$datasource",
+ "description": "",
"fontSize": "80%",
"format": "Bps",
"gridPos": {
@@ -31705,6 +31715,7 @@ items:
"threshold": 0
},
"datasource": "$datasource",
+ "description": "",
"fontSize": "80%",
"format": "Bps",
"gridPos": {
@@ -31750,6 +31761,7 @@ items:
"threshold": 0
},
"datasource": "$datasource",
+ "description": "",
"fontSize": "80%",
"format": "Bps",
"gridPos": {
diff --git a/manifests/setup/prometheus-operator-0alertmanagerCustomResourceDefinition.yaml b/manifests/setup/prometheus-operator-0alertmanagerCustomResourceDefinition.yaml
index 17dfb1604c391e63139184b0b8aba41a8a636328..ed4895807d4cf8aefb927e2e1b9ed03bddd64e2d 100644
--- a/manifests/setup/prometheus-operator-0alertmanagerCustomResourceDefinition.yaml
+++ b/manifests/setup/prometheus-operator-0alertmanagerCustomResourceDefinition.yaml
@@ -1,16 +1,22 @@
apiVersion: apiextensions.k8s.io/v1beta1
kind: CustomResourceDefinition
metadata:
+ annotations:
+ controller-gen.kubebuilder.io/version: v0.2.4
creationTimestamp: null
name: alertmanagers.monitoring.coreos.com
spec:
group: monitoring.coreos.com
names:
kind: Alertmanager
+ listKind: AlertmanagerList
plural: alertmanagers
+ singular: alertmanager
+ preserveUnknownFields: false
scope: Namespaced
validation:
openAPIV3Schema:
+ description: Alertmanager describes an Alertmanager cluster.
properties:
apiVersion:
description: 'APIVersion defines the versioned schema of this representation
@@ -22,9 +28,11 @@ spec:
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: 'AlertmanagerSpec is a 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
@@ -33,11 +41,10 @@ spec:
type: string
type: array
affinity:
- description: Affinity is a group of affinity scheduling rules.
+ description: If specified, the pod's scheduling constraints.
properties:
nodeAffinity:
- description: Node affinity is a group of node affinity scheduling
- rules.
+ description: Describes node affinity scheduling rules for the pod.
properties:
preferredDuringSchedulingIgnoredDuringExecution:
description: The scheduler will prefer to schedule pods to nodes
@@ -57,10 +64,8 @@ spec:
a no-op).
properties:
preference:
- 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 node selector term, associated with the
+ corresponding weight.
properties:
matchExpressions:
description: A list of node selector requirements
@@ -137,15 +142,17 @@ spec:
format: int32
type: integer
required:
- - weight
- preference
+ - weight
type: object
type: array
requiredDuringSchedulingIgnoredDuringExecution:
- description: A node selector represents the union of the results
- of one or more label queries over a set of nodes; that is,
- it represents the OR of the selectors represented by the node
- selector terms.
+ 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
@@ -231,8 +238,8 @@ spec:
type: object
type: object
podAffinity:
- description: Pod affinity is a group of inter pod affinity scheduling
- rules.
+ 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
@@ -250,20 +257,12 @@ spec:
fields are added per-node to find the most preferred node(s)
properties:
podAffinityTerm:
- 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: Required. A pod affinity term, associated
+ with the corresponding weight.
properties:
labelSelector:
- description: A label selector is a label query over
- a set of resources. The result of matchLabels and
- matchExpressions are ANDed. An empty label selector
- matches all objects. A null label selector matches
- no objects.
+ description: A label query over a set of resources,
+ in this case pods.
properties:
matchExpressions:
description: matchExpressions is a list of label
@@ -299,6 +298,8 @@ spec:
type: object
type: array
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,
@@ -332,8 +333,8 @@ spec:
format: int32
type: integer
required:
- - weight
- podAffinityTerm
+ - weight
type: object
type: array
requiredDuringSchedulingIgnoredDuringExecution:
@@ -356,10 +357,8 @@ spec:
is running
properties:
labelSelector:
- description: A label selector is a label query over a
- set of resources. The result of matchLabels and matchExpressions
- are ANDed. An empty label selector matches all objects.
- A null label selector matches no objects.
+ description: A label query over a set of resources, in
+ this case pods.
properties:
matchExpressions:
description: matchExpressions is a list of label selector
@@ -394,6 +393,8 @@ spec:
type: object
type: array
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
@@ -423,8 +424,9 @@ spec:
type: array
type: object
podAntiAffinity:
- description: Pod anti affinity is a group of inter pod anti affinity
- scheduling rules.
+ 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
@@ -443,20 +445,12 @@ spec:
fields are added per-node to find the most preferred node(s)
properties:
podAffinityTerm:
- 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: Required. A pod affinity term, associated
+ with the corresponding weight.
properties:
labelSelector:
- description: A label selector is a label query over
- a set of resources. The result of matchLabels and
- matchExpressions are ANDed. An empty label selector
- matches all objects. A null label selector matches
- no objects.
+ description: A label query over a set of resources,
+ in this case pods.
properties:
matchExpressions:
description: matchExpressions is a list of label
@@ -492,6 +486,8 @@ spec:
type: object
type: array
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,
@@ -525,8 +521,8 @@ spec:
format: int32
type: integer
required:
- - weight
- podAffinityTerm
+ - weight
type: object
type: array
requiredDuringSchedulingIgnoredDuringExecution:
@@ -549,10 +545,8 @@ spec:
is running
properties:
labelSelector:
- description: A label selector is a label query over a
- set of resources. The result of matchLabels and matchExpressions
- are ANDed. An empty label selector matches all objects.
- A null label selector matches no objects.
+ description: A label query over a set of resources, in
+ this case pods.
properties:
matchExpressions:
description: matchExpressions is a list of label selector
@@ -587,6 +581,8 @@ spec:
type: object
type: array
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
@@ -686,17 +682,19 @@ spec:
exists or not. Defaults to "".'
type: string
valueFrom:
- description: EnvVarSource represents a source for the value
- of an EnvVar.
+ description: Source for the environment variable's value.
+ Cannot be used if value is not empty.
properties:
configMapKeyRef:
- description: Selects a key from a ConfigMap.
+ description: Selects a key of a ConfigMap.
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'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -706,8 +704,10 @@ spec:
- key
type: object
fieldRef:
- description: ObjectFieldSelector selects an APIVersioned
- field of an object.
+ description: 'Selects a field of the pod: supports metadata.name,
+ metadata.namespace, metadata.labels, metadata.annotations,
+ spec.nodeName, spec.serviceAccountName, status.hostIP,
+ status.podIP.'
properties:
apiVersion:
description: Version of the schema the FieldPath
@@ -721,14 +721,19 @@ spec:
- fieldPath
type: object
resourceFieldRef:
- description: ResourceFieldSelector represents container
- resources (cpu, memory) and their output format
+ 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'
type: string
- divisor: {}
+ divisor:
+ description: Specifies the output format of the
+ exposed resources, defaults to "1"
+ type: string
resource:
description: 'Required: resource to select'
type: string
@@ -736,14 +741,17 @@ spec:
- resource
type: object
secretKeyRef:
- description: SecretKeySelector selects a key of a Secret.
+ 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.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -770,13 +778,11 @@ spec:
ConfigMaps
properties:
configMapRef:
- description: |-
- ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.
-
- The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.
+ 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'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -787,13 +793,11 @@ spec:
in the ConfigMap. Must be a C_IDENTIFIER.
type: string
secretRef:
- description: |-
- SecretEnvSource selects a Secret to populate the environment variables with.
-
- The contents of the target Secret's Data field will represent the key-value pairs as environment variables.
+ 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'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -813,19 +817,19 @@ spec:
otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
- description: Lifecycle describes actions that the management system
- should take in response to container lifecycle events. For the
- PostStart and PreStop lifecycle handlers, management of the
- container blocks until the action is complete, unless the container
- process fails, in which case the handler is aborted.
+ description: Actions that the management system should take in
+ response to container lifecycle events. Cannot be updated.
properties:
postStart:
- description: Handler defines a specific action that should
- be taken
+ 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: ExecAction describes a "run in container"
- action.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
command:
description: Command is the command line to execute
@@ -841,8 +845,7 @@ spec:
type: array
type: object
httpGet:
- description: HTTPGetAction describes an action based on
- HTTP Get requests.
+ description: HTTPGet specifies the http request to perform.
properties:
host:
description: Host name to connect to, defaults to
@@ -872,8 +875,12 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
scheme:
description: Scheme to use for connecting to the host.
Defaults to HTTP.
@@ -882,8 +889,9 @@ spec:
- port
type: object
tcpSocket:
- description: TCPSocketAction describes an action based
- on opening a socket
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO: implement
+ a realistic TCP lifecycle hook'
properties:
host:
description: 'Optional: Host name to connect to, defaults
@@ -891,19 +899,33 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
preStop:
- description: Handler defines a specific action that should
- be taken
+ 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 reason for termination is passed to
+ the handler. The Pod''s termination grace period countdown
+ begins before the PreStop hooked is executed. Regardless
+ of the outcome of the handler, the container will eventually
+ terminate within the Pod''s termination grace period. 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: ExecAction describes a "run in container"
- action.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
command:
description: Command is the command line to execute
@@ -919,8 +941,7 @@ spec:
type: array
type: object
httpGet:
- description: HTTPGetAction describes an action based on
- HTTP Get requests.
+ description: HTTPGet specifies the http request to perform.
properties:
host:
description: Host name to connect to, defaults to
@@ -950,8 +971,12 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
scheme:
description: Scheme to use for connecting to the host.
Defaults to HTTP.
@@ -960,8 +985,9 @@ spec:
- port
type: object
tcpSocket:
- description: TCPSocketAction describes an action based
- on opening a socket
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO: implement
+ a realistic TCP lifecycle hook'
properties:
host:
description: 'Optional: Host name to connect to, defaults
@@ -969,20 +995,25 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
type: object
livenessProbe:
- description: Probe describes a health check to be performed against
- a container to determine whether it is alive or ready to receive
- traffic.
+ 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: ExecAction describes a "run in container" action.
+ description: One and only one of the following should be specified.
+ Exec specifies the action to take.
properties:
command:
description: Command is the command line to execute inside
@@ -1004,8 +1035,7 @@ spec:
format: int32
type: integer
httpGet:
- description: HTTPGetAction describes an action based on HTTP
- Get requests.
+ description: HTTPGet specifies the http request to perform.
properties:
host:
description: Host name to connect to, defaults to the
@@ -1035,8 +1065,12 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
scheme:
description: Scheme to use for connecting to the host.
Defaults to HTTP.
@@ -1062,8 +1096,9 @@ spec:
format: int32
type: integer
tcpSocket:
- description: TCPSocketAction describes an action based on
- opening a socket
+ description: 'TCPSocket specifies an action involving a TCP
+ port. TCP hooks not yet supported TODO: implement a realistic
+ TCP lifecycle hook'
properties:
host:
description: 'Optional: Host name to connect to, defaults
@@ -1071,8 +1106,12 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
required:
- port
type: object
@@ -1130,12 +1169,13 @@ spec:
type: object
type: array
readinessProbe:
- description: Probe describes a health check to be performed against
- a container to determine whether it is alive or ready to receive
- traffic.
+ 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: ExecAction describes a "run in container" action.
+ description: One and only one of the following should be specified.
+ Exec specifies the action to take.
properties:
command:
description: Command is the command line to execute inside
@@ -1157,8 +1197,7 @@ spec:
format: int32
type: integer
httpGet:
- description: HTTPGetAction describes an action based on HTTP
- Get requests.
+ description: HTTPGet specifies the http request to perform.
properties:
host:
description: Host name to connect to, defaults to the
@@ -1188,8 +1227,12 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
scheme:
description: Scheme to use for connecting to the host.
Defaults to HTTP.
@@ -1215,8 +1258,9 @@ spec:
format: int32
type: integer
tcpSocket:
- description: TCPSocketAction describes an action based on
- opening a socket
+ description: 'TCPSocket specifies an action involving a TCP
+ port. TCP hooks not yet supported TODO: implement a realistic
+ TCP lifecycle hook'
properties:
host:
description: 'Optional: Host name to connect to, defaults
@@ -1224,8 +1268,12 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
required:
- port
type: object
@@ -1237,14 +1285,18 @@ spec:
type: integer
type: object
resources:
- description: ResourceRequirements describes the compute resource
- requirements.
+ description: 'Compute Resources required by this container. Cannot
+ be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
properties:
limits:
+ additionalProperties:
+ type: string
description: 'Limits describes the maximum amount of compute
resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
+ additionalProperties:
+ type: string
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
@@ -1252,10 +1304,9 @@ spec:
type: object
type: object
securityContext:
- description: SecurityContext holds security configuration that
- will be applied to a container. Some fields are present in both
- SecurityContext and PodSecurityContext. When both are set,
- the values in SecurityContext take precedence.
+ description: 'Security options the pod should run with. More info:
+ https://kubernetes.io/docs/concepts/policy/security-context/
+ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
properties:
allowPrivilegeEscalation:
description: 'AllowPrivilegeEscalation controls whether a
@@ -1266,17 +1317,22 @@ spec:
2) has CAP_SYS_ADMIN'
type: boolean
capabilities:
- description: Adds and removes POSIX capabilities from running
- containers.
+ description: The capabilities to add/drop when running containers.
+ Defaults to the default set of capabilities granted by the
+ container runtime.
properties:
add:
description: Added capabilities
items:
+ description: Capability represent POSIX capabilities
+ type
type: string
type: array
drop:
description: Removed capabilities
items:
+ description: Capability represent POSIX capabilities
+ type
type: string
type: array
type: object
@@ -1322,8 +1378,12 @@ spec:
format: int64
type: integer
seLinuxOptions:
- description: SELinuxOptions are the labels to be applied to
- the container
+ 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.
properties:
level:
description: Level is SELinux level label that applies
@@ -1343,8 +1403,10 @@ spec:
type: string
type: object
windowsOptions:
- description: WindowsSecurityContextOptions contain Windows-specific
- options and credentials.
+ 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.
properties:
gmsaCredentialSpec:
description: GMSACredentialSpec is where the GMSA admission
@@ -1373,12 +1435,19 @@ spec:
type: object
type: object
startupProbe:
- description: Probe describes a health check to be performed against
- a container to determine whether it is alive or ready to receive
- traffic.
+ 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. This is an alpha feature enabled by the StartupProbe
+ feature flag. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
- description: ExecAction describes a "run in container" action.
+ description: One and only one of the following should be specified.
+ Exec specifies the action to take.
properties:
command:
description: Command is the command line to execute inside
@@ -1400,8 +1469,7 @@ spec:
format: int32
type: integer
httpGet:
- description: HTTPGetAction describes an action based on HTTP
- Get requests.
+ description: HTTPGet specifies the http request to perform.
properties:
host:
description: Host name to connect to, defaults to the
@@ -1431,8 +1499,12 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
scheme:
description: Scheme to use for connecting to the host.
Defaults to HTTP.
@@ -1458,8 +1530,9 @@ spec:
format: int32
type: integer
tcpSocket:
- description: TCPSocketAction describes an action based on
- opening a socket
+ description: 'TCPSocket specifies an action involving a TCP
+ port. TCP hooks not yet supported TODO: implement a realistic
+ TCP lifecycle hook'
properties:
host:
description: 'Optional: Host name to connect to, defaults
@@ -1467,8 +1540,12 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
required:
- port
type: object
@@ -1534,8 +1611,8 @@ spec:
in the pod
type: string
required:
- - name
- devicePath
+ - name
type: object
type: array
volumeMounts:
@@ -1575,8 +1652,8 @@ spec:
exclusive. This field is beta in 1.15.
type: string
required:
- - name
- mountPath
+ - name
type: object
type: array
workingDir:
@@ -1608,7 +1685,8 @@ spec:
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'
+ description: 'Name of the 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
type: array
@@ -1672,17 +1750,19 @@ spec:
exists or not. Defaults to "".'
type: string
valueFrom:
- description: EnvVarSource represents a source for the value
- of an EnvVar.
+ description: Source for the environment variable's value.
+ Cannot be used if value is not empty.
properties:
configMapKeyRef:
- description: Selects a key from a ConfigMap.
+ description: Selects a key of a ConfigMap.
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'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -1692,8 +1772,10 @@ spec:
- key
type: object
fieldRef:
- description: ObjectFieldSelector selects an APIVersioned
- field of an object.
+ description: 'Selects a field of the pod: supports metadata.name,
+ metadata.namespace, metadata.labels, metadata.annotations,
+ spec.nodeName, spec.serviceAccountName, status.hostIP,
+ status.podIP.'
properties:
apiVersion:
description: Version of the schema the FieldPath
@@ -1707,14 +1789,19 @@ spec:
- fieldPath
type: object
resourceFieldRef:
- description: ResourceFieldSelector represents container
- resources (cpu, memory) and their output format
+ 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'
type: string
- divisor: {}
+ divisor:
+ description: Specifies the output format of the
+ exposed resources, defaults to "1"
+ type: string
resource:
description: 'Required: resource to select'
type: string
@@ -1722,14 +1809,17 @@ spec:
- resource
type: object
secretKeyRef:
- description: SecretKeySelector selects a key of a Secret.
+ 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.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -1756,13 +1846,11 @@ spec:
ConfigMaps
properties:
configMapRef:
- description: |-
- ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.
-
- The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.
+ 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'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -1773,13 +1861,11 @@ spec:
in the ConfigMap. Must be a C_IDENTIFIER.
type: string
secretRef:
- description: |-
- SecretEnvSource selects a Secret to populate the environment variables with.
-
- The contents of the target Secret's Data field will represent the key-value pairs as environment variables.
+ 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'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -1799,19 +1885,19 @@ spec:
otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
- description: Lifecycle describes actions that the management system
- should take in response to container lifecycle events. For the
- PostStart and PreStop lifecycle handlers, management of the
- container blocks until the action is complete, unless the container
- process fails, in which case the handler is aborted.
+ description: Actions that the management system should take in
+ response to container lifecycle events. Cannot be updated.
properties:
postStart:
- description: Handler defines a specific action that should
- be taken
+ 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: ExecAction describes a "run in container"
- action.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
command:
description: Command is the command line to execute
@@ -1827,8 +1913,7 @@ spec:
type: array
type: object
httpGet:
- description: HTTPGetAction describes an action based on
- HTTP Get requests.
+ description: HTTPGet specifies the http request to perform.
properties:
host:
description: Host name to connect to, defaults to
@@ -1858,8 +1943,12 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
scheme:
description: Scheme to use for connecting to the host.
Defaults to HTTP.
@@ -1868,8 +1957,9 @@ spec:
- port
type: object
tcpSocket:
- description: TCPSocketAction describes an action based
- on opening a socket
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO: implement
+ a realistic TCP lifecycle hook'
properties:
host:
description: 'Optional: Host name to connect to, defaults
@@ -1877,19 +1967,33 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
preStop:
- description: Handler defines a specific action that should
- be taken
+ 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 reason for termination is passed to
+ the handler. The Pod''s termination grace period countdown
+ begins before the PreStop hooked is executed. Regardless
+ of the outcome of the handler, the container will eventually
+ terminate within the Pod''s termination grace period. 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: ExecAction describes a "run in container"
- action.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
command:
description: Command is the command line to execute
@@ -1905,8 +2009,7 @@ spec:
type: array
type: object
httpGet:
- description: HTTPGetAction describes an action based on
- HTTP Get requests.
+ description: HTTPGet specifies the http request to perform.
properties:
host:
description: Host name to connect to, defaults to
@@ -1936,8 +2039,12 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
scheme:
description: Scheme to use for connecting to the host.
Defaults to HTTP.
@@ -1946,8 +2053,9 @@ spec:
- port
type: object
tcpSocket:
- description: TCPSocketAction describes an action based
- on opening a socket
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO: implement
+ a realistic TCP lifecycle hook'
properties:
host:
description: 'Optional: Host name to connect to, defaults
@@ -1955,20 +2063,25 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
type: object
livenessProbe:
- description: Probe describes a health check to be performed against
- a container to determine whether it is alive or ready to receive
- traffic.
+ 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: ExecAction describes a "run in container" action.
+ description: One and only one of the following should be specified.
+ Exec specifies the action to take.
properties:
command:
description: Command is the command line to execute inside
@@ -1990,8 +2103,7 @@ spec:
format: int32
type: integer
httpGet:
- description: HTTPGetAction describes an action based on HTTP
- Get requests.
+ description: HTTPGet specifies the http request to perform.
properties:
host:
description: Host name to connect to, defaults to the
@@ -2021,8 +2133,12 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
scheme:
description: Scheme to use for connecting to the host.
Defaults to HTTP.
@@ -2048,8 +2164,9 @@ spec:
format: int32
type: integer
tcpSocket:
- description: TCPSocketAction describes an action based on
- opening a socket
+ description: 'TCPSocket specifies an action involving a TCP
+ port. TCP hooks not yet supported TODO: implement a realistic
+ TCP lifecycle hook'
properties:
host:
description: 'Optional: Host name to connect to, defaults
@@ -2057,8 +2174,12 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
required:
- port
type: object
@@ -2116,12 +2237,13 @@ spec:
type: object
type: array
readinessProbe:
- description: Probe describes a health check to be performed against
- a container to determine whether it is alive or ready to receive
- traffic.
+ 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: ExecAction describes a "run in container" action.
+ description: One and only one of the following should be specified.
+ Exec specifies the action to take.
properties:
command:
description: Command is the command line to execute inside
@@ -2143,8 +2265,7 @@ spec:
format: int32
type: integer
httpGet:
- description: HTTPGetAction describes an action based on HTTP
- Get requests.
+ description: HTTPGet specifies the http request to perform.
properties:
host:
description: Host name to connect to, defaults to the
@@ -2174,8 +2295,12 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
scheme:
description: Scheme to use for connecting to the host.
Defaults to HTTP.
@@ -2201,8 +2326,9 @@ spec:
format: int32
type: integer
tcpSocket:
- description: TCPSocketAction describes an action based on
- opening a socket
+ description: 'TCPSocket specifies an action involving a TCP
+ port. TCP hooks not yet supported TODO: implement a realistic
+ TCP lifecycle hook'
properties:
host:
description: 'Optional: Host name to connect to, defaults
@@ -2210,8 +2336,12 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
required:
- port
type: object
@@ -2223,14 +2353,18 @@ spec:
type: integer
type: object
resources:
- description: ResourceRequirements describes the compute resource
- requirements.
+ description: 'Compute Resources required by this container. Cannot
+ be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
properties:
limits:
+ additionalProperties:
+ type: string
description: 'Limits describes the maximum amount of compute
resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
+ additionalProperties:
+ type: string
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
@@ -2238,10 +2372,9 @@ spec:
type: object
type: object
securityContext:
- description: SecurityContext holds security configuration that
- will be applied to a container. Some fields are present in both
- SecurityContext and PodSecurityContext. When both are set,
- the values in SecurityContext take precedence.
+ description: 'Security options the pod should run with. More info:
+ https://kubernetes.io/docs/concepts/policy/security-context/
+ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
properties:
allowPrivilegeEscalation:
description: 'AllowPrivilegeEscalation controls whether a
@@ -2252,17 +2385,22 @@ spec:
2) has CAP_SYS_ADMIN'
type: boolean
capabilities:
- description: Adds and removes POSIX capabilities from running
- containers.
+ description: The capabilities to add/drop when running containers.
+ Defaults to the default set of capabilities granted by the
+ container runtime.
properties:
add:
description: Added capabilities
items:
+ description: Capability represent POSIX capabilities
+ type
type: string
type: array
drop:
description: Removed capabilities
items:
+ description: Capability represent POSIX capabilities
+ type
type: string
type: array
type: object
@@ -2308,8 +2446,12 @@ spec:
format: int64
type: integer
seLinuxOptions:
- description: SELinuxOptions are the labels to be applied to
- the container
+ 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.
properties:
level:
description: Level is SELinux level label that applies
@@ -2329,8 +2471,10 @@ spec:
type: string
type: object
windowsOptions:
- description: WindowsSecurityContextOptions contain Windows-specific
- options and credentials.
+ 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.
properties:
gmsaCredentialSpec:
description: GMSACredentialSpec is where the GMSA admission
@@ -2359,12 +2503,19 @@ spec:
type: object
type: object
startupProbe:
- description: Probe describes a health check to be performed against
- a container to determine whether it is alive or ready to receive
- traffic.
+ 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. This is an alpha feature enabled by the StartupProbe
+ feature flag. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
- description: ExecAction describes a "run in container" action.
+ description: One and only one of the following should be specified.
+ Exec specifies the action to take.
properties:
command:
description: Command is the command line to execute inside
@@ -2386,8 +2537,7 @@ spec:
format: int32
type: integer
httpGet:
- description: HTTPGetAction describes an action based on HTTP
- Get requests.
+ description: HTTPGet specifies the http request to perform.
properties:
host:
description: Host name to connect to, defaults to the
@@ -2417,8 +2567,12 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
scheme:
description: Scheme to use for connecting to the host.
Defaults to HTTP.
@@ -2444,8 +2598,9 @@ spec:
format: int32
type: integer
tcpSocket:
- description: TCPSocketAction describes an action based on
- opening a socket
+ description: 'TCPSocket specifies an action involving a TCP
+ port. TCP hooks not yet supported TODO: implement a realistic
+ TCP lifecycle hook'
properties:
host:
description: 'Optional: Host name to connect to, defaults
@@ -2453,8 +2608,12 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
required:
- port
type: object
@@ -2520,8 +2679,8 @@ spec:
in the pod
type: string
required:
- - name
- devicePath
+ - name
type: object
type: array
volumeMounts:
@@ -2561,8 +2720,8 @@ spec:
exclusive. This field is beta in 1.15.
type: string
required:
- - name
- mountPath
+ - name
type: object
type: array
workingDir:
@@ -2586,6 +2745,8 @@ spec:
description: Log level for Alertmanager to be configured with.
type: string
nodeSelector:
+ additionalProperties:
+ type: string
description: Define which Nodes the Pods are scheduled on.
type: object
paused:
@@ -2593,190 +2754,9 @@ spec:
are not goint to be performed, except for delete actions.
type: boolean
podMetadata:
- description: ObjectMeta is metadata that all persisted resources must
- have, which includes all objects users must create.
- properties:
- 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
- clusterName:
- description: The name of the cluster which the object belongs to.
- This is used to distinguish resources with same name and namespace
- in different clusters. This field is not set anywhere right now
- and apiserver is going to ignore it if set in create or update
- request.
- type: string
- creationTimestamp:
- description: Time is a wrapper around time.Time which supports correct
- marshaling to YAML and JSON. Wrappers are provided for many of
- the factory methods that the time package offers.
- format: date-time
- type: string
- deletionGracePeriodSeconds:
- description: Number of seconds allowed for this object to gracefully
- terminate before it will be removed from the system. Only set
- when deletionTimestamp is also set. May only be shortened. Read-only.
- format: int64
- type: integer
- deletionTimestamp:
- description: Time is a wrapper around time.Time which supports correct
- marshaling to YAML and JSON. Wrappers are provided for many of
- the factory methods that the time package offers.
- format: date-time
- type: string
- finalizers:
- description: Must be empty before the object is deleted from the
- registry. Each entry is an identifier for the responsible component
- that will remove the entry from the list. If the deletionTimestamp
- of the object is non-nil, entries in this list can only be removed.
- items:
- type: string
- type: array
- generateName:
- description: |-
- GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
-
- If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
-
- Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
- type: string
- generation:
- description: A sequence number representing a specific generation
- of the desired state. Populated by the system. Read-only.
- format: int64
- type: integer
- 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
- managedFields:
- description: ManagedFields maps workflow-id and version to the set
- of fields that are managed by that workflow. This is mostly for
- internal housekeeping, and users typically shouldn't need to set
- or understand this field. A workflow can be the user's name, a
- controller's name, or the name of a specific apply path like "ci-cd".
- The set of fields is always in the version that the workflow used
- when modifying the object.
- items:
- description: ManagedFieldsEntry is a workflow-id, a FieldSet and
- the group version of the resource that the fieldset applies
- to.
- properties:
- apiVersion:
- description: APIVersion defines the version of this resource
- that this field set applies to. The format is "group/version"
- just like the top-level APIVersion field. It is necessary
- to track the version of a field set because it cannot be
- automatically converted.
- type: string
- fieldsType:
- description: 'FieldsType is the discriminator for the different
- fields format and version. There is currently only one possible
- value: "FieldsV1"'
- type: string
- fieldsV1:
- description: |-
- FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.
-
- Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.
-
- The exact format is defined in sigs.k8s.io/structured-merge-diff
- type: object
- manager:
- description: Manager is an identifier of the workflow managing
- these fields.
- type: string
- operation:
- description: Operation is the type of operation which lead
- to this ManagedFieldsEntry being created. The only valid
- values for this field are 'Apply' and 'Update'.
- type: string
- time:
- description: Time is a wrapper around time.Time which supports
- correct marshaling to YAML and JSON. Wrappers are provided
- for many of the factory methods that the time package offers.
- format: date-time
- type: string
- type: object
- type: array
- 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'
- type: string
- namespace:
- description: |-
- Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
-
- Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
- type: string
- ownerReferences:
- description: List of objects depended by this object. If ALL objects
- in the list have been deleted, this object will be garbage collected.
- If this object is managed by a controller, then an entry in this
- list will point to this controller, with the controller field
- set to true. There cannot be more than one managing controller.
- items:
- description: OwnerReference contains enough information to let
- you identify an owning object. An owning object must be in the
- same namespace as the dependent, or be cluster-scoped, so there
- is no namespace field.
- properties:
- apiVersion:
- description: API version of the referent.
- type: string
- blockOwnerDeletion:
- description: If true, AND if the owner has the "foregroundDeletion"
- finalizer, then the owner cannot be deleted from the key-value
- store until this reference is removed. Defaults to false.
- To set this field, a user needs "delete" permission of the
- owner, otherwise 422 (Unprocessable Entity) will be returned.
- type: boolean
- controller:
- description: If true, this reference points to the managing
- controller.
- type: boolean
- kind:
- description: 'Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
- type: string
- name:
- description: 'Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names'
- type: string
- uid:
- description: 'UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids'
- type: string
- required:
- - apiVersion
- - kind
- - name
- - uid
- type: object
- type: array
- resourceVersion:
- description: |-
- An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
-
- Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
- type: string
- selfLink:
- description: |-
- SelfLink is a URL representing this object. Populated by the system. Read-only.
-
- DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.
- type: string
- uid:
- description: |-
- UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
-
- Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
- type: string
+ description: 'Standard object’s metadata. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata
+ Metadata Labels and Annotations gets propagated to the prometheus
+ pods.'
type: object
portName:
description: Port name used for the pods and governing service. This
@@ -2792,13 +2772,17 @@ spec:
format: int32
type: integer
resources:
- description: ResourceRequirements describes the compute resource requirements.
+ description: Define resources requests and limits for single Pods.
properties:
limits:
+ additionalProperties:
+ type: string
description: 'Limits describes the maximum amount of compute resources
allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
+ additionalProperties:
+ type: string
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
@@ -2825,18 +2809,17 @@ spec:
type: string
type: array
securityContext:
- description: PodSecurityContext holds pod-level security attributes
- and common container settings. Some fields are also present in container.securityContext. Field
- values of container.securityContext take precedence over field values
- of 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:
-
- 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----
-
- If unset, the Kubelet will not modify the ownership and permissions of any volume.
+ 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."
format: int64
type: integer
runAsGroup:
@@ -2864,8 +2847,11 @@ spec:
format: int64
type: integer
seLinuxOptions:
- description: SELinuxOptions are the labels to be applied to the
- container
+ 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.
properties:
level:
description: Level is SELinux level label that applies to the
@@ -2911,8 +2897,10 @@ spec:
type: object
type: array
windowsOptions:
- description: WindowsSecurityContextOptions contain Windows-specific
- options and credentials.
+ 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.
properties:
gmsaCredentialSpec:
description: GMSACredentialSpec is where the GMSA admission
@@ -2949,25 +2937,31 @@ spec:
if SHA is set.
type: string
storage:
- description: StorageSpec defines the configured storage for a group
- Prometheus servers. If neither `emptyDir` nor `volumeClaimTemplate`
- is specified, then by default an [EmptyDir](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir)
- will be used.
+ description: Storage is the definition of how storage will be used by
+ the Alertmanager instances.
properties:
emptyDir:
- description: Represents an empty directory for a pod. Empty directory
- volumes support ownership management and SELinux relabeling.
+ description: 'EmptyDirVolumeSource to be used by the Prometheus
+ StatefulSets. If specified, used in place of any volumeClaimTemplate.
+ More info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir'
properties:
medium:
description: '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: {}
+ sizeLimit:
+ description: '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'
+ type: string
type: object
volumeClaimTemplate:
- description: PersistentVolumeClaim is a user's request for and claim
- to a persistent volume
+ description: A PVC spec to be used by the Prometheus StatefulSets.
properties:
apiVersion:
description: 'APIVersion defines the versioned schema of this
@@ -2982,206 +2976,11 @@ spec:
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
- description: ObjectMeta is metadata that all persisted resources
- must have, which includes all objects users must create.
- properties:
- 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
- clusterName:
- description: The name of the cluster which the object belongs
- to. This is used to distinguish resources with same name
- and namespace in different clusters. This field is not
- set anywhere right now and apiserver is going to ignore
- it if set in create or update request.
- type: string
- creationTimestamp:
- description: Time is a wrapper around time.Time which supports
- correct marshaling to YAML and JSON. Wrappers are provided
- for many of the factory methods that the time package
- offers.
- format: date-time
- type: string
- deletionGracePeriodSeconds:
- description: Number of seconds allowed for this object to
- gracefully terminate before it will be removed from the
- system. Only set when deletionTimestamp is also set. May
- only be shortened. Read-only.
- format: int64
- type: integer
- deletionTimestamp:
- description: Time is a wrapper around time.Time which supports
- correct marshaling to YAML and JSON. Wrappers are provided
- for many of the factory methods that the time package
- offers.
- format: date-time
- type: string
- finalizers:
- description: Must be empty before the object is deleted
- from the registry. Each entry is an identifier for the
- responsible component that will remove the entry from
- the list. If the deletionTimestamp of the object is non-nil,
- entries in this list can only be removed.
- items:
- type: string
- type: array
- generateName:
- description: |-
- GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
-
- If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
-
- Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
- type: string
- generation:
- description: A sequence number representing a specific generation
- of the desired state. Populated by the system. Read-only.
- format: int64
- type: integer
- 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
- managedFields:
- description: ManagedFields maps workflow-id and version
- to the set of fields that are managed by that workflow.
- This is mostly for internal housekeeping, and users typically
- shouldn't need to set or understand this field. A workflow
- can be the user's name, a controller's name, or the name
- of a specific apply path like "ci-cd". The set of fields
- is always in the version that the workflow used when modifying
- the object.
- items:
- description: ManagedFieldsEntry is a workflow-id, a FieldSet
- and the group version of the resource that the fieldset
- applies to.
- properties:
- apiVersion:
- description: APIVersion defines the version of this
- resource that this field set applies to. The format
- is "group/version" just like the top-level APIVersion
- field. It is necessary to track the version of a
- field set because it cannot be automatically converted.
- type: string
- fieldsType:
- description: 'FieldsType is the discriminator for
- the different fields format and version. There is
- currently only one possible value: "FieldsV1"'
- type: string
- fieldsV1:
- description: |-
- FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.
-
- Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.
-
- The exact format is defined in sigs.k8s.io/structured-merge-diff
- type: object
- manager:
- description: Manager is an identifier of the workflow
- managing these fields.
- type: string
- operation:
- description: Operation is the type of operation which
- lead to this ManagedFieldsEntry being created. The
- only valid values for this field are 'Apply' and
- 'Update'.
- type: string
- time:
- description: Time is a wrapper around time.Time which
- supports correct marshaling to YAML and JSON. Wrappers
- are provided for many of the factory methods that
- the time package offers.
- format: date-time
- type: string
- type: object
- type: array
- 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'
- type: string
- namespace:
- description: |-
- Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
-
- Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
- type: string
- ownerReferences:
- description: List of objects depended by this object. If
- ALL objects in the list have been deleted, this object
- will be garbage collected. If this object is managed by
- a controller, then an entry in this list will point to
- this controller, with the controller field set to true.
- There cannot be more than one managing controller.
- items:
- description: OwnerReference contains enough information
- to let you identify an owning object. An owning object
- must be in the same namespace as the dependent, or be
- cluster-scoped, so there is no namespace field.
- properties:
- apiVersion:
- description: API version of the referent.
- type: string
- blockOwnerDeletion:
- description: If true, AND if the owner has the "foregroundDeletion"
- finalizer, then the owner cannot be deleted from
- the key-value store until this reference is removed.
- Defaults to false. To set this field, a user needs
- "delete" permission of the owner, otherwise 422
- (Unprocessable Entity) will be returned.
- type: boolean
- controller:
- description: If true, this reference points to the
- managing controller.
- type: boolean
- kind:
- description: 'Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
- type: string
- name:
- description: 'Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names'
- type: string
- uid:
- description: 'UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids'
- type: string
- required:
- - apiVersion
- - kind
- - name
- - uid
- type: object
- type: array
- resourceVersion:
- description: |-
- An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
-
- Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
- type: string
- selfLink:
- description: |-
- SelfLink is a URL representing this object. Populated by the system. Read-only.
-
- DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.
- type: string
- uid:
- description: |-
- UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
-
- Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
- type: string
+ description: 'Standard object''s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata'
type: object
spec:
- description: PersistentVolumeClaimSpec describes the common
- attributes of storage devices and allows a Source for provider-specific
- attributes
+ 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
@@ -3190,9 +2989,16 @@ spec:
type: string
type: array
dataSource:
- description: TypedLocalObjectReference contains enough information
- to let you locate the typed referenced object inside the
- same namespace.
+ description: This field requires the VolumeSnapshotDataSource
+ alpha feature gate to be enabled and currently VolumeSnapshot
+ is the only supported data source. If the provisioner
+ can support VolumeSnapshot data source, it will create
+ a new volume and data will be restored to the volume at
+ the same time. If the provisioner does not support VolumeSnapshot
+ data source, volume will not be created and the failure
+ will be reported as an event. In the future, we plan to
+ support more data source types and the behavior of the
+ provisioner may change.
properties:
apiGroup:
description: APIGroup is the group for the resource
@@ -3211,14 +3017,18 @@ spec:
- name
type: object
resources:
- description: ResourceRequirements describes the compute
- resource requirements.
+ description: 'Resources represents the minimum resources
+ the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
properties:
limits:
+ additionalProperties:
+ type: string
description: 'Limits describes the maximum amount of
compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
+ additionalProperties:
+ type: string
description: 'Requests describes the minimum amount
of compute resources required. If Requests is omitted
for a container, it defaults to Limits if that is
@@ -3227,10 +3037,8 @@ spec:
type: object
type: object
selector:
- description: A label selector is a label query over a set
- of resources. The result of matchLabels and matchExpressions
- are ANDed. An empty label selector matches all objects.
- A null label selector matches no objects.
+ description: A label query over volumes to consider for
+ binding.
properties:
matchExpressions:
description: matchExpressions is a list of label selector
@@ -3265,6 +3073,8 @@ spec:
type: object
type: array
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
@@ -3287,8 +3097,8 @@ spec:
type: string
type: object
status:
- description: PersistentVolumeClaimStatus is the current status
- of a persistent volume claim.
+ 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
@@ -3297,6 +3107,8 @@ spec:
type: string
type: array
capacity:
+ additionalProperties:
+ type: string
description: Represents the actual resources of the underlying
volume.
type: object
@@ -3309,17 +3121,12 @@ spec:
about state of pvc
properties:
lastProbeTime:
- description: Time is a wrapper around time.Time which
- supports correct marshaling to YAML and JSON. Wrappers
- are provided for many of the factory methods that
- the time package offers.
+ description: Last time we probed the condition.
format: date-time
type: string
lastTransitionTime:
- description: Time is a wrapper around time.Time which
- supports correct marshaling to YAML and JSON. Wrappers
- are provided for many of the factory methods that
- the time package offers.
+ description: Last time the condition transitioned
+ from one status to another.
format: date-time
type: string
message:
@@ -3336,10 +3143,12 @@ spec:
status:
type: string
type:
+ description: PersistentVolumeClaimConditionType is
+ a valid value of PersistentVolumeClaimCondition.Type
type: string
required:
- - type
- status
+ - type
type: object
type: array
phase:
@@ -3432,8 +3241,8 @@ spec:
SubPath are mutually exclusive. This field is beta in 1.15.
type: string
required:
- - name
- mountPath
+ - name
type: object
type: array
volumes:
@@ -3445,17 +3254,18 @@ spec:
accessed by any container in the pod.
properties:
awsElasticBlockStore:
- description: |-
- Represents a Persistent Disk resource in AWS.
-
- An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.
+ 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: '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'
+ 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: 'The partition in the volume that you want to
@@ -3529,9 +3339,8 @@ spec:
- shareName
type: object
cephfs:
- description: Represents a Ceph Filesystem mount that lasts the
- lifetime of a pod Cephfs volumes do not support ownership management
- or SELinux relabeling.
+ description: CephFS represents a Ceph FS mount on the host that
+ shares a pod's lifetime
properties:
monitors:
description: 'Required: Monitors is a collection of Ceph monitors
@@ -3553,12 +3362,12 @@ spec:
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: LocalObjectReference contains enough information
- to let you locate the referenced object inside the same
- namespace.
+ description: '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'
+ description: 'Name of the 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
user:
@@ -3569,10 +3378,8 @@ spec:
- monitors
type: object
cinder:
- description: Represents a cinder volume resource in Openstack.
- A Cinder volume must exist before mounting to a container. The
- volume must also be in the same region as the kubelet. Cinder
- volumes support ownership management and SELinux relabeling.
+ 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: 'Filesystem type to mount. Must be a filesystem
@@ -3586,12 +3393,12 @@ spec:
info: https://examples.k8s.io/mysql-cinder-pd/README.md'
type: boolean
secretRef:
- description: LocalObjectReference contains enough information
- to let you locate the referenced object inside the same
- namespace.
+ description: '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'
+ description: 'Name of the 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
volumeID:
@@ -3602,10 +3409,8 @@ spec:
- volumeID
type: object
configMap:
- description: |-
- Adapts a ConfigMap into a volume.
-
- The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.
+ description: ConfigMap represents a configMap that should populate
+ this volume
properties:
defaultMode:
description: 'Optional: mode bits to use on created files
@@ -3653,7 +3458,8 @@ spec:
type: object
type: array
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+ description: 'Name of the referent. More info: https://kubernetes.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 keys must
@@ -3661,8 +3467,8 @@ spec:
type: boolean
type: object
csi:
- description: Represents a source location of a volume to mount,
- managed by an external CSI driver
+ description: CSI (Container Storage Interface) represents storage
+ that is handled by an external CSI driver (Alpha feature).
properties:
driver:
description: Driver is the name of the CSI driver that handles
@@ -3676,12 +3482,16 @@ spec:
to apply.
type: string
nodePublishSecretRef:
- description: LocalObjectReference contains enough information
- to let you locate the referenced object inside the same
- namespace.
+ 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'
+ description: 'Name of the 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
readOnly:
@@ -3689,6 +3499,8 @@ spec:
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.
@@ -3697,9 +3509,8 @@ spec:
- driver
type: object
downwardAPI:
- description: DownwardAPIVolumeSource represents a volume containing
- downward API info. Downward API volumes support ownership management
- and SELinux relabeling.
+ description: DownwardAPI represents downward API about the pod
+ that should populate this volume
properties:
defaultMode:
description: 'Optional: mode bits to use on created files
@@ -3717,8 +3528,8 @@ spec:
to create the file containing the pod field
properties:
fieldRef:
- description: ObjectFieldSelector selects an APIVersioned
- field of an object.
+ 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
@@ -3748,14 +3559,18 @@ spec:
''..'''
type: string
resourceFieldRef:
- description: ResourceFieldSelector represents container
- resources (cpu, memory) and their output format
+ 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'
type: string
- divisor: {}
+ divisor:
+ description: Specifies the output format of the
+ exposed resources, defaults to "1"
+ type: string
resource:
description: 'Required: resource to select'
type: string
@@ -3768,8 +3583,8 @@ spec:
type: array
type: object
emptyDir:
- description: Represents an empty directory for a pod. Empty directory
- volumes support ownership management and SELinux relabeling.
+ 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: 'What type of storage medium should back this
@@ -3777,17 +3592,26 @@ spec:
default medium. Must be an empty string (default) or Memory.
More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
type: string
- sizeLimit: {}
+ sizeLimit:
+ description: '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'
+ type: string
type: object
fc:
- description: Represents a Fibre Channel volume. Fibre Channel
- volumes can only be mounted as read/write once. Fibre Channel
- volumes support ownership management and SELinux relabeling.
+ 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: Filesystem type to mount. Must be a filesystem
+ description: '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: 'Optional: FC target lun number'
@@ -3825,6 +3649,8 @@ spec:
script.
type: string
options:
+ additionalProperties:
+ type: string
description: 'Optional: Extra command options if any.'
type: object
readOnly:
@@ -3832,22 +3658,24 @@ spec:
here will force the ReadOnly setting in VolumeMounts.'
type: boolean
secretRef:
- description: LocalObjectReference contains enough information
- to let you locate the referenced object inside the same
- namespace.
+ description: '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'
+ description: 'Name of the 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
required:
- driver
type: object
flocker:
- description: Represents a Flocker volume mounted by the Flocker
- agent. One and only one of datasetName and datasetUUID should
- be set. Flocker volumes do not support ownership management
- or SELinux relabeling.
+ 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: Name of the dataset stored as metadata -> name
@@ -3859,17 +3687,18 @@ spec:
type: string
type: object
gcePersistentDisk:
- description: |-
- Represents a Persistent Disk resource in Google Compute Engine.
-
- A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.
+ 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: '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'
+ 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: 'The partition in the volume that you want to
@@ -3891,10 +3720,11 @@ spec:
- pdName
type: object
gitRepo:
- description: |-
- Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.
-
- 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: Target directory name. Must not contain or start
@@ -3913,9 +3743,8 @@ spec:
- repository
type: object
glusterfs:
- description: Represents a Glusterfs mount that lasts the lifetime
- of a pod. Glusterfs volumes do not support ownership management
- or SELinux relabeling.
+ 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: 'EndpointsName is the endpoint name that details
@@ -3935,8 +3764,13 @@ spec:
- path
type: object
hostPath:
- description: Represents a host path mapped into a pod. Host path
- volumes do not support ownership management or SELinux relabeling.
+ 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
@@ -3951,9 +3785,9 @@ spec:
- path
type: object
iscsi:
- description: Represents an ISCSI disk. ISCSI volumes can only
- be mounted as read/write once. ISCSI volumes support ownership
- management and SELinux relabeling.
+ 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: whether support iSCSI Discovery CHAP authentication
@@ -3966,7 +3800,9 @@ spec:
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'
+ 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: Custom iSCSI Initiator Name. If initiatorName
@@ -3997,12 +3833,11 @@ spec:
in VolumeMounts. Defaults to false.
type: boolean
secretRef:
- description: LocalObjectReference contains enough information
- to let you locate the referenced object inside the same
- namespace.
+ description: 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'
+ description: 'Name of the 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
targetPortal:
@@ -4011,18 +3846,17 @@ spec:
TCP ports 860 and 3260).
type: string
required:
- - targetPortal
- iqn
- lun
+ - targetPortal
type: object
name:
description: 'Volume''s name. 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: Represents an NFS mount that lasts the lifetime of
- a pod. NFS volumes do not support ownership management or SELinux
- relabeling.
+ 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
@@ -4038,15 +3872,13 @@ spec:
NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: string
required:
- - server
- path
+ - server
type: object
persistentVolumeClaim:
- description: PersistentVolumeClaimVolumeSource references the
- user's PVC in the same namespace. This volume finds the bound
- PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource
- is, essentially, a wrapper around another type of volume that
- is owned by someone else (the system).
+ 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
@@ -4061,7 +3893,8 @@ spec:
- claimName
type: object
photonPersistentDisk:
- description: Represents a Photon Controller persistent disk resource.
+ description: PhotonPersistentDisk represents a PhotonController
+ persistent disk attached and mounted on kubelets host machine
properties:
fsType:
description: Filesystem type to mount. Must be a filesystem
@@ -4076,8 +3909,8 @@ spec:
- pdID
type: object
portworxVolume:
- description: PortworxVolumeSource represents a Portworx volume
- resource.
+ description: PortworxVolume represents a portworx volume attached
+ and mounted on kubelets host machine
properties:
fsType:
description: FSType represents the filesystem type to mount
@@ -4096,7 +3929,8 @@ spec:
- volumeID
type: object
projected:
- description: Represents a projected volume source
+ description: Items for all in one resources secrets, configmaps,
+ and downward API
properties:
defaultMode:
description: Mode bits to use on created files by default.
@@ -4113,10 +3947,8 @@ spec:
other supported volume types
properties:
configMap:
- description: |-
- Adapts a ConfigMap into a projected volume.
-
- The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode.
+ description: information about the configMap data to
+ project
properties:
items:
description: If unspecified, each key-value pair
@@ -4159,7 +3991,9 @@ spec:
type: object
type: array
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -4167,10 +4001,8 @@ spec:
type: boolean
type: object
downwardAPI:
- description: Represents downward API info for projecting
- into a projected volume. Note that this is identical
- to a downwardAPI volume source without the default
- mode.
+ description: information about the downwardAPI data
+ to project
properties:
items:
description: Items is a list of DownwardAPIVolume
@@ -4181,8 +4013,9 @@ spec:
pod field
properties:
fieldRef:
- description: ObjectFieldSelector selects an
- APIVersioned field of an object.
+ description: 'Required: Selects a field of
+ the pod: only annotations, labels, name
+ and namespace are supported.'
properties:
apiVersion:
description: Version of the schema the
@@ -4214,15 +4047,20 @@ spec:
the relative path must not start with ''..'''
type: string
resourceFieldRef:
- description: ResourceFieldSelector represents
- container resources (cpu, memory) and their
- output format
+ 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'
type: string
- divisor: {}
+ divisor:
+ description: Specifies the output format
+ of the exposed resources, defaults to
+ "1"
+ type: string
resource:
description: 'Required: resource to select'
type: string
@@ -4235,10 +4073,7 @@ spec:
type: array
type: object
secret:
- description: |-
- Adapts a secret into a projected volume.
-
- The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode.
+ description: information about the secret data to project
properties:
items:
description: If unspecified, each key-value pair
@@ -4281,7 +4116,9 @@ spec:
type: object
type: array
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -4289,11 +4126,8 @@ spec:
type: boolean
type: object
serviceAccountToken:
- description: ServiceAccountTokenProjection represents
- a projected service account token volume. This projection
- can be used to insert a service account token into
- the pods runtime filesystem for use against APIs (Kubernetes
- API Server or otherwise).
+ description: information about the serviceAccountToken
+ data to project
properties:
audience:
description: Audience is the intended audience of
@@ -4328,9 +4162,8 @@ spec:
- sources
type: object
quobyte:
- description: Represents a Quobyte mount that lasts the lifetime
- of a pod. Quobyte volumes do not support ownership management
- or SELinux relabeling.
+ 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
@@ -4363,16 +4196,17 @@ spec:
- volume
type: object
rbd:
- description: Represents a Rados Block Device mount that lasts
- the lifetime of a pod. RBD volumes support ownership management
- and SELinux relabeling.
+ 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: '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'
+ 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: 'The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
@@ -4395,12 +4229,13 @@ spec:
in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: boolean
secretRef:
- description: LocalObjectReference contains enough information
- to let you locate the referenced object inside the same
- namespace.
+ 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'
+ description: 'Name of the 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
user:
@@ -4408,12 +4243,12 @@ spec:
info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
required:
- - monitors
- image
+ - monitors
type: object
scaleIO:
- description: ScaleIOVolumeSource represents a persistent ScaleIO
- volume
+ description: ScaleIO represents a ScaleIO persistent volume attached
+ and mounted on Kubernetes nodes.
properties:
fsType:
description: Filesystem type to mount. Must be a filesystem
@@ -4432,12 +4267,13 @@ spec:
will force the ReadOnly setting in VolumeMounts.
type: boolean
secretRef:
- description: LocalObjectReference contains enough information
- to let you locate the referenced object inside the same
- namespace.
+ 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'
+ description: 'Name of the 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
sslEnabled:
@@ -4462,14 +4298,12 @@ spec:
type: string
required:
- gateway
- - system
- secretRef
+ - system
type: object
secret:
- description: |-
- Adapts a Secret into a volume.
-
- The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.
+ description: 'Secret represents a secret that should populate
+ this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
properties:
defaultMode:
description: 'Optional: mode bits to use on created files
@@ -4526,7 +4360,8 @@ spec:
type: string
type: object
storageos:
- description: Represents a StorageOS persistent volume resource.
+ description: StorageOS represents a StorageOS volume attached
+ and mounted on Kubernetes nodes.
properties:
fsType:
description: Filesystem type to mount. Must be a filesystem
@@ -4538,12 +4373,13 @@ spec:
will force the ReadOnly setting in VolumeMounts.
type: boolean
secretRef:
- description: LocalObjectReference contains enough information
- to let you locate the referenced object inside the same
- namespace.
+ 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'
+ description: 'Name of the 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
volumeName:
@@ -4563,7 +4399,8 @@ spec:
type: string
type: object
vsphereVolume:
- description: Represents a vSphere volume resource.
+ description: VsphereVolume represents a vSphere volume attached
+ and mounted on kubelets host machine
properties:
fsType:
description: Filesystem type to mount. Must be a filesystem
@@ -4590,9 +4427,9 @@ spec:
type: array
type: object
status:
- description: 'AlertmanagerStatus is the most recent observed status of the
- Alertmanager cluster. Read-only. Not included when requesting from the
- apiserver, only from the Prometheus 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 Alertmanager cluster. Read-only.
+ Not included when requesting from the apiserver, only from the Prometheus
+ 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)
@@ -4619,11 +4456,23 @@ spec:
format: int32
type: integer
required:
+ - availableReplicas
- paused
- replicas
- - updatedReplicas
- - availableReplicas
- unavailableReplicas
+ - updatedReplicas
type: object
+ required:
+ - spec
type: object
version: v1
+ versions:
+ - name: v1
+ served: true
+ storage: true
+status:
+ acceptedNames:
+ kind: ""
+ plural: ""
+ conditions: []
+ storedVersions: []
diff --git a/manifests/setup/prometheus-operator-0podmonitorCustomResourceDefinition.yaml b/manifests/setup/prometheus-operator-0podmonitorCustomResourceDefinition.yaml
index 8062b3dda8c082ca8eb51b17dd332063e94c5066..ae66bdbfe6273834d2795c5a1dde041289eac1e7 100644
--- a/manifests/setup/prometheus-operator-0podmonitorCustomResourceDefinition.yaml
+++ b/manifests/setup/prometheus-operator-0podmonitorCustomResourceDefinition.yaml
@@ -1,16 +1,22 @@
apiVersion: apiextensions.k8s.io/v1beta1
kind: CustomResourceDefinition
metadata:
+ annotations:
+ controller-gen.kubebuilder.io/version: v0.2.4
creationTimestamp: null
name: podmonitors.monitoring.coreos.com
spec:
group: monitoring.coreos.com
names:
kind: PodMonitor
+ listKind: PodMonitorList
plural: podmonitors
+ singular: podmonitor
+ preserveUnknownFields: false
scope: Namespaced
validation:
openAPIV3Schema:
+ description: PodMonitor defines monitoring for a set of pods.
properties:
apiVersion:
description: 'APIVersion defines the versioned schema of this representation
@@ -22,15 +28,18 @@ spec:
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: PodMonitorSpec contains specification parameters for a PodMonitor.
+ description: Specification of desired Pod selection for target discovery
+ by Prometheus.
properties:
jobLabel:
description: The label to use to retrieve the job name from.
type: string
namespaceSelector:
- description: NamespaceSelector is a selector for selecting either all
- namespaces or a list of namespaces.
+ description: Selector to select which namespaces the Endpoints objects
+ are discovered from.
properties:
any:
description: Boolean describing whether all namespaces are selected
@@ -78,7 +87,7 @@ spec:
type: integer
regex:
description: Regular expression against which the extracted
- value is matched. defailt is '(.*)'
+ value is matched. Default is '(.*)'
type: string
replacement:
description: Replacement value against which a regex replace
@@ -105,6 +114,10 @@ spec:
type: object
type: array
params:
+ additionalProperties:
+ items:
+ type: string
+ type: array
description: Optional HTTP URL parameters
type: object
path:
@@ -138,7 +151,7 @@ spec:
type: integer
regex:
description: Regular expression against which the extracted
- value is matched. defailt is '(.*)'
+ value is matched. Default is '(.*)'
type: string
replacement:
description: Replacement value against which a regex replace
@@ -172,8 +185,11 @@ spec:
type: string
targetPort:
anyOf:
- - type: string
- type: integer
+ - type: string
+ description: Name or number of the target port of the endpoint.
+ Mutually exclusive with port.
+ x-kubernetes-int-or-string: true
type: object
type: array
podTargetLabels:
@@ -188,10 +204,7 @@ spec:
format: int64
type: integer
selector:
- description: A label selector is a label query over a set of resources.
- The result of matchLabels and matchExpressions are ANDed. An empty
- label selector matches all objects. A null label selector matches
- no objects.
+ description: Selector to select Pod objects.
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements.
@@ -224,6 +237,8 @@ spec:
type: object
type: array
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
@@ -235,5 +250,17 @@ spec:
- podMetricsEndpoints
- selector
type: object
+ required:
+ - spec
type: object
version: v1
+ versions:
+ - name: v1
+ served: true
+ storage: true
+status:
+ acceptedNames:
+ kind: ""
+ plural: ""
+ conditions: []
+ storedVersions: []
diff --git a/manifests/setup/prometheus-operator-0prometheusCustomResourceDefinition.yaml b/manifests/setup/prometheus-operator-0prometheusCustomResourceDefinition.yaml
index 9c450819cc7245655484b350efaca762bf020394..fa62ff05877d4a4904198dc00865b086eba5bcdf 100644
--- a/manifests/setup/prometheus-operator-0prometheusCustomResourceDefinition.yaml
+++ b/manifests/setup/prometheus-operator-0prometheusCustomResourceDefinition.yaml
@@ -1,16 +1,22 @@
apiVersion: apiextensions.k8s.io/v1beta1
kind: CustomResourceDefinition
metadata:
+ annotations:
+ controller-gen.kubebuilder.io/version: v0.2.4
creationTimestamp: null
name: prometheuses.monitoring.coreos.com
spec:
group: monitoring.coreos.com
names:
kind: Prometheus
+ listKind: PrometheusList
plural: prometheuses
+ singular: prometheus
+ preserveUnknownFields: false
scope: Namespaced
validation:
openAPIV3Schema:
+ description: Prometheus defines a Prometheus deployment.
properties:
apiVersion:
description: 'APIVersion defines the versioned schema of this representation
@@ -22,19 +28,32 @@ spec:
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: 'PrometheusSpec is a 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: SecretKeySelector selects a key of a Secret.
+ 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.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -43,14 +62,25 @@ spec:
- key
type: object
additionalAlertRelabelConfigs:
- description: SecretKeySelector selects a key of a Secret.
+ 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.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -59,14 +89,24 @@ spec:
- key
type: object
additionalScrapeConfigs:
- description: SecretKeySelector selects a key of a Secret.
+ 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.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -75,11 +115,10 @@ spec:
- key
type: object
affinity:
- description: Affinity is a group of affinity scheduling rules.
+ description: If specified, the pod's scheduling constraints.
properties:
nodeAffinity:
- description: Node affinity is a group of node affinity scheduling
- rules.
+ description: Describes node affinity scheduling rules for the pod.
properties:
preferredDuringSchedulingIgnoredDuringExecution:
description: The scheduler will prefer to schedule pods to nodes
@@ -99,10 +138,8 @@ spec:
a no-op).
properties:
preference:
- 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 node selector term, associated with the
+ corresponding weight.
properties:
matchExpressions:
description: A list of node selector requirements
@@ -179,15 +216,17 @@ spec:
format: int32
type: integer
required:
- - weight
- preference
+ - weight
type: object
type: array
requiredDuringSchedulingIgnoredDuringExecution:
- description: A node selector represents the union of the results
- of one or more label queries over a set of nodes; that is,
- it represents the OR of the selectors represented by the node
- selector terms.
+ 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
@@ -273,8 +312,8 @@ spec:
type: object
type: object
podAffinity:
- description: Pod affinity is a group of inter pod affinity scheduling
- rules.
+ 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
@@ -292,20 +331,12 @@ spec:
fields are added per-node to find the most preferred node(s)
properties:
podAffinityTerm:
- 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: Required. A pod affinity term, associated
+ with the corresponding weight.
properties:
labelSelector:
- description: A label selector is a label query over
- a set of resources. The result of matchLabels and
- matchExpressions are ANDed. An empty label selector
- matches all objects. A null label selector matches
- no objects.
+ description: A label query over a set of resources,
+ in this case pods.
properties:
matchExpressions:
description: matchExpressions is a list of label
@@ -341,6 +372,8 @@ spec:
type: object
type: array
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,
@@ -374,8 +407,8 @@ spec:
format: int32
type: integer
required:
- - weight
- podAffinityTerm
+ - weight
type: object
type: array
requiredDuringSchedulingIgnoredDuringExecution:
@@ -398,10 +431,8 @@ spec:
is running
properties:
labelSelector:
- description: A label selector is a label query over a
- set of resources. The result of matchLabels and matchExpressions
- are ANDed. An empty label selector matches all objects.
- A null label selector matches no objects.
+ description: A label query over a set of resources, in
+ this case pods.
properties:
matchExpressions:
description: matchExpressions is a list of label selector
@@ -436,6 +467,8 @@ spec:
type: object
type: array
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
@@ -465,8 +498,9 @@ spec:
type: array
type: object
podAntiAffinity:
- description: Pod anti affinity is a group of inter pod anti affinity
- scheduling rules.
+ 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
@@ -485,20 +519,12 @@ spec:
fields are added per-node to find the most preferred node(s)
properties:
podAffinityTerm:
- 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: Required. A pod affinity term, associated
+ with the corresponding weight.
properties:
labelSelector:
- description: A label selector is a label query over
- a set of resources. The result of matchLabels and
- matchExpressions are ANDed. An empty label selector
- matches all objects. A null label selector matches
- no objects.
+ description: A label query over a set of resources,
+ in this case pods.
properties:
matchExpressions:
description: matchExpressions is a list of label
@@ -534,6 +560,8 @@ spec:
type: object
type: array
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,
@@ -567,8 +595,8 @@ spec:
format: int32
type: integer
required:
- - weight
- podAffinityTerm
+ - weight
type: object
type: array
requiredDuringSchedulingIgnoredDuringExecution:
@@ -591,10 +619,8 @@ spec:
is running
properties:
labelSelector:
- description: A label selector is a label query over a
- set of resources. The result of matchLabels and matchExpressions
- are ANDed. An empty label selector matches all objects.
- A null label selector matches no objects.
+ description: A label query over a set of resources, in
+ this case pods.
properties:
matchExpressions:
description: matchExpressions is a list of label selector
@@ -629,6 +655,8 @@ spec:
type: object
type: array
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
@@ -659,8 +687,7 @@ spec:
type: object
type: object
alerting:
- description: AlertingSpec defines parameters for alerting configuration
- of Prometheus servers.
+ description: Define details regarding alerting.
properties:
alertmanagers:
description: AlertmanagerEndpoints Prometheus should fire alerts
@@ -670,6 +697,10 @@ spec:
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".
+ type: string
bearerTokenFile:
description: BearerTokenFile to read from filesystem to use
when authenticating to Alertmanager.
@@ -685,20 +716,112 @@ spec:
type: string
port:
anyOf:
- - type: string
- type: integer
+ - type: string
+ description: Port the Alertmanager API is exposed on.
+ x-kubernetes-int-or-string: true
scheme:
description: Scheme to use when firing alerts.
type: string
tlsConfig:
- description: TLSConfig specifies TLS configuration parameters.
+ description: TLS Config to use for alertmanager connection.
properties:
- ca: {}
+ ca:
+ description: Stuct containing the CA cert to use for the
+ targets.
+ properties:
+ configMap:
+ 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?'
+ type: string
+ optional:
+ description: Specify whether the ConfigMap or
+ its key must be defined
+ type: boolean
+ required:
+ - key
+ type: object
+ secret:
+ 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.
+ type: string
+ name:
+ description: 'Name of the referent. More info:
+ https://kubernetes.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
+ type: boolean
+ required:
+ - key
+ type: object
+ type: object
caFile:
description: Path to the CA cert in the Prometheus container
to use for the targets.
type: string
- cert: {}
+ cert:
+ description: Struct containing the client cert file for
+ the targets.
+ properties:
+ configMap:
+ 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?'
+ type: string
+ optional:
+ description: Specify whether the ConfigMap or
+ its key must be defined
+ type: boolean
+ required:
+ - key
+ type: object
+ secret:
+ 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.
+ type: string
+ name:
+ description: 'Name of the referent. More info:
+ https://kubernetes.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
+ type: boolean
+ required:
+ - key
+ type: object
+ type: object
certFile:
description: Path to the client cert file in the Prometheus
container for the targets.
@@ -711,14 +834,17 @@ spec:
container for the targets.
type: string
keySecret:
- description: SecretKeySelector selects a key of a Secret.
+ 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.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -732,8 +858,8 @@ spec:
type: string
type: object
required:
- - namespace
- name
+ - namespace
- port
type: object
type: array
@@ -741,22 +867,26 @@ spec:
- alertmanagers
type: object
apiserverConfig:
- description: 'APIServerConfig defines a host and auth methods to access
- apiserver. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#kubernetes_sd_config'
+ 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:
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
properties:
password:
- description: SecretKeySelector selects a key of a Secret.
+ 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.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -766,14 +896,16 @@ spec:
- key
type: object
username:
- description: SecretKeySelector selects a key of a Secret.
+ 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.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -794,14 +926,91 @@ spec:
or IP followed by an optional port number
type: string
tlsConfig:
- description: TLSConfig specifies TLS configuration parameters.
+ description: TLS Config to use for accessing apiserver.
properties:
- ca: {}
+ ca:
+ description: Stuct containing the CA cert to use for the targets.
+ properties:
+ configMap:
+ 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?'
+ type: string
+ optional:
+ description: Specify whether the ConfigMap or its key
+ must be defined
+ type: boolean
+ required:
+ - key
+ type: object
+ secret:
+ 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.
+ type: string
+ name:
+ description: 'Name of the referent. More info: https://kubernetes.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
+ type: boolean
+ required:
+ - key
+ type: object
+ type: object
caFile:
description: Path to the CA cert in the Prometheus container
to use for the targets.
type: string
- cert: {}
+ cert:
+ description: Struct containing the client cert file for the
+ targets.
+ properties:
+ configMap:
+ 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?'
+ type: string
+ optional:
+ description: Specify whether the ConfigMap or its key
+ must be defined
+ type: boolean
+ required:
+ - key
+ type: object
+ secret:
+ 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.
+ type: string
+ name:
+ description: 'Name of the referent. More info: https://kubernetes.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
+ type: boolean
+ required:
+ - key
+ type: object
+ type: object
certFile:
description: Path to the client cert file in the Prometheus
container for the targets.
@@ -814,14 +1023,15 @@ spec:
for the targets.
type: string
keySecret:
- description: SecretKeySelector selects a key of a Secret.
+ 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.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -837,7 +1047,14 @@ spec:
required:
- host
type: object
- arbitraryFSAccessThroughSMs: {}
+ 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.
+ properties:
+ deny:
+ type: boolean
+ type: object
baseImage:
description: Base image to use for a Prometheus deployment.
type: string
@@ -909,17 +1126,19 @@ spec:
exists or not. Defaults to "".'
type: string
valueFrom:
- description: EnvVarSource represents a source for the value
- of an EnvVar.
+ description: Source for the environment variable's value.
+ Cannot be used if value is not empty.
properties:
configMapKeyRef:
- description: Selects a key from a ConfigMap.
+ description: Selects a key of a ConfigMap.
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'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -929,8 +1148,10 @@ spec:
- key
type: object
fieldRef:
- description: ObjectFieldSelector selects an APIVersioned
- field of an object.
+ description: 'Selects a field of the pod: supports metadata.name,
+ metadata.namespace, metadata.labels, metadata.annotations,
+ spec.nodeName, spec.serviceAccountName, status.hostIP,
+ status.podIP.'
properties:
apiVersion:
description: Version of the schema the FieldPath
@@ -944,14 +1165,19 @@ spec:
- fieldPath
type: object
resourceFieldRef:
- description: ResourceFieldSelector represents container
- resources (cpu, memory) and their output format
+ 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'
type: string
- divisor: {}
+ divisor:
+ description: Specifies the output format of the
+ exposed resources, defaults to "1"
+ type: string
resource:
description: 'Required: resource to select'
type: string
@@ -959,14 +1185,17 @@ spec:
- resource
type: object
secretKeyRef:
- description: SecretKeySelector selects a key of a Secret.
+ 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.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -993,13 +1222,11 @@ spec:
ConfigMaps
properties:
configMapRef:
- description: |-
- ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.
-
- The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.
+ 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'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -1010,13 +1237,11 @@ spec:
in the ConfigMap. Must be a C_IDENTIFIER.
type: string
secretRef:
- description: |-
- SecretEnvSource selects a Secret to populate the environment variables with.
-
- The contents of the target Secret's Data field will represent the key-value pairs as environment variables.
+ 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'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -1036,19 +1261,19 @@ spec:
otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
- description: Lifecycle describes actions that the management system
- should take in response to container lifecycle events. For the
- PostStart and PreStop lifecycle handlers, management of the
- container blocks until the action is complete, unless the container
- process fails, in which case the handler is aborted.
+ description: Actions that the management system should take in
+ response to container lifecycle events. Cannot be updated.
properties:
postStart:
- description: Handler defines a specific action that should
- be taken
+ 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: ExecAction describes a "run in container"
- action.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
command:
description: Command is the command line to execute
@@ -1064,8 +1289,7 @@ spec:
type: array
type: object
httpGet:
- description: HTTPGetAction describes an action based on
- HTTP Get requests.
+ description: HTTPGet specifies the http request to perform.
properties:
host:
description: Host name to connect to, defaults to
@@ -1095,8 +1319,12 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
scheme:
description: Scheme to use for connecting to the host.
Defaults to HTTP.
@@ -1105,8 +1333,9 @@ spec:
- port
type: object
tcpSocket:
- description: TCPSocketAction describes an action based
- on opening a socket
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO: implement
+ a realistic TCP lifecycle hook'
properties:
host:
description: 'Optional: Host name to connect to, defaults
@@ -1114,19 +1343,33 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
preStop:
- description: Handler defines a specific action that should
- be taken
+ 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 reason for termination is passed to
+ the handler. The Pod''s termination grace period countdown
+ begins before the PreStop hooked is executed. Regardless
+ of the outcome of the handler, the container will eventually
+ terminate within the Pod''s termination grace period. 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: ExecAction describes a "run in container"
- action.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
command:
description: Command is the command line to execute
@@ -1142,8 +1385,7 @@ spec:
type: array
type: object
httpGet:
- description: HTTPGetAction describes an action based on
- HTTP Get requests.
+ description: HTTPGet specifies the http request to perform.
properties:
host:
description: Host name to connect to, defaults to
@@ -1173,8 +1415,12 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
scheme:
description: Scheme to use for connecting to the host.
Defaults to HTTP.
@@ -1183,8 +1429,9 @@ spec:
- port
type: object
tcpSocket:
- description: TCPSocketAction describes an action based
- on opening a socket
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO: implement
+ a realistic TCP lifecycle hook'
properties:
host:
description: 'Optional: Host name to connect to, defaults
@@ -1192,20 +1439,25 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
type: object
livenessProbe:
- description: Probe describes a health check to be performed against
- a container to determine whether it is alive or ready to receive
- traffic.
+ 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: ExecAction describes a "run in container" action.
+ description: One and only one of the following should be specified.
+ Exec specifies the action to take.
properties:
command:
description: Command is the command line to execute inside
@@ -1227,8 +1479,7 @@ spec:
format: int32
type: integer
httpGet:
- description: HTTPGetAction describes an action based on HTTP
- Get requests.
+ description: HTTPGet specifies the http request to perform.
properties:
host:
description: Host name to connect to, defaults to the
@@ -1258,8 +1509,12 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
scheme:
description: Scheme to use for connecting to the host.
Defaults to HTTP.
@@ -1285,8 +1540,9 @@ spec:
format: int32
type: integer
tcpSocket:
- description: TCPSocketAction describes an action based on
- opening a socket
+ description: 'TCPSocket specifies an action involving a TCP
+ port. TCP hooks not yet supported TODO: implement a realistic
+ TCP lifecycle hook'
properties:
host:
description: 'Optional: Host name to connect to, defaults
@@ -1294,8 +1550,12 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
required:
- port
type: object
@@ -1353,12 +1613,13 @@ spec:
type: object
type: array
readinessProbe:
- description: Probe describes a health check to be performed against
- a container to determine whether it is alive or ready to receive
- traffic.
+ 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: ExecAction describes a "run in container" action.
+ description: One and only one of the following should be specified.
+ Exec specifies the action to take.
properties:
command:
description: Command is the command line to execute inside
@@ -1380,8 +1641,7 @@ spec:
format: int32
type: integer
httpGet:
- description: HTTPGetAction describes an action based on HTTP
- Get requests.
+ description: HTTPGet specifies the http request to perform.
properties:
host:
description: Host name to connect to, defaults to the
@@ -1411,8 +1671,12 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
scheme:
description: Scheme to use for connecting to the host.
Defaults to HTTP.
@@ -1438,8 +1702,9 @@ spec:
format: int32
type: integer
tcpSocket:
- description: TCPSocketAction describes an action based on
- opening a socket
+ description: 'TCPSocket specifies an action involving a TCP
+ port. TCP hooks not yet supported TODO: implement a realistic
+ TCP lifecycle hook'
properties:
host:
description: 'Optional: Host name to connect to, defaults
@@ -1447,8 +1712,12 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
required:
- port
type: object
@@ -1460,14 +1729,18 @@ spec:
type: integer
type: object
resources:
- description: ResourceRequirements describes the compute resource
- requirements.
+ description: 'Compute Resources required by this container. Cannot
+ be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
properties:
limits:
+ additionalProperties:
+ type: string
description: 'Limits describes the maximum amount of compute
resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
+ additionalProperties:
+ type: string
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
@@ -1475,10 +1748,9 @@ spec:
type: object
type: object
securityContext:
- description: SecurityContext holds security configuration that
- will be applied to a container. Some fields are present in both
- SecurityContext and PodSecurityContext. When both are set,
- the values in SecurityContext take precedence.
+ description: 'Security options the pod should run with. More info:
+ https://kubernetes.io/docs/concepts/policy/security-context/
+ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
properties:
allowPrivilegeEscalation:
description: 'AllowPrivilegeEscalation controls whether a
@@ -1489,17 +1761,22 @@ spec:
2) has CAP_SYS_ADMIN'
type: boolean
capabilities:
- description: Adds and removes POSIX capabilities from running
- containers.
+ description: The capabilities to add/drop when running containers.
+ Defaults to the default set of capabilities granted by the
+ container runtime.
properties:
add:
description: Added capabilities
items:
+ description: Capability represent POSIX capabilities
+ type
type: string
type: array
drop:
description: Removed capabilities
items:
+ description: Capability represent POSIX capabilities
+ type
type: string
type: array
type: object
@@ -1545,8 +1822,12 @@ spec:
format: int64
type: integer
seLinuxOptions:
- description: SELinuxOptions are the labels to be applied to
- the container
+ 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.
properties:
level:
description: Level is SELinux level label that applies
@@ -1566,8 +1847,10 @@ spec:
type: string
type: object
windowsOptions:
- description: WindowsSecurityContextOptions contain Windows-specific
- options and credentials.
+ 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.
properties:
gmsaCredentialSpec:
description: GMSACredentialSpec is where the GMSA admission
@@ -1596,12 +1879,19 @@ spec:
type: object
type: object
startupProbe:
- description: Probe describes a health check to be performed against
- a container to determine whether it is alive or ready to receive
- traffic.
+ 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. This is an alpha feature enabled by the StartupProbe
+ feature flag. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
- description: ExecAction describes a "run in container" action.
+ description: One and only one of the following should be specified.
+ Exec specifies the action to take.
properties:
command:
description: Command is the command line to execute inside
@@ -1623,8 +1913,7 @@ spec:
format: int32
type: integer
httpGet:
- description: HTTPGetAction describes an action based on HTTP
- Get requests.
+ description: HTTPGet specifies the http request to perform.
properties:
host:
description: Host name to connect to, defaults to the
@@ -1654,8 +1943,12 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
scheme:
description: Scheme to use for connecting to the host.
Defaults to HTTP.
@@ -1681,8 +1974,9 @@ spec:
format: int32
type: integer
tcpSocket:
- description: TCPSocketAction describes an action based on
- opening a socket
+ description: 'TCPSocket specifies an action involving a TCP
+ port. TCP hooks not yet supported TODO: implement a realistic
+ TCP lifecycle hook'
properties:
host:
description: 'Optional: Host name to connect to, defaults
@@ -1690,8 +1984,12 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
required:
- port
type: object
@@ -1757,8 +2055,8 @@ spec:
in the pod
type: string
required:
- - name
- devicePath
+ - name
type: object
type: array
volumeMounts:
@@ -1798,8 +2096,8 @@ spec:
exclusive. This field is beta in 1.15.
type: string
required:
- - name
- mountPath
+ - name
type: object
type: array
workingDir:
@@ -1811,6 +2109,9 @@ spec:
- name
type: object
type: array
+ disableCompaction:
+ 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
@@ -1828,6 +2129,8 @@ spec:
description: Interval between consecutive evaluations.
type: string
externalLabels:
+ additionalProperties:
+ type: string
description: The labels to add to any time series or alerts when communicating
with external systems (federation, remote storage, Alertmanager).
type: object
@@ -1857,7 +2160,8 @@ spec:
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'
+ description: 'Name of the 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
type: array
@@ -1921,17 +2225,19 @@ spec:
exists or not. Defaults to "".'
type: string
valueFrom:
- description: EnvVarSource represents a source for the value
- of an EnvVar.
+ description: Source for the environment variable's value.
+ Cannot be used if value is not empty.
properties:
configMapKeyRef:
- description: Selects a key from a ConfigMap.
+ description: Selects a key of a ConfigMap.
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'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -1941,8 +2247,10 @@ spec:
- key
type: object
fieldRef:
- description: ObjectFieldSelector selects an APIVersioned
- field of an object.
+ description: 'Selects a field of the pod: supports metadata.name,
+ metadata.namespace, metadata.labels, metadata.annotations,
+ spec.nodeName, spec.serviceAccountName, status.hostIP,
+ status.podIP.'
properties:
apiVersion:
description: Version of the schema the FieldPath
@@ -1956,14 +2264,19 @@ spec:
- fieldPath
type: object
resourceFieldRef:
- description: ResourceFieldSelector represents container
- resources (cpu, memory) and their output format
+ 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'
type: string
- divisor: {}
+ divisor:
+ description: Specifies the output format of the
+ exposed resources, defaults to "1"
+ type: string
resource:
description: 'Required: resource to select'
type: string
@@ -1971,14 +2284,17 @@ spec:
- resource
type: object
secretKeyRef:
- description: SecretKeySelector selects a key of a Secret.
+ 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.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -2005,13 +2321,11 @@ spec:
ConfigMaps
properties:
configMapRef:
- description: |-
- ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.
-
- The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.
+ 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'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -2022,13 +2336,11 @@ spec:
in the ConfigMap. Must be a C_IDENTIFIER.
type: string
secretRef:
- description: |-
- SecretEnvSource selects a Secret to populate the environment variables with.
-
- The contents of the target Secret's Data field will represent the key-value pairs as environment variables.
+ 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'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -2048,19 +2360,19 @@ spec:
otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
- description: Lifecycle describes actions that the management system
- should take in response to container lifecycle events. For the
- PostStart and PreStop lifecycle handlers, management of the
- container blocks until the action is complete, unless the container
- process fails, in which case the handler is aborted.
+ description: Actions that the management system should take in
+ response to container lifecycle events. Cannot be updated.
properties:
postStart:
- description: Handler defines a specific action that should
- be taken
+ 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: ExecAction describes a "run in container"
- action.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
command:
description: Command is the command line to execute
@@ -2076,8 +2388,7 @@ spec:
type: array
type: object
httpGet:
- description: HTTPGetAction describes an action based on
- HTTP Get requests.
+ description: HTTPGet specifies the http request to perform.
properties:
host:
description: Host name to connect to, defaults to
@@ -2107,8 +2418,12 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
scheme:
description: Scheme to use for connecting to the host.
Defaults to HTTP.
@@ -2117,8 +2432,9 @@ spec:
- port
type: object
tcpSocket:
- description: TCPSocketAction describes an action based
- on opening a socket
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO: implement
+ a realistic TCP lifecycle hook'
properties:
host:
description: 'Optional: Host name to connect to, defaults
@@ -2126,19 +2442,33 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
preStop:
- description: Handler defines a specific action that should
- be taken
+ 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 reason for termination is passed to
+ the handler. The Pod''s termination grace period countdown
+ begins before the PreStop hooked is executed. Regardless
+ of the outcome of the handler, the container will eventually
+ terminate within the Pod''s termination grace period. 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: ExecAction describes a "run in container"
- action.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
command:
description: Command is the command line to execute
@@ -2154,8 +2484,7 @@ spec:
type: array
type: object
httpGet:
- description: HTTPGetAction describes an action based on
- HTTP Get requests.
+ description: HTTPGet specifies the http request to perform.
properties:
host:
description: Host name to connect to, defaults to
@@ -2185,8 +2514,12 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
scheme:
description: Scheme to use for connecting to the host.
Defaults to HTTP.
@@ -2195,8 +2528,9 @@ spec:
- port
type: object
tcpSocket:
- description: TCPSocketAction describes an action based
- on opening a socket
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO: implement
+ a realistic TCP lifecycle hook'
properties:
host:
description: 'Optional: Host name to connect to, defaults
@@ -2204,20 +2538,25 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
type: object
livenessProbe:
- description: Probe describes a health check to be performed against
- a container to determine whether it is alive or ready to receive
- traffic.
+ 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: ExecAction describes a "run in container" action.
+ description: One and only one of the following should be specified.
+ Exec specifies the action to take.
properties:
command:
description: Command is the command line to execute inside
@@ -2239,8 +2578,7 @@ spec:
format: int32
type: integer
httpGet:
- description: HTTPGetAction describes an action based on HTTP
- Get requests.
+ description: HTTPGet specifies the http request to perform.
properties:
host:
description: Host name to connect to, defaults to the
@@ -2270,8 +2608,12 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
scheme:
description: Scheme to use for connecting to the host.
Defaults to HTTP.
@@ -2297,8 +2639,9 @@ spec:
format: int32
type: integer
tcpSocket:
- description: TCPSocketAction describes an action based on
- opening a socket
+ description: 'TCPSocket specifies an action involving a TCP
+ port. TCP hooks not yet supported TODO: implement a realistic
+ TCP lifecycle hook'
properties:
host:
description: 'Optional: Host name to connect to, defaults
@@ -2306,8 +2649,12 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
required:
- port
type: object
@@ -2365,12 +2712,13 @@ spec:
type: object
type: array
readinessProbe:
- description: Probe describes a health check to be performed against
- a container to determine whether it is alive or ready to receive
- traffic.
+ 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: ExecAction describes a "run in container" action.
+ description: One and only one of the following should be specified.
+ Exec specifies the action to take.
properties:
command:
description: Command is the command line to execute inside
@@ -2392,8 +2740,7 @@ spec:
format: int32
type: integer
httpGet:
- description: HTTPGetAction describes an action based on HTTP
- Get requests.
+ description: HTTPGet specifies the http request to perform.
properties:
host:
description: Host name to connect to, defaults to the
@@ -2423,8 +2770,12 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
scheme:
description: Scheme to use for connecting to the host.
Defaults to HTTP.
@@ -2450,8 +2801,9 @@ spec:
format: int32
type: integer
tcpSocket:
- description: TCPSocketAction describes an action based on
- opening a socket
+ description: 'TCPSocket specifies an action involving a TCP
+ port. TCP hooks not yet supported TODO: implement a realistic
+ TCP lifecycle hook'
properties:
host:
description: 'Optional: Host name to connect to, defaults
@@ -2459,8 +2811,12 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
required:
- port
type: object
@@ -2472,14 +2828,18 @@ spec:
type: integer
type: object
resources:
- description: ResourceRequirements describes the compute resource
- requirements.
+ description: 'Compute Resources required by this container. Cannot
+ be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
properties:
limits:
+ additionalProperties:
+ type: string
description: 'Limits describes the maximum amount of compute
resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
+ additionalProperties:
+ type: string
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
@@ -2487,10 +2847,9 @@ spec:
type: object
type: object
securityContext:
- description: SecurityContext holds security configuration that
- will be applied to a container. Some fields are present in both
- SecurityContext and PodSecurityContext. When both are set,
- the values in SecurityContext take precedence.
+ description: 'Security options the pod should run with. More info:
+ https://kubernetes.io/docs/concepts/policy/security-context/
+ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
properties:
allowPrivilegeEscalation:
description: 'AllowPrivilegeEscalation controls whether a
@@ -2501,17 +2860,22 @@ spec:
2) has CAP_SYS_ADMIN'
type: boolean
capabilities:
- description: Adds and removes POSIX capabilities from running
- containers.
+ description: The capabilities to add/drop when running containers.
+ Defaults to the default set of capabilities granted by the
+ container runtime.
properties:
add:
description: Added capabilities
items:
+ description: Capability represent POSIX capabilities
+ type
type: string
type: array
drop:
description: Removed capabilities
items:
+ description: Capability represent POSIX capabilities
+ type
type: string
type: array
type: object
@@ -2557,8 +2921,12 @@ spec:
format: int64
type: integer
seLinuxOptions:
- description: SELinuxOptions are the labels to be applied to
- the container
+ 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.
properties:
level:
description: Level is SELinux level label that applies
@@ -2578,8 +2946,10 @@ spec:
type: string
type: object
windowsOptions:
- description: WindowsSecurityContextOptions contain Windows-specific
- options and credentials.
+ 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.
properties:
gmsaCredentialSpec:
description: GMSACredentialSpec is where the GMSA admission
@@ -2608,12 +2978,19 @@ spec:
type: object
type: object
startupProbe:
- description: Probe describes a health check to be performed against
- a container to determine whether it is alive or ready to receive
- traffic.
+ 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. This is an alpha feature enabled by the StartupProbe
+ feature flag. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
- description: ExecAction describes a "run in container" action.
+ description: One and only one of the following should be specified.
+ Exec specifies the action to take.
properties:
command:
description: Command is the command line to execute inside
@@ -2635,8 +3012,7 @@ spec:
format: int32
type: integer
httpGet:
- description: HTTPGetAction describes an action based on HTTP
- Get requests.
+ description: HTTPGet specifies the http request to perform.
properties:
host:
description: Host name to connect to, defaults to the
@@ -2666,8 +3042,12 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
scheme:
description: Scheme to use for connecting to the host.
Defaults to HTTP.
@@ -2693,8 +3073,9 @@ spec:
format: int32
type: integer
tcpSocket:
- description: TCPSocketAction describes an action based on
- opening a socket
+ description: 'TCPSocket specifies an action involving a TCP
+ port. TCP hooks not yet supported TODO: implement a realistic
+ TCP lifecycle hook'
properties:
host:
description: 'Optional: Host name to connect to, defaults
@@ -2702,8 +3083,12 @@ spec:
type: string
port:
anyOf:
- - type: string
- 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.
+ x-kubernetes-int-or-string: true
required:
- port
type: object
@@ -2769,8 +3154,8 @@ spec:
in the pod
type: string
required:
- - name
- devicePath
+ - name
type: object
type: array
volumeMounts:
@@ -2810,8 +3195,8 @@ spec:
exclusive. This field is beta in 1.15.
type: string
required:
- - name
- mountPath
+ - name
type: object
type: array
workingDir:
@@ -2834,6 +3219,8 @@ spec:
description: Log level for Prometheus to be configured with.
type: string
nodeSelector:
+ additionalProperties:
+ type: string
description: Define which Nodes the Pods are scheduled on.
type: object
overrideHonorLabels:
@@ -2850,196 +3237,13 @@ spec:
for deletion will be performed on the underlying objects.
type: boolean
podMetadata:
- description: ObjectMeta is metadata that all persisted resources must
- have, which includes all objects users must create.
- properties:
- 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
- clusterName:
- description: The name of the cluster which the object belongs to.
- This is used to distinguish resources with same name and namespace
- in different clusters. This field is not set anywhere right now
- and apiserver is going to ignore it if set in create or update
- request.
- type: string
- creationTimestamp:
- description: Time is a wrapper around time.Time which supports correct
- marshaling to YAML and JSON. Wrappers are provided for many of
- the factory methods that the time package offers.
- format: date-time
- type: string
- deletionGracePeriodSeconds:
- description: Number of seconds allowed for this object to gracefully
- terminate before it will be removed from the system. Only set
- when deletionTimestamp is also set. May only be shortened. Read-only.
- format: int64
- type: integer
- deletionTimestamp:
- description: Time is a wrapper around time.Time which supports correct
- marshaling to YAML and JSON. Wrappers are provided for many of
- the factory methods that the time package offers.
- format: date-time
- type: string
- finalizers:
- description: Must be empty before the object is deleted from the
- registry. Each entry is an identifier for the responsible component
- that will remove the entry from the list. If the deletionTimestamp
- of the object is non-nil, entries in this list can only be removed.
- items:
- type: string
- type: array
- generateName:
- description: |-
- GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
-
- If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
-
- Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
- type: string
- generation:
- description: A sequence number representing a specific generation
- of the desired state. Populated by the system. Read-only.
- format: int64
- type: integer
- 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
- managedFields:
- description: ManagedFields maps workflow-id and version to the set
- of fields that are managed by that workflow. This is mostly for
- internal housekeeping, and users typically shouldn't need to set
- or understand this field. A workflow can be the user's name, a
- controller's name, or the name of a specific apply path like "ci-cd".
- The set of fields is always in the version that the workflow used
- when modifying the object.
- items:
- description: ManagedFieldsEntry is a workflow-id, a FieldSet and
- the group version of the resource that the fieldset applies
- to.
- properties:
- apiVersion:
- description: APIVersion defines the version of this resource
- that this field set applies to. The format is "group/version"
- just like the top-level APIVersion field. It is necessary
- to track the version of a field set because it cannot be
- automatically converted.
- type: string
- fieldsType:
- description: 'FieldsType is the discriminator for the different
- fields format and version. There is currently only one possible
- value: "FieldsV1"'
- type: string
- fieldsV1:
- description: |-
- FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.
-
- Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.
-
- The exact format is defined in sigs.k8s.io/structured-merge-diff
- type: object
- manager:
- description: Manager is an identifier of the workflow managing
- these fields.
- type: string
- operation:
- description: Operation is the type of operation which lead
- to this ManagedFieldsEntry being created. The only valid
- values for this field are 'Apply' and 'Update'.
- type: string
- time:
- description: Time is a wrapper around time.Time which supports
- correct marshaling to YAML and JSON. Wrappers are provided
- for many of the factory methods that the time package offers.
- format: date-time
- type: string
- type: object
- type: array
- 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'
- type: string
- namespace:
- description: |-
- Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
-
- Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
- type: string
- ownerReferences:
- description: List of objects depended by this object. If ALL objects
- in the list have been deleted, this object will be garbage collected.
- If this object is managed by a controller, then an entry in this
- list will point to this controller, with the controller field
- set to true. There cannot be more than one managing controller.
- items:
- description: OwnerReference contains enough information to let
- you identify an owning object. An owning object must be in the
- same namespace as the dependent, or be cluster-scoped, so there
- is no namespace field.
- properties:
- apiVersion:
- description: API version of the referent.
- type: string
- blockOwnerDeletion:
- description: If true, AND if the owner has the "foregroundDeletion"
- finalizer, then the owner cannot be deleted from the key-value
- store until this reference is removed. Defaults to false.
- To set this field, a user needs "delete" permission of the
- owner, otherwise 422 (Unprocessable Entity) will be returned.
- type: boolean
- controller:
- description: If true, this reference points to the managing
- controller.
- type: boolean
- kind:
- description: 'Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
- type: string
- name:
- description: 'Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names'
- type: string
- uid:
- description: 'UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids'
- type: string
- required:
- - apiVersion
- - kind
- - name
- - uid
- type: object
- type: array
- resourceVersion:
- description: |-
- An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
-
- Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
- type: string
- selfLink:
- description: |-
- SelfLink is a URL representing this object. Populated by the system. Read-only.
-
- DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.
- type: string
- uid:
- description: |-
- UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
-
- Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
- type: string
+ description: 'Standard object’s metadata. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata
+ Metadata Labels and Annotations gets propagated to the prometheus
+ pods.'
type: object
podMonitorNamespaceSelector:
- description: A label selector is a label query over a set of resources.
- The result of matchLabels and matchExpressions are ANDed. An empty
- label selector matches all objects. A null label selector matches
- no objects.
+ description: Namespaces to be selected for PodMonitor discovery. If
+ nil, only check own namespace.
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements.
@@ -3072,6 +3276,8 @@ spec:
type: object
type: array
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
@@ -3080,10 +3286,7 @@ spec:
type: object
type: object
podMonitorSelector:
- description: A label selector is a label query over a set of resources.
- The result of matchLabels and matchExpressions are ANDed. An empty
- label selector matches all objects. A null label selector matches
- no objects.
+ description: '*Experimental* PodMonitors to be selected for target discovery.'
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements.
@@ -3116,6 +3319,8 @@ spec:
type: object
type: array
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
@@ -3166,18 +3371,19 @@ spec:
for prometheus.
properties:
basicAuth:
- description: 'BasicAuth allow an endpoint to authenticate over
- basic authentication More info: https://prometheus.io/docs/operating/configuration/#endpoints'
+ description: BasicAuth for the URL.
properties:
password:
- description: SecretKeySelector selects a key of a Secret.
+ 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.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -3187,14 +3393,16 @@ spec:
- key
type: object
username:
- description: SecretKeySelector selects a key of a Secret.
+ 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.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -3221,18 +3429,103 @@ spec:
description: Timeout for requests to the remote read endpoint.
type: string
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.
type: object
tlsConfig:
- description: TLSConfig specifies TLS configuration parameters.
+ description: TLS Config to use for remote read.
properties:
- ca: {}
+ ca:
+ description: Stuct containing the CA cert to use for the targets.
+ properties:
+ configMap:
+ 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?'
+ type: string
+ optional:
+ description: Specify whether the ConfigMap or its
+ key must be defined
+ type: boolean
+ required:
+ - key
+ type: object
+ secret:
+ 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.
+ type: string
+ name:
+ description: 'Name of the referent. More info: https://kubernetes.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
+ type: boolean
+ required:
+ - key
+ type: object
+ type: object
caFile:
description: Path to the CA cert in the Prometheus container
to use for the targets.
type: string
- cert: {}
+ cert:
+ description: Struct containing the client cert file for the
+ targets.
+ properties:
+ configMap:
+ 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?'
+ type: string
+ optional:
+ description: Specify whether the ConfigMap or its
+ key must be defined
+ type: boolean
+ required:
+ - key
+ type: object
+ secret:
+ 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.
+ type: string
+ name:
+ description: 'Name of the referent. More info: https://kubernetes.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
+ type: boolean
+ required:
+ - key
+ type: object
+ type: object
certFile:
description: Path to the client cert file in the Prometheus
container for the targets.
@@ -3245,14 +3538,16 @@ spec:
container for the targets.
type: string
keySecret:
- description: SecretKeySelector selects a key of a Secret.
+ 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.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -3280,18 +3575,19 @@ spec:
for prometheus.
properties:
basicAuth:
- description: 'BasicAuth allow an endpoint to authenticate over
- basic authentication More info: https://prometheus.io/docs/operating/configuration/#endpoints'
+ description: BasicAuth for the URL.
properties:
password:
- description: SecretKeySelector selects a key of a Secret.
+ 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.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -3301,14 +3597,16 @@ spec:
- key
type: object
username:
- description: SecretKeySelector selects a key of a Secret.
+ 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.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -3328,9 +3626,8 @@ spec:
description: Optional ProxyURL
type: string
queueConfig:
- description: QueueConfig allows the tuning of remote_write queue_config
- parameters. This object is referenced in the RemoteWriteSpec
- object.
+ description: QueueConfig allows tuning of the remote write queue
+ parameters.
properties:
batchSendDeadline:
description: BatchSendDeadline is the maximum time a sample
@@ -3339,7 +3636,6 @@ spec:
capacity:
description: Capacity is the number of samples to buffer per
shard before we start dropping them.
- format: int32
type: integer
maxBackoff:
description: MaxBackoff is the maximum retry delay.
@@ -3347,17 +3643,14 @@ spec:
maxRetries:
description: MaxRetries is the maximum number of times to
retry a batch on recoverable errors.
- format: int32
type: integer
maxSamplesPerSend:
description: MaxSamplesPerSend is the maximum number of samples
per send.
- format: int32
type: integer
maxShards:
description: MaxShards is the maximum number of shards, i.e.
amount of concurrency.
- format: int32
type: integer
minBackoff:
description: MinBackoff is the initial retry delay. Gets doubled
@@ -3366,21 +3659,103 @@ spec:
minShards:
description: MinShards is the minimum number of shards, i.e.
amount of concurrency.
- format: int32
type: integer
type: object
remoteTimeout:
description: Timeout for requests to the remote write endpoint.
type: string
tlsConfig:
- description: TLSConfig specifies TLS configuration parameters.
+ description: TLS Config to use for remote write.
properties:
- ca: {}
+ ca:
+ description: Stuct containing the CA cert to use for the targets.
+ properties:
+ configMap:
+ 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?'
+ type: string
+ optional:
+ description: Specify whether the ConfigMap or its
+ key must be defined
+ type: boolean
+ required:
+ - key
+ type: object
+ secret:
+ 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.
+ type: string
+ name:
+ description: 'Name of the referent. More info: https://kubernetes.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
+ type: boolean
+ required:
+ - key
+ type: object
+ type: object
caFile:
description: Path to the CA cert in the Prometheus container
to use for the targets.
type: string
- cert: {}
+ cert:
+ description: Struct containing the client cert file for the
+ targets.
+ properties:
+ configMap:
+ 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?'
+ type: string
+ optional:
+ description: Specify whether the ConfigMap or its
+ key must be defined
+ type: boolean
+ required:
+ - key
+ type: object
+ secret:
+ 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.
+ type: string
+ name:
+ description: 'Name of the referent. More info: https://kubernetes.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
+ type: boolean
+ required:
+ - key
+ type: object
+ type: object
certFile:
description: Path to the client cert file in the Prometheus
container for the targets.
@@ -3393,14 +3768,16 @@ spec:
container for the targets.
type: string
keySecret:
- description: SecretKeySelector selects a key of a Secret.
+ 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.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -3435,7 +3812,7 @@ spec:
type: integer
regex:
description: Regular expression against which the extracted
- value is matched. defailt is '(.*)'
+ value is matched. Default is '(.*)'
type: string
replacement:
description: Replacement value against which a regex replace
@@ -3475,13 +3852,17 @@ spec:
format: int32
type: integer
resources:
- description: ResourceRequirements describes the compute resource requirements.
+ description: Define resources requests and limits for single Pods.
properties:
limits:
+ additionalProperties:
+ type: string
description: 'Limits describes the maximum amount of compute resources
allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
+ additionalProperties:
+ type: string
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
@@ -3504,10 +3885,9 @@ spec:
for use with `kubectl proxy`.
type: string
ruleNamespaceSelector:
- description: A label selector is a label query over a set of resources.
- The result of matchLabels and matchExpressions are ANDed. An empty
- label selector matches all objects. A null label selector matches
- no objects.
+ 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.
@@ -3540,6 +3920,8 @@ spec:
type: object
type: array
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
@@ -3548,10 +3930,12 @@ spec:
type: object
type: object
ruleSelector:
- description: A label selector is a label query over a set of resources.
- The result of matchLabels and matchExpressions are ANDed. An empty
- label selector matches all objects. A null label selector matches
- no objects.
+ description: A selector to select which PrometheusRules to mount for
+ loading alerting 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.
@@ -3584,6 +3968,8 @@ spec:
type: object
type: array
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
@@ -3592,7 +3978,7 @@ spec:
type: object
type: object
rules:
- description: /--rules.*/ command-line arguments
+ description: /--rules.*/ command-line arguments.
properties:
alert:
description: /--rules.alert.*/ command-line arguments
@@ -3623,18 +4009,17 @@ spec:
type: string
type: array
securityContext:
- description: PodSecurityContext holds pod-level security attributes
- and common container settings. Some fields are also present in container.securityContext. Field
- values of container.securityContext take precedence over field values
- of 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:
-
- 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----
-
- If unset, the Kubelet will not modify the ownership and permissions of any volume.
+ 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."
format: int64
type: integer
runAsGroup:
@@ -3662,8 +4047,11 @@ spec:
format: int64
type: integer
seLinuxOptions:
- description: SELinuxOptions are the labels to be applied to the
- container
+ 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.
properties:
level:
description: Level is SELinux level label that applies to the
@@ -3709,8 +4097,10 @@ spec:
type: object
type: array
windowsOptions:
- description: WindowsSecurityContextOptions contain Windows-specific
- options and credentials.
+ 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.
properties:
gmsaCredentialSpec:
description: GMSACredentialSpec is where the GMSA admission
@@ -3741,10 +4131,8 @@ spec:
use to run the Prometheus Pods.
type: string
serviceMonitorNamespaceSelector:
- description: A label selector is a label query over a set of resources.
- The result of matchLabels and matchExpressions are ANDed. An empty
- label selector matches all objects. A null label selector matches
- no objects.
+ description: Namespaces to be selected for ServiceMonitor discovery.
+ If nil, only check own namespace.
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements.
@@ -3777,6 +4165,8 @@ spec:
type: object
type: array
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
@@ -3785,10 +4175,7 @@ spec:
type: object
type: object
serviceMonitorSelector:
- description: A label selector is a label query over a set of resources.
- The result of matchLabels and matchExpressions are ANDed. An empty
- label selector matches all objects. A null label selector matches
- no objects.
+ description: ServiceMonitors to be selected for target discovery.
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements.
@@ -3821,6 +4208,8 @@ spec:
type: object
type: array
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
@@ -3835,25 +4224,30 @@ spec:
if SHA is set.
type: string
storage:
- description: StorageSpec defines the configured storage for a group
- Prometheus servers. If neither `emptyDir` nor `volumeClaimTemplate`
- is specified, then by default an [EmptyDir](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir)
- will be used.
+ description: Storage spec to specify how storage shall be used.
properties:
emptyDir:
- description: Represents an empty directory for a pod. Empty directory
- volumes support ownership management and SELinux relabeling.
+ description: 'EmptyDirVolumeSource to be used by the Prometheus
+ StatefulSets. If specified, used in place of any volumeClaimTemplate.
+ More info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir'
properties:
medium:
description: '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: {}
+ sizeLimit:
+ description: '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'
+ type: string
type: object
volumeClaimTemplate:
- description: PersistentVolumeClaim is a user's request for and claim
- to a persistent volume
+ description: A PVC spec to be used by the Prometheus StatefulSets.
properties:
apiVersion:
description: 'APIVersion defines the versioned schema of this
@@ -3868,206 +4262,11 @@ spec:
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
- description: ObjectMeta is metadata that all persisted resources
- must have, which includes all objects users must create.
- properties:
- 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
- clusterName:
- description: The name of the cluster which the object belongs
- to. This is used to distinguish resources with same name
- and namespace in different clusters. This field is not
- set anywhere right now and apiserver is going to ignore
- it if set in create or update request.
- type: string
- creationTimestamp:
- description: Time is a wrapper around time.Time which supports
- correct marshaling to YAML and JSON. Wrappers are provided
- for many of the factory methods that the time package
- offers.
- format: date-time
- type: string
- deletionGracePeriodSeconds:
- description: Number of seconds allowed for this object to
- gracefully terminate before it will be removed from the
- system. Only set when deletionTimestamp is also set. May
- only be shortened. Read-only.
- format: int64
- type: integer
- deletionTimestamp:
- description: Time is a wrapper around time.Time which supports
- correct marshaling to YAML and JSON. Wrappers are provided
- for many of the factory methods that the time package
- offers.
- format: date-time
- type: string
- finalizers:
- description: Must be empty before the object is deleted
- from the registry. Each entry is an identifier for the
- responsible component that will remove the entry from
- the list. If the deletionTimestamp of the object is non-nil,
- entries in this list can only be removed.
- items:
- type: string
- type: array
- generateName:
- description: |-
- GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
-
- If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
-
- Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
- type: string
- generation:
- description: A sequence number representing a specific generation
- of the desired state. Populated by the system. Read-only.
- format: int64
- type: integer
- 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
- managedFields:
- description: ManagedFields maps workflow-id and version
- to the set of fields that are managed by that workflow.
- This is mostly for internal housekeeping, and users typically
- shouldn't need to set or understand this field. A workflow
- can be the user's name, a controller's name, or the name
- of a specific apply path like "ci-cd". The set of fields
- is always in the version that the workflow used when modifying
- the object.
- items:
- description: ManagedFieldsEntry is a workflow-id, a FieldSet
- and the group version of the resource that the fieldset
- applies to.
- properties:
- apiVersion:
- description: APIVersion defines the version of this
- resource that this field set applies to. The format
- is "group/version" just like the top-level APIVersion
- field. It is necessary to track the version of a
- field set because it cannot be automatically converted.
- type: string
- fieldsType:
- description: 'FieldsType is the discriminator for
- the different fields format and version. There is
- currently only one possible value: "FieldsV1"'
- type: string
- fieldsV1:
- description: |-
- FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.
-
- Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.
-
- The exact format is defined in sigs.k8s.io/structured-merge-diff
- type: object
- manager:
- description: Manager is an identifier of the workflow
- managing these fields.
- type: string
- operation:
- description: Operation is the type of operation which
- lead to this ManagedFieldsEntry being created. The
- only valid values for this field are 'Apply' and
- 'Update'.
- type: string
- time:
- description: Time is a wrapper around time.Time which
- supports correct marshaling to YAML and JSON. Wrappers
- are provided for many of the factory methods that
- the time package offers.
- format: date-time
- type: string
- type: object
- type: array
- 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'
- type: string
- namespace:
- description: |-
- Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
-
- Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
- type: string
- ownerReferences:
- description: List of objects depended by this object. If
- ALL objects in the list have been deleted, this object
- will be garbage collected. If this object is managed by
- a controller, then an entry in this list will point to
- this controller, with the controller field set to true.
- There cannot be more than one managing controller.
- items:
- description: OwnerReference contains enough information
- to let you identify an owning object. An owning object
- must be in the same namespace as the dependent, or be
- cluster-scoped, so there is no namespace field.
- properties:
- apiVersion:
- description: API version of the referent.
- type: string
- blockOwnerDeletion:
- description: If true, AND if the owner has the "foregroundDeletion"
- finalizer, then the owner cannot be deleted from
- the key-value store until this reference is removed.
- Defaults to false. To set this field, a user needs
- "delete" permission of the owner, otherwise 422
- (Unprocessable Entity) will be returned.
- type: boolean
- controller:
- description: If true, this reference points to the
- managing controller.
- type: boolean
- kind:
- description: 'Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
- type: string
- name:
- description: 'Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names'
- type: string
- uid:
- description: 'UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids'
- type: string
- required:
- - apiVersion
- - kind
- - name
- - uid
- type: object
- type: array
- resourceVersion:
- description: |-
- An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
-
- Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
- type: string
- selfLink:
- description: |-
- SelfLink is a URL representing this object. Populated by the system. Read-only.
-
- DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.
- type: string
- uid:
- description: |-
- UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
-
- Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
- type: string
+ description: 'Standard object''s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata'
type: object
spec:
- description: PersistentVolumeClaimSpec describes the common
- attributes of storage devices and allows a Source for provider-specific
- attributes
+ 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
@@ -4076,9 +4275,16 @@ spec:
type: string
type: array
dataSource:
- description: TypedLocalObjectReference contains enough information
- to let you locate the typed referenced object inside the
- same namespace.
+ description: This field requires the VolumeSnapshotDataSource
+ alpha feature gate to be enabled and currently VolumeSnapshot
+ is the only supported data source. If the provisioner
+ can support VolumeSnapshot data source, it will create
+ a new volume and data will be restored to the volume at
+ the same time. If the provisioner does not support VolumeSnapshot
+ data source, volume will not be created and the failure
+ will be reported as an event. In the future, we plan to
+ support more data source types and the behavior of the
+ provisioner may change.
properties:
apiGroup:
description: APIGroup is the group for the resource
@@ -4097,14 +4303,18 @@ spec:
- name
type: object
resources:
- description: ResourceRequirements describes the compute
- resource requirements.
+ description: 'Resources represents the minimum resources
+ the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
properties:
limits:
+ additionalProperties:
+ type: string
description: 'Limits describes the maximum amount of
compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
+ additionalProperties:
+ type: string
description: 'Requests describes the minimum amount
of compute resources required. If Requests is omitted
for a container, it defaults to Limits if that is
@@ -4113,10 +4323,8 @@ spec:
type: object
type: object
selector:
- description: A label selector is a label query over a set
- of resources. The result of matchLabels and matchExpressions
- are ANDed. An empty label selector matches all objects.
- A null label selector matches no objects.
+ description: A label query over volumes to consider for
+ binding.
properties:
matchExpressions:
description: matchExpressions is a list of label selector
@@ -4151,6 +4359,8 @@ spec:
type: object
type: array
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
@@ -4173,8 +4383,8 @@ spec:
type: string
type: object
status:
- description: PersistentVolumeClaimStatus is the current status
- of a persistent volume claim.
+ 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
@@ -4183,6 +4393,8 @@ spec:
type: string
type: array
capacity:
+ additionalProperties:
+ type: string
description: Represents the actual resources of the underlying
volume.
type: object
@@ -4195,17 +4407,12 @@ spec:
about state of pvc
properties:
lastProbeTime:
- description: Time is a wrapper around time.Time which
- supports correct marshaling to YAML and JSON. Wrappers
- are provided for many of the factory methods that
- the time package offers.
+ description: Last time we probed the condition.
format: date-time
type: string
lastTransitionTime:
- description: Time is a wrapper around time.Time which
- supports correct marshaling to YAML and JSON. Wrappers
- are provided for many of the factory methods that
- the time package offers.
+ description: Last time the condition transitioned
+ from one status to another.
format: date-time
type: string
message:
@@ -4222,10 +4429,12 @@ spec:
status:
type: string
type:
+ description: PersistentVolumeClaimConditionType is
+ a valid value of PersistentVolumeClaimCondition.Type
type: string
required:
- - type
- status
+ - type
type: object
type: array
phase:
@@ -4239,8 +4448,11 @@ spec:
to the value of `version`. Version is ignored if Tag is set.
type: string
thanos:
- description: ThanosSpec defines parameters for a Prometheus server within
- a Thanos deployment.
+ 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. \n This is experimental and may change significantly
+ without backward compatibility in any release."
properties:
baseImage:
description: Thanos base image if other than default.
@@ -4256,14 +4468,15 @@ spec:
so that it does not bind against the Pod IP.
type: boolean
objectStorageConfig:
- description: SecretKeySelector selects a key of a Secret.
+ description: ObjectStorageConfig configures object storage in Thanos.
properties:
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'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -4272,14 +4485,18 @@ spec:
- key
type: object
resources:
- description: ResourceRequirements describes the compute resource
- requirements.
+ description: Resources defines the resource requirements for the
+ Thanos sidecar. If not provided, no requests/limits will be set
properties:
limits:
+ additionalProperties:
+ type: string
description: 'Limits describes the maximum amount of compute
resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
+ additionalProperties:
+ type: string
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
@@ -4353,17 +4570,18 @@ spec:
accessed by any container in the pod.
properties:
awsElasticBlockStore:
- description: |-
- Represents a Persistent Disk resource in AWS.
-
- An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.
+ 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: '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'
+ 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: 'The partition in the volume that you want to
@@ -4437,9 +4655,8 @@ spec:
- shareName
type: object
cephfs:
- description: Represents a Ceph Filesystem mount that lasts the
- lifetime of a pod Cephfs volumes do not support ownership management
- or SELinux relabeling.
+ description: CephFS represents a Ceph FS mount on the host that
+ shares a pod's lifetime
properties:
monitors:
description: 'Required: Monitors is a collection of Ceph monitors
@@ -4461,12 +4678,12 @@ spec:
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: LocalObjectReference contains enough information
- to let you locate the referenced object inside the same
- namespace.
+ description: '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'
+ description: 'Name of the 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
user:
@@ -4477,10 +4694,8 @@ spec:
- monitors
type: object
cinder:
- description: Represents a cinder volume resource in Openstack.
- A Cinder volume must exist before mounting to a container. The
- volume must also be in the same region as the kubelet. Cinder
- volumes support ownership management and SELinux relabeling.
+ 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: 'Filesystem type to mount. Must be a filesystem
@@ -4494,12 +4709,12 @@ spec:
info: https://examples.k8s.io/mysql-cinder-pd/README.md'
type: boolean
secretRef:
- description: LocalObjectReference contains enough information
- to let you locate the referenced object inside the same
- namespace.
+ description: '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'
+ description: 'Name of the 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
volumeID:
@@ -4510,10 +4725,8 @@ spec:
- volumeID
type: object
configMap:
- description: |-
- Adapts a ConfigMap into a volume.
-
- The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.
+ description: ConfigMap represents a configMap that should populate
+ this volume
properties:
defaultMode:
description: 'Optional: mode bits to use on created files
@@ -4561,7 +4774,8 @@ spec:
type: object
type: array
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+ description: 'Name of the referent. More info: https://kubernetes.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 keys must
@@ -4569,8 +4783,8 @@ spec:
type: boolean
type: object
csi:
- description: Represents a source location of a volume to mount,
- managed by an external CSI driver
+ description: CSI (Container Storage Interface) represents storage
+ that is handled by an external CSI driver (Alpha feature).
properties:
driver:
description: Driver is the name of the CSI driver that handles
@@ -4584,12 +4798,16 @@ spec:
to apply.
type: string
nodePublishSecretRef:
- description: LocalObjectReference contains enough information
- to let you locate the referenced object inside the same
- namespace.
+ 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'
+ description: 'Name of the 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
readOnly:
@@ -4597,6 +4815,8 @@ spec:
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.
@@ -4605,9 +4825,8 @@ spec:
- driver
type: object
downwardAPI:
- description: DownwardAPIVolumeSource represents a volume containing
- downward API info. Downward API volumes support ownership management
- and SELinux relabeling.
+ description: DownwardAPI represents downward API about the pod
+ that should populate this volume
properties:
defaultMode:
description: 'Optional: mode bits to use on created files
@@ -4625,8 +4844,8 @@ spec:
to create the file containing the pod field
properties:
fieldRef:
- description: ObjectFieldSelector selects an APIVersioned
- field of an object.
+ 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
@@ -4656,14 +4875,18 @@ spec:
''..'''
type: string
resourceFieldRef:
- description: ResourceFieldSelector represents container
- resources (cpu, memory) and their output format
+ 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'
type: string
- divisor: {}
+ divisor:
+ description: Specifies the output format of the
+ exposed resources, defaults to "1"
+ type: string
resource:
description: 'Required: resource to select'
type: string
@@ -4676,8 +4899,8 @@ spec:
type: array
type: object
emptyDir:
- description: Represents an empty directory for a pod. Empty directory
- volumes support ownership management and SELinux relabeling.
+ 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: 'What type of storage medium should back this
@@ -4685,17 +4908,26 @@ spec:
default medium. Must be an empty string (default) or Memory.
More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
type: string
- sizeLimit: {}
+ sizeLimit:
+ description: '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'
+ type: string
type: object
fc:
- description: Represents a Fibre Channel volume. Fibre Channel
- volumes can only be mounted as read/write once. Fibre Channel
- volumes support ownership management and SELinux relabeling.
+ 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: Filesystem type to mount. Must be a filesystem
+ description: '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: 'Optional: FC target lun number'
@@ -4733,6 +4965,8 @@ spec:
script.
type: string
options:
+ additionalProperties:
+ type: string
description: 'Optional: Extra command options if any.'
type: object
readOnly:
@@ -4740,22 +4974,24 @@ spec:
here will force the ReadOnly setting in VolumeMounts.'
type: boolean
secretRef:
- description: LocalObjectReference contains enough information
- to let you locate the referenced object inside the same
- namespace.
+ description: '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'
+ description: 'Name of the 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
required:
- driver
type: object
flocker:
- description: Represents a Flocker volume mounted by the Flocker
- agent. One and only one of datasetName and datasetUUID should
- be set. Flocker volumes do not support ownership management
- or SELinux relabeling.
+ 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: Name of the dataset stored as metadata -> name
@@ -4767,17 +5003,18 @@ spec:
type: string
type: object
gcePersistentDisk:
- description: |-
- Represents a Persistent Disk resource in Google Compute Engine.
-
- A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.
+ 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: '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'
+ 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: 'The partition in the volume that you want to
@@ -4799,10 +5036,11 @@ spec:
- pdName
type: object
gitRepo:
- description: |-
- Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.
-
- 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: Target directory name. Must not contain or start
@@ -4821,9 +5059,8 @@ spec:
- repository
type: object
glusterfs:
- description: Represents a Glusterfs mount that lasts the lifetime
- of a pod. Glusterfs volumes do not support ownership management
- or SELinux relabeling.
+ 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: 'EndpointsName is the endpoint name that details
@@ -4843,8 +5080,13 @@ spec:
- path
type: object
hostPath:
- description: Represents a host path mapped into a pod. Host path
- volumes do not support ownership management or SELinux relabeling.
+ 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
@@ -4859,9 +5101,9 @@ spec:
- path
type: object
iscsi:
- description: Represents an ISCSI disk. ISCSI volumes can only
- be mounted as read/write once. ISCSI volumes support ownership
- management and SELinux relabeling.
+ 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: whether support iSCSI Discovery CHAP authentication
@@ -4874,7 +5116,9 @@ spec:
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'
+ 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: Custom iSCSI Initiator Name. If initiatorName
@@ -4905,12 +5149,11 @@ spec:
in VolumeMounts. Defaults to false.
type: boolean
secretRef:
- description: LocalObjectReference contains enough information
- to let you locate the referenced object inside the same
- namespace.
+ description: 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'
+ description: 'Name of the 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
targetPortal:
@@ -4919,18 +5162,17 @@ spec:
TCP ports 860 and 3260).
type: string
required:
- - targetPortal
- iqn
- lun
+ - targetPortal
type: object
name:
description: 'Volume''s name. 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: Represents an NFS mount that lasts the lifetime of
- a pod. NFS volumes do not support ownership management or SELinux
- relabeling.
+ 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
@@ -4946,15 +5188,13 @@ spec:
NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: string
required:
- - server
- path
+ - server
type: object
persistentVolumeClaim:
- description: PersistentVolumeClaimVolumeSource references the
- user's PVC in the same namespace. This volume finds the bound
- PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource
- is, essentially, a wrapper around another type of volume that
- is owned by someone else (the system).
+ 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
@@ -4969,7 +5209,8 @@ spec:
- claimName
type: object
photonPersistentDisk:
- description: Represents a Photon Controller persistent disk resource.
+ description: PhotonPersistentDisk represents a PhotonController
+ persistent disk attached and mounted on kubelets host machine
properties:
fsType:
description: Filesystem type to mount. Must be a filesystem
@@ -4984,8 +5225,8 @@ spec:
- pdID
type: object
portworxVolume:
- description: PortworxVolumeSource represents a Portworx volume
- resource.
+ description: PortworxVolume represents a portworx volume attached
+ and mounted on kubelets host machine
properties:
fsType:
description: FSType represents the filesystem type to mount
@@ -5004,7 +5245,8 @@ spec:
- volumeID
type: object
projected:
- description: Represents a projected volume source
+ description: Items for all in one resources secrets, configmaps,
+ and downward API
properties:
defaultMode:
description: Mode bits to use on created files by default.
@@ -5021,10 +5263,8 @@ spec:
other supported volume types
properties:
configMap:
- description: |-
- Adapts a ConfigMap into a projected volume.
-
- The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode.
+ description: information about the configMap data to
+ project
properties:
items:
description: If unspecified, each key-value pair
@@ -5067,7 +5307,9 @@ spec:
type: object
type: array
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -5075,10 +5317,8 @@ spec:
type: boolean
type: object
downwardAPI:
- description: Represents downward API info for projecting
- into a projected volume. Note that this is identical
- to a downwardAPI volume source without the default
- mode.
+ description: information about the downwardAPI data
+ to project
properties:
items:
description: Items is a list of DownwardAPIVolume
@@ -5089,8 +5329,9 @@ spec:
pod field
properties:
fieldRef:
- description: ObjectFieldSelector selects an
- APIVersioned field of an object.
+ description: 'Required: Selects a field of
+ the pod: only annotations, labels, name
+ and namespace are supported.'
properties:
apiVersion:
description: Version of the schema the
@@ -5122,15 +5363,20 @@ spec:
the relative path must not start with ''..'''
type: string
resourceFieldRef:
- description: ResourceFieldSelector represents
- container resources (cpu, memory) and their
- output format
+ 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'
type: string
- divisor: {}
+ divisor:
+ description: Specifies the output format
+ of the exposed resources, defaults to
+ "1"
+ type: string
resource:
description: 'Required: resource to select'
type: string
@@ -5143,10 +5389,7 @@ spec:
type: array
type: object
secret:
- description: |-
- Adapts a secret into a projected volume.
-
- The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode.
+ description: information about the secret data to project
properties:
items:
description: If unspecified, each key-value pair
@@ -5189,7 +5432,9 @@ spec:
type: object
type: array
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -5197,11 +5442,8 @@ spec:
type: boolean
type: object
serviceAccountToken:
- description: ServiceAccountTokenProjection represents
- a projected service account token volume. This projection
- can be used to insert a service account token into
- the pods runtime filesystem for use against APIs (Kubernetes
- API Server or otherwise).
+ description: information about the serviceAccountToken
+ data to project
properties:
audience:
description: Audience is the intended audience of
@@ -5236,9 +5478,8 @@ spec:
- sources
type: object
quobyte:
- description: Represents a Quobyte mount that lasts the lifetime
- of a pod. Quobyte volumes do not support ownership management
- or SELinux relabeling.
+ 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
@@ -5271,16 +5512,17 @@ spec:
- volume
type: object
rbd:
- description: Represents a Rados Block Device mount that lasts
- the lifetime of a pod. RBD volumes support ownership management
- and SELinux relabeling.
+ 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: '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'
+ 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: 'The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
@@ -5303,12 +5545,13 @@ spec:
in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: boolean
secretRef:
- description: LocalObjectReference contains enough information
- to let you locate the referenced object inside the same
- namespace.
+ 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'
+ description: 'Name of the 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
user:
@@ -5316,12 +5559,12 @@ spec:
info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
required:
- - monitors
- image
+ - monitors
type: object
scaleIO:
- description: ScaleIOVolumeSource represents a persistent ScaleIO
- volume
+ description: ScaleIO represents a ScaleIO persistent volume attached
+ and mounted on Kubernetes nodes.
properties:
fsType:
description: Filesystem type to mount. Must be a filesystem
@@ -5340,12 +5583,13 @@ spec:
will force the ReadOnly setting in VolumeMounts.
type: boolean
secretRef:
- description: LocalObjectReference contains enough information
- to let you locate the referenced object inside the same
- namespace.
+ 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'
+ description: 'Name of the 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
sslEnabled:
@@ -5370,14 +5614,12 @@ spec:
type: string
required:
- gateway
- - system
- secretRef
+ - system
type: object
secret:
- description: |-
- Adapts a Secret into a volume.
-
- The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.
+ description: 'Secret represents a secret that should populate
+ this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
properties:
defaultMode:
description: 'Optional: mode bits to use on created files
@@ -5434,7 +5676,8 @@ spec:
type: string
type: object
storageos:
- description: Represents a StorageOS persistent volume resource.
+ description: StorageOS represents a StorageOS volume attached
+ and mounted on Kubernetes nodes.
properties:
fsType:
description: Filesystem type to mount. Must be a filesystem
@@ -5446,12 +5689,13 @@ spec:
will force the ReadOnly setting in VolumeMounts.
type: boolean
secretRef:
- description: LocalObjectReference contains enough information
- to let you locate the referenced object inside the same
- namespace.
+ 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'
+ description: 'Name of the 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
volumeName:
@@ -5471,7 +5715,8 @@ spec:
type: string
type: object
vsphereVolume:
- description: Represents a vSphere volume resource.
+ description: VsphereVolume represents a vSphere volume attached
+ and mounted on kubelets host machine
properties:
fsType:
description: Filesystem type to mount. Must be a filesystem
@@ -5502,9 +5747,9 @@ spec:
type: boolean
type: object
status:
- description: 'PrometheusStatus is the most recent observed status of the
- Prometheus cluster. Read-only. Not included when requesting from the apiserver,
- only from the Prometheus 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 Prometheus cluster. Read-only.
+ Not included when requesting from the apiserver, only from the Prometheus
+ 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)
@@ -5531,11 +5776,23 @@ spec:
format: int32
type: integer
required:
+ - availableReplicas
- paused
- replicas
- - updatedReplicas
- - availableReplicas
- unavailableReplicas
+ - updatedReplicas
type: object
+ required:
+ - spec
type: object
version: v1
+ versions:
+ - name: v1
+ served: true
+ storage: true
+status:
+ acceptedNames:
+ kind: ""
+ plural: ""
+ conditions: []
+ storedVersions: []
diff --git a/manifests/setup/prometheus-operator-0prometheusruleCustomResourceDefinition.yaml b/manifests/setup/prometheus-operator-0prometheusruleCustomResourceDefinition.yaml
index 49ddbfb86c62498788e4f66e96b61cc7b9f693be..7244d4395607dbe48e2c4490eb72e7a03320042f 100644
--- a/manifests/setup/prometheus-operator-0prometheusruleCustomResourceDefinition.yaml
+++ b/manifests/setup/prometheus-operator-0prometheusruleCustomResourceDefinition.yaml
@@ -1,16 +1,22 @@
apiVersion: apiextensions.k8s.io/v1beta1
kind: CustomResourceDefinition
metadata:
+ annotations:
+ controller-gen.kubebuilder.io/version: v0.2.4
creationTimestamp: null
name: prometheusrules.monitoring.coreos.com
spec:
group: monitoring.coreos.com
names:
kind: PrometheusRule
+ listKind: PrometheusRuleList
plural: prometheusrules
+ singular: prometheusrule
+ preserveUnknownFields: false
scope: Namespaced
validation:
openAPIV3Schema:
+ description: PrometheusRule defines alerting rules for a Prometheus instance
properties:
apiVersion:
description: 'APIVersion defines the versioned schema of this representation
@@ -23,190 +29,9 @@ spec:
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: ObjectMeta is metadata that all persisted resources must have,
- which includes all objects users must create.
- properties:
- 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
- clusterName:
- description: The name of the cluster which the object belongs to. This
- is used to distinguish resources with same name and namespace in different
- clusters. This field is not set anywhere right now and apiserver is
- going to ignore it if set in create or update request.
- type: string
- creationTimestamp:
- description: Time is a wrapper around time.Time which supports correct
- marshaling to YAML and JSON. Wrappers are provided for many of the
- factory methods that the time package offers.
- format: date-time
- type: string
- deletionGracePeriodSeconds:
- description: Number of seconds allowed for this object to gracefully
- terminate before it will be removed from the system. Only set when
- deletionTimestamp is also set. May only be shortened. Read-only.
- format: int64
- type: integer
- deletionTimestamp:
- description: Time is a wrapper around time.Time which supports correct
- marshaling to YAML and JSON. Wrappers are provided for many of the
- factory methods that the time package offers.
- format: date-time
- type: string
- finalizers:
- description: Must be empty before the object is deleted from the registry.
- Each entry is an identifier for the responsible component that will
- remove the entry from the list. If the deletionTimestamp of the object
- is non-nil, entries in this list can only be removed.
- items:
- type: string
- type: array
- generateName:
- description: |-
- GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
-
- If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
-
- Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
- type: string
- generation:
- description: A sequence number representing a specific generation of
- the desired state. Populated by the system. Read-only.
- format: int64
- type: integer
- 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
- managedFields:
- description: ManagedFields maps workflow-id and version to the set of
- fields that are managed by that workflow. This is mostly for internal
- housekeeping, and users typically shouldn't need to set or understand
- this field. A workflow can be the user's name, a controller's name,
- or the name of a specific apply path like "ci-cd". The set of fields
- is always in the version that the workflow used when modifying the
- object.
- items:
- description: ManagedFieldsEntry is a workflow-id, a FieldSet and the
- group version of the resource that the fieldset applies to.
- properties:
- apiVersion:
- description: APIVersion defines the version of this resource that
- this field set applies to. The format is "group/version" just
- like the top-level APIVersion field. It is necessary to track
- the version of a field set because it cannot be automatically
- converted.
- type: string
- fieldsType:
- description: 'FieldsType is the discriminator for the different
- fields format and version. There is currently only one possible
- value: "FieldsV1"'
- type: string
- fieldsV1:
- description: |-
- FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.
-
- Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.
-
- The exact format is defined in sigs.k8s.io/structured-merge-diff
- type: object
- manager:
- description: Manager is an identifier of the workflow managing
- these fields.
- type: string
- operation:
- description: Operation is the type of operation which lead to
- this ManagedFieldsEntry being created. The only valid values
- for this field are 'Apply' and 'Update'.
- type: string
- time:
- description: Time is a wrapper around time.Time which supports
- correct marshaling to YAML and JSON. Wrappers are provided
- for many of the factory methods that the time package offers.
- format: date-time
- type: string
- type: object
- type: array
- 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'
- type: string
- namespace:
- description: |-
- Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
-
- Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
- type: string
- ownerReferences:
- description: List of objects depended by this object. If ALL objects
- in the list have been deleted, this object will be garbage collected.
- If this object is managed by a controller, then an entry in this list
- will point to this controller, with the controller field set to true.
- There cannot be more than one managing controller.
- items:
- description: OwnerReference contains enough information to let you
- identify an owning object. An owning object must be in the same
- namespace as the dependent, or be cluster-scoped, so there is no
- namespace field.
- properties:
- apiVersion:
- description: API version of the referent.
- type: string
- blockOwnerDeletion:
- description: If true, AND if the owner has the "foregroundDeletion"
- finalizer, then the owner cannot be deleted from the key-value
- store until this reference is removed. Defaults to false. To
- set this field, a user needs "delete" permission of the owner,
- otherwise 422 (Unprocessable Entity) will be returned.
- type: boolean
- controller:
- description: If true, this reference points to the managing controller.
- type: boolean
- kind:
- description: 'Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
- type: string
- name:
- description: 'Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names'
- type: string
- uid:
- description: 'UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids'
- type: string
- required:
- - apiVersion
- - kind
- - name
- - uid
- type: object
- type: array
- resourceVersion:
- description: |-
- An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
-
- Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
- type: string
- selfLink:
- description: |-
- SelfLink is a URL representing this object. Populated by the system. Read-only.
-
- DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.
- type: string
- uid:
- description: |-
- UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
-
- Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
- type: string
type: object
spec:
- description: PrometheusRuleSpec contains specification parameters for a
- Rule.
+ description: Specification of desired alerting rule definitions for Prometheus.
properties:
groups:
description: Content of Prometheus rule file
@@ -225,14 +50,19 @@ spec:
alert:
type: string
annotations:
+ additionalProperties:
+ type: string
type: object
expr:
anyOf:
- - type: string
- type: integer
+ - type: string
+ x-kubernetes-int-or-string: true
for:
type: string
labels:
+ additionalProperties:
+ type: string
type: object
record:
type: string
@@ -246,5 +76,17 @@ spec:
type: object
type: array
type: object
+ required:
+ - spec
type: object
version: v1
+ versions:
+ - name: v1
+ served: true
+ storage: true
+status:
+ acceptedNames:
+ kind: ""
+ plural: ""
+ conditions: []
+ storedVersions: []
diff --git a/manifests/setup/prometheus-operator-0servicemonitorCustomResourceDefinition.yaml b/manifests/setup/prometheus-operator-0servicemonitorCustomResourceDefinition.yaml
index 5283e87d5188dabd91ba33549fb9503f315573d4..e9286ea87b60636a042d87ddf518ea6bd3ac074e 100644
--- a/manifests/setup/prometheus-operator-0servicemonitorCustomResourceDefinition.yaml
+++ b/manifests/setup/prometheus-operator-0servicemonitorCustomResourceDefinition.yaml
@@ -1,16 +1,22 @@
apiVersion: apiextensions.k8s.io/v1beta1
kind: CustomResourceDefinition
metadata:
+ annotations:
+ controller-gen.kubebuilder.io/version: v0.2.4
creationTimestamp: null
name: servicemonitors.monitoring.coreos.com
spec:
group: monitoring.coreos.com
names:
kind: ServiceMonitor
+ listKind: ServiceMonitorList
plural: servicemonitors
+ singular: servicemonitor
+ preserveUnknownFields: false
scope: Namespaced
validation:
openAPIV3Schema:
+ description: ServiceMonitor defines monitoring for a set of services.
properties:
apiVersion:
description: 'APIVersion defines the versioned schema of this representation
@@ -22,9 +28,11 @@ spec:
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: ServiceMonitorSpec contains specification parameters for a
- ServiceMonitor.
+ description: Specification of desired Service selection for target discovery
+ by Prometheus.
properties:
endpoints:
description: A list of endpoints allowed as part of this ServiceMonitor.
@@ -37,14 +45,16 @@ spec:
basic authentication More info: https://prometheus.io/docs/operating/configuration/#endpoints'
properties:
password:
- description: SecretKeySelector selects a key of a Secret.
+ 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.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -54,14 +64,16 @@ spec:
- key
type: object
username:
- description: SecretKeySelector selects a key of a Secret.
+ 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.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -75,14 +87,17 @@ spec:
description: File to read bearer token for scraping targets.
type: string
bearerTokenSecret:
- description: SecretKeySelector selects a key of a Secret.
+ 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.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -121,7 +136,7 @@ spec:
type: integer
regex:
description: Regular expression against which the extracted
- value is matched. defailt is '(.*)'
+ value is matched. Default is '(.*)'
type: string
replacement:
description: Replacement value against which a regex replace
@@ -148,6 +163,10 @@ spec:
type: object
type: array
params:
+ additionalProperties:
+ items:
+ type: string
+ type: array
description: Optional HTTP URL parameters
type: object
path:
@@ -181,7 +200,7 @@ spec:
type: integer
regex:
description: Regular expression against which the extracted
- value is matched. defailt is '(.*)'
+ value is matched. Default is '(.*)'
type: string
replacement:
description: Replacement value against which a regex replace
@@ -215,17 +234,103 @@ spec:
type: string
targetPort:
anyOf:
- - type: string
- type: integer
+ - type: string
+ description: Name or number of the target port of the endpoint.
+ Mutually exclusive with port.
+ x-kubernetes-int-or-string: true
tlsConfig:
- description: TLSConfig specifies TLS configuration parameters.
+ description: TLS configuration to use when scraping the endpoint
properties:
- ca: {}
+ ca:
+ description: Stuct containing the CA cert to use for the targets.
+ properties:
+ configMap:
+ 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?'
+ type: string
+ optional:
+ description: Specify whether the ConfigMap or its
+ key must be defined
+ type: boolean
+ required:
+ - key
+ type: object
+ secret:
+ 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.
+ type: string
+ name:
+ description: 'Name of the referent. More info: https://kubernetes.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
+ type: boolean
+ required:
+ - key
+ type: object
+ type: object
caFile:
description: Path to the CA cert in the Prometheus container
to use for the targets.
type: string
- cert: {}
+ cert:
+ description: Struct containing the client cert file for the
+ targets.
+ properties:
+ configMap:
+ 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?'
+ type: string
+ optional:
+ description: Specify whether the ConfigMap or its
+ key must be defined
+ type: boolean
+ required:
+ - key
+ type: object
+ secret:
+ 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.
+ type: string
+ name:
+ description: 'Name of the referent. More info: https://kubernetes.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
+ type: boolean
+ required:
+ - key
+ type: object
+ type: object
certFile:
description: Path to the client cert file in the Prometheus
container for the targets.
@@ -238,14 +343,16 @@ spec:
container for the targets.
type: string
keySecret:
- description: SecretKeySelector selects a key of a Secret.
+ 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.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+ description: 'Name of the referent. More info: https://kubernetes.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
@@ -264,8 +371,8 @@ spec:
description: The label to use to retrieve the job name from.
type: string
namespaceSelector:
- description: NamespaceSelector is a selector for selecting either all
- namespaces or a list of namespaces.
+ description: Selector to select which namespaces the Endpoints objects
+ are discovered from.
properties:
any:
description: Boolean describing whether all namespaces are selected
@@ -289,10 +396,7 @@ spec:
format: int64
type: integer
selector:
- description: A label selector is a label query over a set of resources.
- The result of matchLabels and matchExpressions are ANDed. An empty
- label selector matches all objects. A null label selector matches
- no objects.
+ description: Selector to select Endpoints objects.
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements.
@@ -325,6 +429,8 @@ spec:
type: object
type: array
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
@@ -342,5 +448,17 @@ spec:
- endpoints
- selector
type: object
+ required:
+ - spec
type: object
version: v1
+ versions:
+ - name: v1
+ served: true
+ storage: true
+status:
+ acceptedNames:
+ kind: ""
+ plural: ""
+ conditions: []
+ storedVersions: []