diff --git a/addons/keda/duck/v1alpha1/zz_generated.deepcopy.go b/addons/keda/duck/v1alpha1/zz_generated.deepcopy.go
index 27d57d72ab..7bbeb3f446 100644
--- a/addons/keda/duck/v1alpha1/zz_generated.deepcopy.go
+++ b/addons/keda/duck/v1alpha1/zz_generated.deepcopy.go
@@ -1,4 +1,5 @@
//go:build !ignore_autogenerated
+// +build !ignore_autogenerated
// Code generated by controller-gen. DO NOT EDIT.
diff --git a/addons/strimzi/duck/v1beta2/zz_generated.deepcopy.go b/addons/strimzi/duck/v1beta2/zz_generated.deepcopy.go
index 20ac56983e..f12a483fdc 100644
--- a/addons/strimzi/duck/v1beta2/zz_generated.deepcopy.go
+++ b/addons/strimzi/duck/v1beta2/zz_generated.deepcopy.go
@@ -1,4 +1,5 @@
//go:build !ignore_autogenerated
+// +build !ignore_autogenerated
// Code generated by controller-gen. DO NOT EDIT.
diff --git a/docs/modules/ROOT/partials/apis/camel-k-crds.adoc b/docs/modules/ROOT/partials/apis/camel-k-crds.adoc
index 09d12c0e9e..2cd4b1420c 100644
--- a/docs/modules/ROOT/partials/apis/camel-k-crds.adoc
+++ b/docs/modules/ROOT/partials/apis/camel-k-crds.adoc
@@ -7198,6 +7198,14 @@ It's enabled by default whenever a Service is added to the integration (through
+|`ingressClassName` +
+string
+|
+
+
+The Ingress class name as defined by the Ingress spec
+See https://kubernetes.io/docs/concepts/services-networking/ingress/
+
|`annotations` +
map[string]string
|
diff --git a/docs/modules/traits/pages/ingress.adoc b/docs/modules/traits/pages/ingress.adoc
index 8ed29dff9c..479e421a92 100755
--- a/docs/modules/traits/pages/ingress.adoc
+++ b/docs/modules/traits/pages/ingress.adoc
@@ -30,6 +30,11 @@ The following configuration options are available:
| bool
| Can be used to enable or disable a trait. All traits share this common property.
+| ingress.ingress-class-name
+| string
+| The Ingress class name as defined by the Ingress spec
+See https://kubernetes.io/docs/concepts/services-networking/ingress/
+
| ingress.annotations
| map[string]string
| The annotations added to the ingress.
diff --git a/helm/camel-k/crds/camel-k-crds.yaml b/helm/camel-k/crds/camel-k-crds.yaml
index 6eb2218ec8..3e409754f6 100644
--- a/helm/camel-k/crds/camel-k-crds.yaml
+++ b/helm/camel-k/crds/camel-k-crds.yaml
@@ -18,7 +18,8 @@ apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
- controller-gen.kubebuilder.io/version: v0.15.0
+ controller-gen.kubebuilder.io/version: v0.6.1
+ creationTimestamp: null
labels:
app: camel-k
name: builds.camel.apache.org
@@ -63,31 +64,26 @@ spec:
description: Build is the Schema for the builds API.
properties:
apiVersion:
- description: |-
- APIVersion defines the versioned schema of this representation of an object.
- Servers should convert recognized schemas to the latest internal value, and
- may reject unrecognized values.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+ description: 'APIVersion defines the versioned schema of this representation
+ of an object. Servers should convert recognized schemas to the latest
+ internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: |-
- Kind is a string value representing the REST resource this object represents.
- Servers may infer this from the endpoint the client submits requests to.
- Cannot be updated.
- In CamelCase.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ description: 'Kind is a string value representing the REST resource this
+ object represents. Servers may infer this from the endpoint the client
+ submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
spec:
- description: |-
- BuildSpec defines the list of tasks to be execute for a Build. From Camel K version 2, it would be more appropriate
- to think it as pipeline.
+ description: BuildSpec defines the list of tasks to be execute for a Build.
+ From Camel K version 2, it would be more appropriate to think it as
+ pipeline.
properties:
configuration:
- description: |-
- The configuration that should be used to perform the Build.
- Deprecated: no longer in use in Camel K 2 - maintained for backward compatibility
+ description: 'The configuration that should be used to perform the
+ Build. Deprecated: no longer in use in Camel K 2 - maintained for
+ backward compatibility'
properties:
annotations:
additionalProperties:
@@ -145,15 +141,16 @@ spec:
type: string
type: object
maxRunningBuilds:
- description: |-
- the maximum amount of parallel running builds started by this operator instance
- Deprecated: no longer in use in Camel K 2 - maintained for backward compatibility
+ description: 'the maximum amount of parallel running builds started
+ by this operator instance Deprecated: no longer in use in Camel
+ K 2 - maintained for backward compatibility'
format: int32
type: integer
operatorNamespace:
- description: |-
- The namespace where to run the builder Pod (must be the same of the operator in charge of this Build reconciliation).
- Deprecated: no longer in use in Camel K 2 - maintained for backward compatibility
+ description: 'The namespace where to run the builder Pod (must be
+ the same of the operator in charge of this Build reconciliation).
+ Deprecated: no longer in use in Camel K 2 - maintained for backward
+ compatibility'
type: string
tasks:
description: The sequence of tasks (pipeline) to be performed.
@@ -162,9 +159,8 @@ spec:
task should be configured to represent the specific task chosen.
properties:
buildah:
- description: |-
- a BuildahTask, for Buildah strategy
- Deprecated: use jib, s2i or a custom publishing strategy instead
+ description: 'a BuildahTask, for Buildah strategy Deprecated:
+ use jib, s2i or a custom publishing strategy instead'
properties:
baseImage:
description: base image layer
@@ -350,13 +346,15 @@ spec:
application build phase
properties:
caSecrets:
- description: |-
- The Secrets name and key, containing the CA certificate(s) used to connect
- to remote Maven repositories.
- It can contain X.509 certificates, and PKCS#7 formatted certificate chains.
- A JKS formatted keystore is automatically created to store the CA certificate(s),
- and configured to be used as a trusted certificate(s) by the Maven commands.
- Note that the root CA certificates are also imported into the created keystore.
+ description: The Secrets name and key, containing the
+ CA certificate(s) used to connect to remote Maven
+ repositories. It can contain X.509 certificates, and
+ PKCS#7 formatted certificate chains. A JKS formatted
+ keystore is automatically created to store the CA
+ certificate(s), and configured to be used as a trusted
+ certificate(s) by the Maven commands. Note that the
+ root CA certificates are also imported into the created
+ keystore.
items:
description: SecretKeySelector selects a key of a
Secret.
@@ -366,10 +364,10 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the Secret or its
@@ -378,20 +376,16 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: array
cliOptions:
- description: |-
- The CLI options that are appended to the list of arguments for Maven commands,
- e.g., `-V,--no-transfer-progress,-Dstyle.color=never`.
+ description: The CLI options that are appended to the
+ list of arguments for Maven commands, e.g., `-V,--no-transfer-progress,-Dstyle.color=never`.
See https://maven.apache.org/ref/3.8.4/maven-embedder/cli.html.
items:
type: string
type: array
extension:
- description: |-
- The Maven build extensions.
- See https://maven.apache.org/guides/mini/guide-using-extensions.html.
+ description: The Maven build extensions. See https://maven.apache.org/guides/mini/guide-using-extensions.html.
items:
description: MavenArtifact defines a GAV (Group:Artifact:Type:Version:Classifier)
Maven artifact.
@@ -420,9 +414,8 @@ spec:
description: The path of the local Maven repository.
type: string
profiles:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the Maven profile.
+ description: A reference to the ConfigMap or Secret
+ key that contains the Maven profile.
items:
description: ValueSource --.
properties:
@@ -433,10 +426,10 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
@@ -445,7 +438,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -454,10 +446,10 @@ spec:
from. Must be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret or
@@ -466,7 +458,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
properties:
@@ -489,18 +480,23 @@ spec:
description: can use stable releases
properties:
checksumPolicy:
- description: |-
- When Maven deploys files to the repository, it also deploys corresponding checksum files.
- Your options are to `ignore`, `fail`, or `warn` on missing or incorrect checksums.
+ description: When Maven deploys files to the
+ repository, it also deploys corresponding
+ checksum files. Your options are to `ignore`,
+ `fail`, or `warn` on missing or incorrect
+ checksums.
type: string
enabled:
description: is the policy activated or not
type: boolean
updatePolicy:
- description: |-
- This element specifies how often updates should attempt to occur.
- Maven will compare the local POM's timestamp (stored in a repository's maven-metadata file) to the remote.
- The choices are: `always`, `daily` (default), `interval:X` (where X is an integer in minutes) or `never`
+ description: 'This element specifies how often
+ updates should attempt to occur. Maven will
+ compare the local POM''s timestamp (stored
+ in a repository''s maven-metadata file)
+ to the remote. The choices are: `always`,
+ `daily` (default), `interval:X` (where X
+ is an integer in minutes) or `never`'
type: string
required:
- enabled
@@ -509,18 +505,23 @@ spec:
description: can use snapshot
properties:
checksumPolicy:
- description: |-
- When Maven deploys files to the repository, it also deploys corresponding checksum files.
- Your options are to `ignore`, `fail`, or `warn` on missing or incorrect checksums.
+ description: When Maven deploys files to the
+ repository, it also deploys corresponding
+ checksum files. Your options are to `ignore`,
+ `fail`, or `warn` on missing or incorrect
+ checksums.
type: string
enabled:
description: is the policy activated or not
type: boolean
updatePolicy:
- description: |-
- This element specifies how often updates should attempt to occur.
- Maven will compare the local POM's timestamp (stored in a repository's maven-metadata file) to the remote.
- The choices are: `always`, `daily` (default), `interval:X` (where X is an integer in minutes) or `never`
+ description: 'This element specifies how often
+ updates should attempt to occur. Maven will
+ compare the local POM''s timestamp (stored
+ in a repository''s maven-metadata file)
+ to the remote. The choices are: `always`,
+ `daily` (default), `interval:X` (where X
+ is an integer in minutes) or `never`'
type: string
required:
- enabled
@@ -553,9 +554,8 @@ spec:
type: object
type: array
settings:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the Maven settings.
+ description: A reference to the ConfigMap or Secret
+ key that contains the Maven settings.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -564,10 +564,10 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap or
@@ -576,7 +576,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -585,10 +584,10 @@ spec:
from. Must be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret or its
@@ -597,12 +596,10 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
settingsSecurity:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the security of the Maven settings.
+ description: A reference to the ConfigMap or Secret
+ key that contains the security of the Maven settings.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -611,10 +608,10 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap or
@@ -623,7 +620,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -632,10 +628,10 @@ spec:
from. Must be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret or its
@@ -644,7 +640,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: object
name:
@@ -659,9 +654,9 @@ spec:
type: string
capabilities:
additionalProperties:
- description: |-
- Capability is a particular feature which requires a well known set of dependencies and other properties
- which are specified in the runtime catalog.
+ description: Capability is a particular feature which
+ requires a well known set of dependencies and other
+ properties which are specified in the runtime catalog.
properties:
buildTimeProperties:
description: Set of required Camel build time
@@ -802,9 +797,9 @@ spec:
Kamelet
type: boolean
interceptors:
- description: |-
- Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
- uses to pre/post process sources
+ description: Interceptors are optional identifiers
+ the org.apache.camel.k.RoutesLoader uses to pre/post
+ process sources
items:
type: string
type: array
@@ -813,9 +808,8 @@ spec:
DSL) used to interpret this source code
type: string
loader:
- description: |-
- Loader is an optional id of the org.apache.camel.k.RoutesLoader that will
- interpret this source at runtime
+ description: Loader is an optional id of the org.apache.camel.k.RoutesLoader
+ that will interpret this source at runtime
type: string
name:
description: the name of the specification
@@ -850,9 +844,7 @@ spec:
after the build and before the package task.
properties:
command:
- description: |-
- the command to execute
- Deprecated: use ContainerCommands
+ description: 'the command to execute Deprecated: use ContainerCommands'
type: string
commands:
description: the command to execute
@@ -1033,9 +1025,8 @@ spec:
type: object
type: object
kaniko:
- description: |-
- a KanikoTask, for Kaniko strategy
- Deprecated: use jib, s2i or a custom publishing strategy instead
+ description: 'a KanikoTask, for Kaniko strategy Deprecated:
+ use jib, s2i or a custom publishing strategy instead'
properties:
baseImage:
description: base image layer
@@ -1149,9 +1140,8 @@ spec:
type: boolean
type: object
package:
- description: |-
- Application pre publishing
- a PackageTask, used to package the project
+ description: Application pre publishing a PackageTask, used
+ to package the project
properties:
baseImage:
description: the base image layer
@@ -1230,13 +1220,15 @@ spec:
application build phase
properties:
caSecrets:
- description: |-
- The Secrets name and key, containing the CA certificate(s) used to connect
- to remote Maven repositories.
- It can contain X.509 certificates, and PKCS#7 formatted certificate chains.
- A JKS formatted keystore is automatically created to store the CA certificate(s),
- and configured to be used as a trusted certificate(s) by the Maven commands.
- Note that the root CA certificates are also imported into the created keystore.
+ description: The Secrets name and key, containing the
+ CA certificate(s) used to connect to remote Maven
+ repositories. It can contain X.509 certificates, and
+ PKCS#7 formatted certificate chains. A JKS formatted
+ keystore is automatically created to store the CA
+ certificate(s), and configured to be used as a trusted
+ certificate(s) by the Maven commands. Note that the
+ root CA certificates are also imported into the created
+ keystore.
items:
description: SecretKeySelector selects a key of a
Secret.
@@ -1246,10 +1238,10 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the Secret or its
@@ -1258,20 +1250,16 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: array
cliOptions:
- description: |-
- The CLI options that are appended to the list of arguments for Maven commands,
- e.g., `-V,--no-transfer-progress,-Dstyle.color=never`.
+ description: The CLI options that are appended to the
+ list of arguments for Maven commands, e.g., `-V,--no-transfer-progress,-Dstyle.color=never`.
See https://maven.apache.org/ref/3.8.4/maven-embedder/cli.html.
items:
type: string
type: array
extension:
- description: |-
- The Maven build extensions.
- See https://maven.apache.org/guides/mini/guide-using-extensions.html.
+ description: The Maven build extensions. See https://maven.apache.org/guides/mini/guide-using-extensions.html.
items:
description: MavenArtifact defines a GAV (Group:Artifact:Type:Version:Classifier)
Maven artifact.
@@ -1300,9 +1288,8 @@ spec:
description: The path of the local Maven repository.
type: string
profiles:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the Maven profile.
+ description: A reference to the ConfigMap or Secret
+ key that contains the Maven profile.
items:
description: ValueSource --.
properties:
@@ -1313,10 +1300,10 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
@@ -1325,7 +1312,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -1334,10 +1320,10 @@ spec:
from. Must be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret or
@@ -1346,7 +1332,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
properties:
@@ -1369,18 +1354,23 @@ spec:
description: can use stable releases
properties:
checksumPolicy:
- description: |-
- When Maven deploys files to the repository, it also deploys corresponding checksum files.
- Your options are to `ignore`, `fail`, or `warn` on missing or incorrect checksums.
+ description: When Maven deploys files to the
+ repository, it also deploys corresponding
+ checksum files. Your options are to `ignore`,
+ `fail`, or `warn` on missing or incorrect
+ checksums.
type: string
enabled:
description: is the policy activated or not
type: boolean
updatePolicy:
- description: |-
- This element specifies how often updates should attempt to occur.
- Maven will compare the local POM's timestamp (stored in a repository's maven-metadata file) to the remote.
- The choices are: `always`, `daily` (default), `interval:X` (where X is an integer in minutes) or `never`
+ description: 'This element specifies how often
+ updates should attempt to occur. Maven will
+ compare the local POM''s timestamp (stored
+ in a repository''s maven-metadata file)
+ to the remote. The choices are: `always`,
+ `daily` (default), `interval:X` (where X
+ is an integer in minutes) or `never`'
type: string
required:
- enabled
@@ -1389,18 +1379,23 @@ spec:
description: can use snapshot
properties:
checksumPolicy:
- description: |-
- When Maven deploys files to the repository, it also deploys corresponding checksum files.
- Your options are to `ignore`, `fail`, or `warn` on missing or incorrect checksums.
+ description: When Maven deploys files to the
+ repository, it also deploys corresponding
+ checksum files. Your options are to `ignore`,
+ `fail`, or `warn` on missing or incorrect
+ checksums.
type: string
enabled:
description: is the policy activated or not
type: boolean
updatePolicy:
- description: |-
- This element specifies how often updates should attempt to occur.
- Maven will compare the local POM's timestamp (stored in a repository's maven-metadata file) to the remote.
- The choices are: `always`, `daily` (default), `interval:X` (where X is an integer in minutes) or `never`
+ description: 'This element specifies how often
+ updates should attempt to occur. Maven will
+ compare the local POM''s timestamp (stored
+ in a repository''s maven-metadata file)
+ to the remote. The choices are: `always`,
+ `daily` (default), `interval:X` (where X
+ is an integer in minutes) or `never`'
type: string
required:
- enabled
@@ -1433,9 +1428,8 @@ spec:
type: object
type: array
settings:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the Maven settings.
+ description: A reference to the ConfigMap or Secret
+ key that contains the Maven settings.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -1444,10 +1438,10 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap or
@@ -1456,7 +1450,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -1465,10 +1458,10 @@ spec:
from. Must be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret or its
@@ -1477,12 +1470,10 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
settingsSecurity:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the security of the Maven settings.
+ description: A reference to the ConfigMap or Secret
+ key that contains the security of the Maven settings.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -1491,10 +1482,10 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap or
@@ -1503,7 +1494,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -1512,10 +1502,10 @@ spec:
from. Must be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret or its
@@ -1524,7 +1514,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: object
name:
@@ -1539,9 +1528,9 @@ spec:
type: string
capabilities:
additionalProperties:
- description: |-
- Capability is a particular feature which requires a well known set of dependencies and other properties
- which are specified in the runtime catalog.
+ description: Capability is a particular feature which
+ requires a well known set of dependencies and other
+ properties which are specified in the runtime catalog.
properties:
buildTimeProperties:
description: Set of required Camel build time
@@ -1682,9 +1671,9 @@ spec:
Kamelet
type: boolean
interceptors:
- description: |-
- Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
- uses to pre/post process sources
+ description: Interceptors are optional identifiers
+ the org.apache.camel.k.RoutesLoader uses to pre/post
+ process sources
items:
type: string
type: array
@@ -1693,9 +1682,8 @@ spec:
DSL) used to interpret this source code
type: string
loader:
- description: |-
- Loader is an optional id of the org.apache.camel.k.RoutesLoader that will
- interpret this source at runtime
+ description: Loader is an optional id of the org.apache.camel.k.RoutesLoader
+ that will interpret this source at runtime
type: string
name:
description: the name of the specification
@@ -1827,9 +1815,8 @@ spec:
type: string
type: object
spectrum:
- description: |-
- a SpectrumTask, for Spectrum strategy
- Deprecated: use jib, s2i or a custom publishing strategy instead
+ description: 'a SpectrumTask, for Spectrum strategy Deprecated:
+ use jib, s2i or a custom publishing strategy instead'
properties:
baseImage:
description: base image layer
@@ -1929,17 +1916,15 @@ spec:
type: object
type: array
timeout:
- description: |-
- Timeout defines the Build maximum execution duration.
- The Build deadline is set to the Build start time plus the Timeout duration.
- If the Build deadline is exceeded, the Build context is canceled,
- and its phase set to BuildPhaseFailed.
+ description: Timeout defines the Build maximum execution duration.
+ The Build deadline is set to the Build start time plus the Timeout
+ duration. If the Build deadline is exceeded, the Build context is
+ canceled, and its phase set to BuildPhaseFailed.
format: duration
type: string
toolImage:
- description: |-
- The container image to be used to run the build.
- Deprecated: no longer in use in Camel K 2 - maintained for backward compatibility
+ description: 'The container image to be used to run the build. Deprecated:
+ no longer in use in Camel K 2 - maintained for backward compatibility'
type: string
type: object
status:
@@ -2008,10 +1993,8 @@ spec:
description: the digest from image
type: string
duration:
- description: |-
- how long it took for the build
- Change to Duration / ISO 8601 when CRD uses OpenAPI spec v3
- https://github.com/OAI/OpenAPI-Specification/issues/845
+ description: how long it took for the build Change to Duration / ISO
+ 8601 when CRD uses OpenAPI spec v3 https://github.com/OAI/OpenAPI-Specification/issues/845
type: string
error:
description: the error description (if any)
@@ -2073,12 +2056,19 @@ spec:
storage: true
subresources:
status: {}
+status:
+ acceptedNames:
+ kind: ""
+ plural: ""
+ conditions: []
+ storedVersions: []
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
- controller-gen.kubebuilder.io/version: v0.15.0
+ controller-gen.kubebuilder.io/version: v0.6.1
+ creationTimestamp: null
labels:
app: camel-k
name: camelcatalogs.camel.apache.org
@@ -2121,19 +2111,14 @@ spec:
statically generated.
properties:
apiVersion:
- description: |-
- APIVersion defines the versioned schema of this representation of an object.
- Servers should convert recognized schemas to the latest internal value, and
- may reject unrecognized values.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+ description: 'APIVersion defines the versioned schema of this representation
+ of an object. Servers should convert recognized schemas to the latest
+ internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: |-
- Kind is a string value representing the REST resource this object represents.
- Servers may infer this from the endpoint the client submits requests to.
- Cannot be updated.
- In CamelCase.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ description: 'Kind is a string value representing the REST resource this
+ object represents. Servers may infer this from the endpoint the client
+ submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
@@ -2434,9 +2419,9 @@ spec:
type: string
capabilities:
additionalProperties:
- description: |-
- Capability is a particular feature which requires a well known set of dependencies and other properties
- which are specified in the runtime catalog.
+ description: Capability is a particular feature which requires
+ a well known set of dependencies and other properties which
+ are specified in the runtime catalog.
properties:
buildTimeProperties:
description: Set of required Camel build time properties
@@ -2602,12 +2587,19 @@ spec:
storage: true
subresources:
status: {}
+status:
+ acceptedNames:
+ kind: ""
+ plural: ""
+ conditions: []
+ storedVersions: []
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
- controller-gen.kubebuilder.io/version: v0.15.0
+ controller-gen.kubebuilder.io/version: v0.6.1
+ creationTimestamp: null
labels:
app: camel-k
name: integrationkits.camel.apache.org
@@ -2653,26 +2645,22 @@ spec:
name: v1
schema:
openAPIV3Schema:
- description: |-
- IntegrationKit defines a container image and additional configuration needed to run an `Integration`.
- An `IntegrationKit` is a generic image generally built from the requirements of an `Integration`, but agnostic to it,
- in order to be reused by any other `Integration` which has the same required set of capabilities. An `IntegrationKit`
- may be used for other kits as a base container layer, when the `incremental` build option is enabled.
+ description: IntegrationKit defines a container image and additional configuration
+ needed to run an `Integration`. An `IntegrationKit` is a generic image generally
+ built from the requirements of an `Integration`, but agnostic to it, in
+ order to be reused by any other `Integration` which has the same required
+ set of capabilities. An `IntegrationKit` may be used for other kits as a
+ base container layer, when the `incremental` build option is enabled.
properties:
apiVersion:
- description: |-
- APIVersion defines the versioned schema of this representation of an object.
- Servers should convert recognized schemas to the latest internal value, and
- may reject unrecognized values.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+ description: 'APIVersion defines the versioned schema of this representation
+ of an object. Servers should convert recognized schemas to the latest
+ internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: |-
- Kind is a string value representing the REST resource this object represents.
- Servers may infer this from the endpoint the client submits requests to.
- Cannot be updated.
- In CamelCase.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ description: 'Kind is a string value representing the REST resource this
+ object represents. Servers may infer this from the endpoint the client
+ submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
@@ -2685,13 +2673,10 @@ spec:
type: string
type: array
configuration:
- description: |-
- Deprecated:
- Use camel trait (camel.properties) to manage properties
- Use mount trait (mount.configs) to manage configs
- Use mount trait (mount.resources) to manage resources
- Use mount trait (mount.volumes) to manage volumes
- configuration used by the kit
+ description: 'Deprecated: Use camel trait (camel.properties) to manage
+ properties Use mount trait (mount.configs) to manage configs Use
+ mount trait (mount.resources) to manage resources Use mount trait
+ (mount.volumes) to manage volumes configuration used by the kit'
items:
description: ConfigurationSpec represents a generic configuration
specification.
@@ -2750,8 +2735,7 @@ spec:
description: True if the spec is generated from a Kamelet
type: boolean
interceptors:
- description: |-
- Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
+ description: Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
uses to pre/post process sources
items:
type: string
@@ -2761,9 +2745,8 @@ spec:
to interpret this source code
type: string
loader:
- description: |-
- Loader is an optional id of the org.apache.camel.k.RoutesLoader that will
- interpret this source at runtime
+ description: Loader is an optional id of the org.apache.camel.k.RoutesLoader
+ that will interpret this source at runtime
type: string
name:
description: the name of the specification
@@ -2809,14 +2792,13 @@ spec:
for the builder pod.
type: object
baseImage:
- description: |-
- Specify a base image. In order to have the application working properly it must be a container image which has a Java JDK
- installed and ready to use on path (ie `/usr/bin/java`).
+ description: Specify a base image. In order to have the application
+ working properly it must be a container image which has
+ a Java JDK installed and ready to use on path (ie `/usr/bin/java`).
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -2827,21 +2809,27 @@ spec:
existing containers (default `true`)
type: boolean
limitCPU:
- description: |-
- When using `pod` strategy, the maximum amount of CPU required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the maximum amount
+ of CPU required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
limitMemory:
- description: |-
- When using `pod` strategy, the maximum amount of memory required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the maximum amount
+ of memory required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
mavenProfiles:
- description: |-
- A list of references pointing to configmaps/secrets that contains a maven profile.
- This configmap/secret is a resource of the IntegrationKit created, therefore it needs to be present in the namespace where the operator is going to create the IntegrationKit.
- The content of the maven profile is expected to be a text containing a valid maven profile starting with `` and ending with `` that will be integrated as an inline profile in the POM.
- Syntax: [configmap|secret]:name[/key], where name represents the resource name, key optionally represents the resource key to be filtered (default key value = profile.xml).
+ description: 'A list of references pointing to configmaps/secrets
+ that contains a maven profile. This configmap/secret is
+ a resource of the IntegrationKit created, therefore it needs
+ to be present in the namespace where the operator is going
+ to create the IntegrationKit. The content of the maven profile
+ is expected to be a text containing a valid maven profile
+ starting with `` and ending with `` that
+ will be integrated as an inline profile in the POM. Syntax:
+ [configmap|secret]:name[/key], where name represents the
+ resource name, key optionally represents the resource key
+ to be filtered (default key value = profile.xml).'
items:
type: string
type: array
@@ -2872,14 +2860,14 @@ spec:
type: string
type: array
requestCPU:
- description: |-
- When using `pod` strategy, the minimum amount of CPU required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the minimum amount
+ of CPU required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
requestMemory:
- description: |-
- When using `pod` strategy, the minimum amount of memory required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the minimum amount
+ of memory required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
strategy:
description: The strategy to use, either `pod` or `routine`
@@ -2895,10 +2883,11 @@ spec:
type: string
type: array
tasksFilter:
- description: |-
- A list of tasks sorted by the order of execution in a csv format, ie, `,,...`.
- Mind that you must include also the operator tasks (`builder`, `quarkus-native`, `package`, `jib`, `s2i`)
- if you need to execute them. Useful only with `pod` strategy.
+ description: A list of tasks sorted by the order of execution
+ in a csv format, ie, `,,...`. Mind
+ that you must include also the operator tasks (`builder`,
+ `quarkus-native`, `package`, `jib`, `s2i`) if you need to
+ execute them. Useful only with `pod` strategy.
type: string
tasksLimitCPU:
description: A list of limit cpu configuration for the specific
@@ -2925,18 +2914,17 @@ spec:
type: string
type: array
verbose:
- description: |-
- Enable verbose logging on build components that support it (e.g. Kaniko build pod).
- Deprecated no longer in use
+ description: Enable verbose logging on build components that
+ support it (e.g. Kaniko build pod). Deprecated no longer
+ in use
type: boolean
type: object
camel:
description: The Camel trait sets up Camel configuration.
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -2949,23 +2937,25 @@ spec:
type: string
type: array
runtimeVersion:
- description: |-
- The camel-k-runtime version to use for the integration. It overrides the default version set in the Integration Platform.
- You can use a fixed version (for example "3.2.3") or a semantic version (for example "3.x") which will try to resolve
- to the best matching Catalog existing on the cluster.
+ description: The camel-k-runtime version to use for the integration.
+ It overrides the default version set in the Integration
+ Platform. You can use a fixed version (for example "3.2.3")
+ or a semantic version (for example "3.x") which will try
+ to resolve to the best matching Catalog existing on the
+ cluster.
type: string
type: object
quarkus:
- description: |-
- The Quarkus trait configures the Quarkus runtime.
- It's enabled by default.
- NOTE: Compiling to a native executable, requires at least 4GiB of memory, so the Pod running the native build must have enough memory available.
+ description: 'The Quarkus trait configures the Quarkus runtime.
+ It''s enabled by default. NOTE: Compiling to a native executable,
+ requires at least 4GiB of memory, so the Pod running the native
+ build must have enough memory available.'
properties:
buildMode:
- description: |-
- The Quarkus mode to run: either `jvm` or `native` (default `jvm`).
- In case both `jvm` and `native` are specified, two `IntegrationKit` resources are created,
- with the `native` kit having precedence over the `jvm` one once ready.
+ description: 'The Quarkus mode to run: either `jvm` or `native`
+ (default `jvm`). In case both `jvm` and `native` are specified,
+ two `IntegrationKit` resources are created, with the `native`
+ kit having precedence over the `jvm` one once ready.'
items:
description: QuarkusMode is the type of Quarkus build packaging.
enum:
@@ -2974,9 +2964,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -2992,18 +2981,18 @@ spec:
in the runtime catalog)
type: string
packageTypes:
- description: |-
- The Quarkus package types, `fast-jar` or `native` (default `fast-jar`).
- In case both `fast-jar` and `native` are specified, two `IntegrationKit` resources are created,
- with the native kit having precedence over the `fast-jar` one once ready.
- The order influences the resolution of the current kit for the integration.
- The kit corresponding to the first package type will be assigned to the
- integration in case no existing kit that matches the integration exists.
- Deprecated: use `build-mode` instead.
+ description: 'The Quarkus package types, `fast-jar` or `native`
+ (default `fast-jar`). In case both `fast-jar` and `native`
+ are specified, two `IntegrationKit` resources are created,
+ with the native kit having precedence over the `fast-jar`
+ one once ready. The order influences the resolution of the
+ current kit for the integration. The kit corresponding to
+ the first package type will be assigned to the integration
+ in case no existing kit that matches the integration exists.
+ Deprecated: use `build-mode` instead.'
items:
- description: |-
- QuarkusPackageType is the type of Quarkus build packaging.
- Deprecated: use `QuarkusMode` instead.
+ description: 'QuarkusPackageType is the type of Quarkus
+ build packaging. Deprecated: use `QuarkusMode` instead.'
enum:
- fast-jar
- native
@@ -3011,14 +3000,13 @@ spec:
type: array
type: object
registry:
- description: |-
- The Registry trait sets up Maven to use the Image registry as a Maven repository (support removed since version 2.5.0).
- Deprecated: use jvm trait or read documentation.
+ description: 'The Registry trait sets up Maven to use the Image
+ registry as a Maven repository (support removed since version
+ 2.5.0). Deprecated: use jvm trait or read documentation.'
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3159,12 +3147,19 @@ spec:
storage: true
subresources:
status: {}
+status:
+ acceptedNames:
+ kind: ""
+ plural: ""
+ conditions: []
+ storedVersions: []
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
- controller-gen.kubebuilder.io/version: v0.15.0
+ controller-gen.kubebuilder.io/version: v0.6.1
+ creationTimestamp: null
labels:
app: camel-k
name: integrationplatforms.camel.apache.org
@@ -3206,26 +3201,21 @@ spec:
name: v1
schema:
openAPIV3Schema:
- description: |-
- IntegrationPlatform is the resource used to drive the Camel K operator behavior.
- It defines the behavior of all Custom Resources (`IntegrationKit`, `Integration`, `Kamelet`) in the given namespace.
- When the Camel K operator is installed in `global` mode,
- you will need to specify an `IntegrationPlatform` in each namespace where you want the Camel K operator to be executed.
+ description: IntegrationPlatform is the resource used to drive the Camel K
+ operator behavior. It defines the behavior of all Custom Resources (`IntegrationKit`,
+ `Integration`, `Kamelet`) in the given namespace. When the Camel K operator
+ is installed in `global` mode, you will need to specify an `IntegrationPlatform`
+ in each namespace where you want the Camel K operator to be executed.
properties:
apiVersion:
- description: |-
- APIVersion defines the versioned schema of this representation of an object.
- Servers should convert recognized schemas to the latest internal value, and
- may reject unrecognized values.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+ description: 'APIVersion defines the versioned schema of this representation
+ of an object. Servers should convert recognized schemas to the latest
+ internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: |-
- Kind is a string value representing the REST resource this object represents.
- Servers may infer this from the endpoint the client submits requests to.
- Cannot be updated.
- In CamelCase.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ description: 'Kind is a string value representing the REST resource this
+ object represents. Servers may infer this from the endpoint the client
+ submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
@@ -3241,14 +3231,13 @@ spec:
description: 'Deprecated: no longer in use'
type: object
baseImage:
- description: |-
- a base image that can be used as base layer for all images.
- It can be useful if you want to provide some custom base image with further utility software
+ description: a base image that can be used as base layer for all
+ images. It can be useful if you want to provide some custom
+ base image with further utility software
type: string
buildCatalogToolTimeout:
- description: |-
- the timeout (in seconds) to use when creating the build tools container image
- Deprecated: no longer in use
+ description: 'the timeout (in seconds) to use when creating the
+ build tools container image Deprecated: no longer in use'
type: string
buildConfiguration:
description: the configuration required to build an Integration
@@ -3314,13 +3303,13 @@ spec:
applications
properties:
caSecrets:
- description: |-
- The Secrets name and key, containing the CA certificate(s) used to connect
- to remote Maven repositories.
- It can contain X.509 certificates, and PKCS#7 formatted certificate chains.
- A JKS formatted keystore is automatically created to store the CA certificate(s),
- and configured to be used as a trusted certificate(s) by the Maven commands.
- Note that the root CA certificates are also imported into the created keystore.
+ description: The Secrets name and key, containing the CA certificate(s)
+ used to connect to remote Maven repositories. It can contain
+ X.509 certificates, and PKCS#7 formatted certificate chains.
+ A JKS formatted keystore is automatically created to store
+ the CA certificate(s), and configured to be used as a trusted
+ certificate(s) by the Maven commands. Note that the root
+ CA certificates are also imported into the created keystore.
items:
description: SecretKeySelector selects a key of a Secret.
properties:
@@ -3329,10 +3318,8 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
description: Specify whether the Secret or its key must
@@ -3341,20 +3328,16 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: array
cliOptions:
- description: |-
- The CLI options that are appended to the list of arguments for Maven commands,
- e.g., `-V,--no-transfer-progress,-Dstyle.color=never`.
+ description: The CLI options that are appended to the list
+ of arguments for Maven commands, e.g., `-V,--no-transfer-progress,-Dstyle.color=never`.
See https://maven.apache.org/ref/3.8.4/maven-embedder/cli.html.
items:
type: string
type: array
extension:
- description: |-
- The Maven build extensions.
- See https://maven.apache.org/guides/mini/guide-using-extensions.html.
+ description: The Maven build extensions. See https://maven.apache.org/guides/mini/guide-using-extensions.html.
items:
description: MavenArtifact defines a GAV (Group:Artifact:Type:Version:Classifier)
Maven artifact.
@@ -3383,9 +3366,8 @@ spec:
description: The path of the local Maven repository.
type: string
profiles:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the Maven profile.
+ description: A reference to the ConfigMap or Secret key that
+ contains the Maven profile.
items:
description: ValueSource --.
properties:
@@ -3396,10 +3378,9 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the ConfigMap or its
@@ -3408,7 +3389,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -3417,10 +3397,9 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the Secret or its key
@@ -3429,7 +3408,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
properties:
@@ -3438,9 +3416,8 @@ spec:
description: The Maven properties.
type: object
settings:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the Maven settings.
+ description: A reference to the ConfigMap or Secret key that
+ contains the Maven settings.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -3449,10 +3426,9 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the ConfigMap or its
@@ -3461,7 +3437,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -3470,10 +3445,9 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the Secret or its key
@@ -3482,12 +3456,10 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
settingsSecurity:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the security of the Maven settings.
+ description: A reference to the ConfigMap or Secret key that
+ contains the security of the Maven settings.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -3496,10 +3468,9 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the ConfigMap or its
@@ -3508,7 +3479,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -3517,10 +3487,9 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the Secret or its key
@@ -3529,7 +3498,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: object
maxRunningBuilds:
@@ -3580,13 +3548,12 @@ spec:
or OpenShift)
type: string
configuration:
- description: |-
- Deprecated:
- Use camel trait (camel.properties) to manage properties
- Use mount trait (mount.configs) to manage configs
- Use mount trait (mount.resources) to manage resources
- Use mount trait (mount.volumes) to manage volumes
- list of configuration properties to be attached to all the Integration/IntegrationKits built from this IntegrationPlatform
+ description: 'Deprecated: Use camel trait (camel.properties) to manage
+ properties Use mount trait (mount.configs) to manage configs Use
+ mount trait (mount.resources) to manage resources Use mount trait
+ (mount.volumes) to manage volumes list of configuration properties
+ to be attached to all the Integration/IntegrationKits built from
+ this IntegrationPlatform'
items:
description: ConfigurationSpec represents a generic configuration
specification.
@@ -3621,9 +3588,10 @@ spec:
type: array
type: object
profile:
- description: |-
- the profile you wish to use. It will apply certain traits which are required by the specific profile chosen.
- It usually relates the Cluster with the optional definition of special profiles (ie, Knative)
+ description: the profile you wish to use. It will apply certain traits
+ which are required by the specific profile chosen. It usually relates
+ the Cluster with the optional definition of special profiles (ie,
+ Knative)
type: string
traits:
description: list of traits to be executed for all the Integration/IntegrationKits
@@ -3651,9 +3619,8 @@ spec:
description: The configuration of Affinity trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3672,9 +3639,9 @@ spec:
in the same node (default `false`).
type: boolean
podAffinityLabels:
- description: |-
- Defines a set of pods (namely those matching the label selector, relative to the given namespace) that the
- integration pod(s) should be co-located with.
+ description: Defines a set of pods (namely those matching
+ the label selector, relative to the given namespace) that
+ the integration pod(s) should be co-located with.
items:
type: string
type: array
@@ -3683,9 +3650,9 @@ spec:
in the same node (default `false`).
type: boolean
podAntiAffinityLabels:
- description: |-
- Defines a set of pods (namely those matching the label selector, relative to the given namespace) that the
- integration pod(s) should not be co-located with.
+ description: Defines a set of pods (namely those matching
+ the label selector, relative to the given namespace) that
+ the integration pod(s) should not be co-located with.
items:
type: string
type: array
@@ -3700,14 +3667,13 @@ spec:
for the builder pod.
type: object
baseImage:
- description: |-
- Specify a base image. In order to have the application working properly it must be a container image which has a Java JDK
- installed and ready to use on path (ie `/usr/bin/java`).
+ description: Specify a base image. In order to have the application
+ working properly it must be a container image which has
+ a Java JDK installed and ready to use on path (ie `/usr/bin/java`).
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3718,21 +3684,27 @@ spec:
existing containers (default `true`)
type: boolean
limitCPU:
- description: |-
- When using `pod` strategy, the maximum amount of CPU required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the maximum amount
+ of CPU required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
limitMemory:
- description: |-
- When using `pod` strategy, the maximum amount of memory required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the maximum amount
+ of memory required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
mavenProfiles:
- description: |-
- A list of references pointing to configmaps/secrets that contains a maven profile.
- This configmap/secret is a resource of the IntegrationKit created, therefore it needs to be present in the namespace where the operator is going to create the IntegrationKit.
- The content of the maven profile is expected to be a text containing a valid maven profile starting with `` and ending with `` that will be integrated as an inline profile in the POM.
- Syntax: [configmap|secret]:name[/key], where name represents the resource name, key optionally represents the resource key to be filtered (default key value = profile.xml).
+ description: 'A list of references pointing to configmaps/secrets
+ that contains a maven profile. This configmap/secret is
+ a resource of the IntegrationKit created, therefore it needs
+ to be present in the namespace where the operator is going
+ to create the IntegrationKit. The content of the maven profile
+ is expected to be a text containing a valid maven profile
+ starting with `` and ending with `` that
+ will be integrated as an inline profile in the POM. Syntax:
+ [configmap|secret]:name[/key], where name represents the
+ resource name, key optionally represents the resource key
+ to be filtered (default key value = profile.xml).'
items:
type: string
type: array
@@ -3763,14 +3735,14 @@ spec:
type: string
type: array
requestCPU:
- description: |-
- When using `pod` strategy, the minimum amount of CPU required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the minimum amount
+ of CPU required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
requestMemory:
- description: |-
- When using `pod` strategy, the minimum amount of memory required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the minimum amount
+ of memory required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
strategy:
description: The strategy to use, either `pod` or `routine`
@@ -3786,10 +3758,11 @@ spec:
type: string
type: array
tasksFilter:
- description: |-
- A list of tasks sorted by the order of execution in a csv format, ie, `,,...`.
- Mind that you must include also the operator tasks (`builder`, `quarkus-native`, `package`, `jib`, `s2i`)
- if you need to execute them. Useful only with `pod` strategy.
+ description: A list of tasks sorted by the order of execution
+ in a csv format, ie, `,,...`. Mind
+ that you must include also the operator tasks (`builder`,
+ `quarkus-native`, `package`, `jib`, `s2i`) if you need to
+ execute them. Useful only with `pod` strategy.
type: string
tasksLimitCPU:
description: A list of limit cpu configuration for the specific
@@ -3816,18 +3789,17 @@ spec:
type: string
type: array
verbose:
- description: |-
- Enable verbose logging on build components that support it (e.g. Kaniko build pod).
- Deprecated no longer in use
+ description: Enable verbose logging on build components that
+ support it (e.g. Kaniko build pod). Deprecated no longer
+ in use
type: boolean
type: object
camel:
description: The configuration of Camel trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3840,10 +3812,12 @@ spec:
type: string
type: array
runtimeVersion:
- description: |-
- The camel-k-runtime version to use for the integration. It overrides the default version set in the Integration Platform.
- You can use a fixed version (for example "3.2.3") or a semantic version (for example "3.x") which will try to resolve
- to the best matching Catalog existing on the cluster.
+ description: The camel-k-runtime version to use for the integration.
+ It overrides the default version set in the Integration
+ Platform. You can use a fixed version (for example "3.2.3")
+ or a semantic version (for example "3.x") which will try
+ to resolve to the best matching Catalog existing on the
+ cluster.
type: string
type: object
container:
@@ -3871,9 +3845,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3884,10 +3857,13 @@ spec:
Service.
type: boolean
image:
- description: |-
- The main container image to use for the Integration. When using this parameter the operator will create a synthetic IntegrationKit which
- won't be able to execute traits requiring CamelCatalog. If the container image you're using is coming from an IntegrationKit, use instead
- Integration `.spec.integrationKit` parameter. If you're moving the Integration across environments, you will also need to create an "external" IntegrationKit.
+ description: The main container image to use for the Integration.
+ When using this parameter the operator will create a synthetic
+ IntegrationKit which won't be able to execute traits requiring
+ CamelCatalog. If the container image you're using is coming
+ from an IntegrationKit, use instead Integration `.spec.integrationKit`
+ parameter. If you're moving the Integration across environments,
+ you will also need to create an "external" IntegrationKit.
type: string
imagePullPolicy:
description: 'The pull policy: Always|Never|IfNotPresent'
@@ -3955,52 +3931,50 @@ spec:
description: The configuration of Cron trait
properties:
activeDeadlineSeconds:
- description: |-
- Specifies the duration in seconds, relative to the start time, that the job
- may be continuously active before it is considered to be failed.
- It defaults to 60s.
+ description: Specifies the duration in seconds, relative to
+ the start time, that the job may be continuously active
+ before it is considered to be failed. It defaults to 60s.
format: int64
type: integer
auto:
- description: |-
- Automatically deploy the integration as CronJob when all routes are
- either starting from a periodic consumer (only `cron`, `timer` and `quartz` are supported) or a passive consumer (e.g. `direct` is a passive consumer).
-
-
- It's required that all periodic consumers have the same period, and it can be expressed as cron schedule (e.g. `1m` can be expressed as `0/1 * * * *`,
- while `35m` or `50s` cannot).
+ description: "Automatically deploy the integration as CronJob
+ when all routes are either starting from a periodic consumer
+ (only `cron`, `timer` and `quartz` are supported) or a passive
+ consumer (e.g. `direct` is a passive consumer). \n It's
+ required that all periodic consumers have the same period,
+ and it can be expressed as cron schedule (e.g. `1m` can
+ be expressed as `0/1 * * * *`, while `35m` or `50s` cannot)."
type: boolean
backoffLimit:
- description: |-
- Specifies the number of retries before marking the job failed.
- It defaults to 2.
+ description: Specifies the number of retries before marking
+ the job failed. It defaults to 2.
format: int32
type: integer
components:
- description: |-
- A comma separated list of the Camel components that need to be customized in order for them to work when the schedule is triggered externally by Kubernetes.
- A specific customizer is activated for each specified component. E.g. for the `timer` component, the `cron-timer` customizer is
- activated (it's present in the `org.apache.camel.k:camel-k-cron` library).
-
-
- Supported components are currently: `cron`, `timer` and `quartz`.
+ description: "A comma separated list of the Camel components
+ that need to be customized in order for them to work when
+ the schedule is triggered externally by Kubernetes. A specific
+ customizer is activated for each specified component. E.g.
+ for the `timer` component, the `cron-timer` customizer is
+ activated (it's present in the `org.apache.camel.k:camel-k-cron`
+ library). \n Supported components are currently: `cron`,
+ `timer` and `quartz`."
type: string
concurrencyPolicy:
- description: |-
- Specifies how to treat concurrent executions of a Job.
- Valid values are:
- - "Allow": allows CronJobs to run concurrently;
- - "Forbid" (default): forbids concurrent runs, skipping next run if previous run hasn't finished yet;
- - "Replace": cancels currently running job and replaces it with a new one
+ description: 'Specifies how to treat concurrent executions
+ of a Job. Valid values are: - "Allow": allows CronJobs to
+ run concurrently; - "Forbid" (default): forbids concurrent
+ runs, skipping next run if previous run hasn''t finished
+ yet; - "Replace": cancels currently running job and replaces
+ it with a new one'
enum:
- Allow
- Forbid
- Replace
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -4008,19 +3982,19 @@ spec:
traits share this common property.
type: boolean
fallback:
- description: |-
- Use the default Camel implementation of the `cron` endpoint (`quartz`) instead of trying to materialize the integration
- as Kubernetes CronJob.
+ description: Use the default Camel implementation of the `cron`
+ endpoint (`quartz`) instead of trying to materialize the
+ integration as Kubernetes CronJob.
type: boolean
schedule:
- description: |-
- The CronJob schedule for the whole integration. If multiple routes are declared, they must have the same schedule for this
- mechanism to work correctly.
+ description: The CronJob schedule for the whole integration.
+ If multiple routes are declared, they must have the same
+ schedule for this mechanism to work correctly.
type: string
startingDeadlineSeconds:
- description: |-
- Optional deadline in seconds for starting the job if it misses scheduled
- time for any reason. Missed jobs executions will be counted as failed ones.
+ description: Optional deadline in seconds for starting the
+ job if it misses scheduled time for any reason. Missed
+ jobs executions will be counted as failed ones.
format: int64
type: integer
timeZone:
@@ -4031,9 +4005,8 @@ spec:
description: The configuration of Dependencies trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -4044,9 +4017,8 @@ spec:
description: The configuration of Deployer trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -4062,51 +4034,49 @@ spec:
- knative-service
type: string
useSSA:
- description: |-
- Use server-side apply to update the owned resources (default `true`).
- Note that it automatically falls back to client-side patching, if SSA is not available, e.g., on old Kubernetes clusters.
+ description: Use server-side apply to update the owned resources
+ (default `true`). Note that it automatically falls back
+ to client-side patching, if SSA is not available, e.g.,
+ on old Kubernetes clusters.
type: boolean
type: object
deployment:
description: The configuration of Deployment trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
description: 'Deprecated: no longer in use.'
type: boolean
progressDeadlineSeconds:
- description: |-
- The maximum time in seconds for the deployment to make progress before it
- is considered to be failed. It defaults to `60s`.
+ description: The maximum time in seconds for the deployment
+ to make progress before it is considered to be failed. It
+ defaults to `60s`.
format: int32
type: integer
rollingUpdateMaxSurge:
anyOf:
- type: integer
- type: string
- description: |-
- The maximum number of pods that can be scheduled above the desired number of
- pods.
- Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
- This can not be 0 if MaxUnavailable is 0.
- Absolute number is calculated from percentage by rounding up.
- Defaults to `25%`.
+ description: 'The maximum number of pods that can be scheduled
+ above the desired number of pods. Value can be an absolute
+ number (ex: 5) or a percentage of desired pods (ex: 10%).
+ This can not be 0 if MaxUnavailable is 0. Absolute number
+ is calculated from percentage by rounding up. Defaults to
+ `25%`.'
x-kubernetes-int-or-string: true
rollingUpdateMaxUnavailable:
anyOf:
- type: integer
- type: string
- description: |-
- The maximum number of pods that can be unavailable during the update.
- Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
- Absolute number is calculated from percentage by rounding down.
- This can not be 0 if MaxSurge is 0.
- Defaults to `25%`.
+ description: 'The maximum number of pods that can be unavailable
+ during the update. Value can be an absolute number (ex:
+ 5) or a percentage of desired pods (ex: 10%). Absolute number
+ is calculated from percentage by rounding down. This can
+ not be 0 if MaxSurge is 0. Defaults to `25%`.'
x-kubernetes-int-or-string: true
strategy:
description: The deployment strategy to use to replace existing
@@ -4120,9 +4090,8 @@ spec:
description: The configuration of Environment trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
containerMeta:
@@ -4137,11 +4106,12 @@ spec:
`NO_PROXY` environment variables (default `true`)
type: boolean
vars:
- description: |-
- A list of environment variables to be added to the integration container.
- The syntax is either VAR=VALUE or VAR=[configmap|secret]:name/key, where name represents the resource name,
- and key represents the resource key to be mapped as and environment variable.
- These take precedence over any previously defined environment variables.
+ description: A list of environment variables to be added to
+ the integration container. The syntax is either VAR=VALUE
+ or VAR=[configmap|secret]:name/key, where name represents
+ the resource name, and key represents the resource key to
+ be mapped as and environment variable. These take precedence
+ over any previously defined environment variables.
items:
type: string
type: array
@@ -4150,9 +4120,8 @@ spec:
description: The configuration of Error Handler trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -4167,15 +4136,14 @@ spec:
description: The configuration of GC trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
discoveryCache:
- description: |-
- Discovery client cache to be used, either `disabled`, `disk` or `memory` (default `memory`).
- Deprecated: to be removed from trait configuration.
+ description: 'Discovery client cache to be used, either `disabled`,
+ `disk` or `memory` (default `memory`). Deprecated: to be
+ removed from trait configuration.'
enum:
- disabled
- disk
@@ -4190,9 +4158,8 @@ spec:
description: The configuration of Health trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -4314,19 +4281,17 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to the ingress.
- This can be used to set controller specific annotations, e.g., when using the NGINX Ingress controller:
- See https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md
+ description: 'The annotations added to the ingress. This can
+ be used to set controller specific annotations, e.g., when
+ using the NGINX Ingress controller: See https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md'
type: object
auto:
description: To automatically add an ingress whenever the
integration uses an HTTP endpoint consumer.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -4336,14 +4301,18 @@ spec:
host:
description: To configure the host exposed by the ingress.
type: string
+ ingressClassName:
+ description: The Ingress class name as defined by the Ingress
+ spec See https://kubernetes.io/docs/concepts/services-networking/ingress/
+ type: string
path:
description: To configure the path exposed by the ingress
(default `/`).
type: string
pathType:
- description: |-
- To configure the path type exposed by the ingress.
- One of `Exact`, `Prefix`, `ImplementationSpecific` (default to `Prefix`).
+ description: To configure the path type exposed by the ingress.
+ One of `Exact`, `Prefix`, `ImplementationSpecific` (default
+ to `Prefix`).
enum:
- Exact
- Prefix
@@ -4367,9 +4336,8 @@ spec:
by default).
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -4386,23 +4354,25 @@ spec:
description: The configuration of Jolokia trait
properties:
CACert:
- description: |-
- The PEM encoded CA certification file path, used to verify client certificates,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt` for OpenShift).
+ description: The PEM encoded CA certification file path, used
+ to verify client certificates, applicable when `protocol`
+ is `https` and `use-ssl-client-authentication` is `true`
+ (default `/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt`
+ for OpenShift).
type: string
clientPrincipal:
- description: |-
- The principal(s) which must be given in a client certificate to allow access to the Jolokia endpoint,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `clientPrincipal=cn=system:master-proxy`, `cn=hawtio-online.hawtio.svc` and `cn=fuse-console.fuse.svc` for OpenShift).
+ description: The principal(s) which must be given in a client
+ certificate to allow access to the Jolokia endpoint, applicable
+ when `protocol` is `https` and `use-ssl-client-authentication`
+ is `true` (default `clientPrincipal=cn=system:master-proxy`,
+ `cn=hawtio-online.hawtio.svc` and `cn=fuse-console.fuse.svc`
+ for OpenShift).
items:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
discoveryEnabled:
@@ -4413,20 +4383,20 @@ spec:
traits share this common property.
type: boolean
extendedClientCheck:
- description: |-
- Mandate the client certificate contains a client flag in the extended key usage section,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `true` for OpenShift).
+ description: Mandate the client certificate contains a client
+ flag in the extended key usage section, applicable when
+ `protocol` is `https` and `use-ssl-client-authentication`
+ is `true` (default `true` for OpenShift).
type: boolean
host:
- description: |-
- The Host address to which the Jolokia agent should bind to. If `"\*"` or `"0.0.0.0"` is given,
- the servers binds to every network interface (default `"*"`).
+ description: The Host address to which the Jolokia agent should
+ bind to. If `"\*"` or `"0.0.0.0"` is given, the servers
+ binds to every network interface (default `"*"`).
type: string
options:
- description: |-
- A list of additional Jolokia options as defined
- in https://jolokia.org/reference/html/agents.html#agent-jvm-config[JVM agent configuration options]
+ description: A list of additional Jolokia options as defined
+ in https://jolokia.org/reference/html/agents.html#agent-jvm-config[JVM
+ agent configuration options]
items:
type: string
type: array
@@ -4457,9 +4427,8 @@ spec:
separator)
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
debug:
@@ -4488,9 +4457,9 @@ spec:
type: string
type: array
printCommand:
- description: |-
- Prints the command used the start the JVM in the container logs (default `true`)
- Deprecated: no longer in use.
+ description: 'Prints the command used the start the JVM in
+ the container logs (default `true`) Deprecated: no longer
+ in use.'
type: boolean
type: object
kamelets:
@@ -4501,9 +4470,8 @@ spec:
and their default configuration (enabled by default)
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -4536,16 +4504,14 @@ spec:
description: Enable automatic discovery of all trait properties.
type: boolean
channelSinks:
- description: |-
- List of channels used as destination of integration routes.
- Can contain simple channel names or full Camel URIs.
+ description: List of channels used as destination of integration
+ routes. Can contain simple channel names or full Camel URIs.
items:
type: string
type: array
channelSources:
- description: |-
- List of channels used as source of integration routes.
- Can contain simple channel names or full Camel URIs.
+ description: List of channels used as source of integration
+ routes. Can contain simple channel names or full Camel URIs.
items:
type: string
type: array
@@ -4554,9 +4520,8 @@ spec:
in JSON format.
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -4564,9 +4529,9 @@ spec:
traits share this common property.
type: boolean
endpointSinks:
- description: |-
- List of endpoints used as destination of integration routes.
- Can contain simple endpoint names or full Camel URIs.
+ description: List of endpoints used as destination of integration
+ routes. Can contain simple endpoint names or full Camel
+ URIs.
items:
type: string
type: array
@@ -4577,50 +4542,54 @@ spec:
type: string
type: array
eventSinks:
- description: |-
- List of event types that the integration will produce.
- Can contain simple event types or full Camel URIs (to use a specific broker).
+ description: List of event types that the integration will
+ produce. Can contain simple event types or full Camel URIs
+ (to use a specific broker).
items:
type: string
type: array
eventSources:
- description: |-
- List of event types that the integration will be subscribed to.
- Can contain simple event types or full Camel URIs (to use a specific broker different from "default").
+ description: List of event types that the integration will
+ be subscribed to. Can contain simple event types or full
+ Camel URIs (to use a specific broker different from "default").
items:
type: string
type: array
filterEventType:
- description: |-
- Enables the default filtering for the Knative trigger using the event type
- If this is true, the created Knative trigger uses the event type as a filter on the event stream when no other filter criteria is given. (default: true)
+ description: 'Enables the default filtering for the Knative
+ trigger using the event type If this is true, the created
+ Knative trigger uses the event type as a filter on the event
+ stream when no other filter criteria is given. (default:
+ true)'
type: boolean
filterSourceChannels:
- description: |-
- Enables filtering on events based on the header "ce-knativehistory". Since this header has been removed in newer versions of
- Knative, filtering is disabled by default.
+ description: Enables filtering on events based on the header
+ "ce-knativehistory". Since this header has been removed
+ in newer versions of Knative, filtering is disabled by default.
type: boolean
filters:
- description: |-
- Sets filter attributes on the event stream (such as event type, source, subject and so on).
- A list of key-value pairs that represent filter attributes and its values.
- The syntax is KEY=VALUE, e.g., `source="my.source"`.
- Filter attributes get set on the Knative trigger that is being created as part of this integration.
+ description: Sets filter attributes on the event stream (such
+ as event type, source, subject and so on). A list of key-value
+ pairs that represent filter attributes and its values. The
+ syntax is KEY=VALUE, e.g., `source="my.source"`. Filter
+ attributes get set on the Knative trigger that is being
+ created as part of this integration.
items:
type: string
type: array
namespaceLabel:
- description: |-
- Enables the camel-k-operator to set the "bindings.knative.dev/include=true" label to the namespace
- As Knative requires this label to perform injection of K_SINK URL into the service.
- If this is false, the integration pod may start and fail, read the SinkBinding Knative documentation. (default: true)
+ description: 'Enables the camel-k-operator to set the "bindings.knative.dev/include=true"
+ label to the namespace As Knative requires this label to
+ perform injection of K_SINK URL into the service. If this
+ is false, the integration pod may start and fail, read the
+ SinkBinding Knative documentation. (default: true)'
type: boolean
sinkBinding:
- description: |-
- Allows binding the integration to a sink via a Knative SinkBinding resource.
- This can be used when the integration targets a single sink.
- It's enabled by default when the integration targets a single sink
- (except when the integration is owned by a Knative source).
+ description: Allows binding the integration to a sink via
+ a Knative SinkBinding resource. This can be used when the
+ integration targets a single sink. It's enabled by default
+ when the integration targets a single sink (except when
+ the integration is owned by a Knative source).
type: boolean
type: object
knative-service:
@@ -4629,47 +4598,39 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to route.
- This can be used to set knative service specific annotations
- CLI usage example: -t "knative-service.annotations.'haproxy.router.openshift.io/balance'=true"
+ description: 'The annotations added to route. This can be
+ used to set knative service specific annotations CLI usage
+ example: -t "knative-service.annotations.''haproxy.router.openshift.io/balance''=true"'
type: object
auto:
- description: |-
- Automatically deploy the integration as Knative service when all conditions hold:
-
-
- * Integration is using the Knative profile
- * All routes are either starting from an HTTP based consumer or a passive consumer (e.g. `direct` is a passive consumer)
+ description: "Automatically deploy the integration as Knative
+ service when all conditions hold: \n * Integration is using
+ the Knative profile * All routes are either starting from
+ an HTTP based consumer or a passive consumer (e.g. `direct`
+ is a passive consumer)"
type: boolean
autoscalingMetric:
- description: |-
- Configures the Knative autoscaling metric property (e.g. to set `concurrency` based or `cpu` based autoscaling).
-
-
- Refer to the Knative documentation for more information.
+ description: "Configures the Knative autoscaling metric property
+ (e.g. to set `concurrency` based or `cpu` based autoscaling).
+ \n Refer to the Knative documentation for more information."
type: string
autoscalingTarget:
- description: |-
- Sets the allowed concurrency level or CPU percentage (depending on the autoscaling metric) for each Pod.
-
-
- Refer to the Knative documentation for more information.
+ description: "Sets the allowed concurrency level or CPU percentage
+ (depending on the autoscaling metric) for each Pod. \n Refer
+ to the Knative documentation for more information."
type: integer
class:
- description: |-
- Configures the Knative autoscaling class property (e.g. to set `hpa.autoscaling.knative.dev` or `kpa.autoscaling.knative.dev` autoscaling).
-
-
- Refer to the Knative documentation for more information.
+ description: "Configures the Knative autoscaling class property
+ (e.g. to set `hpa.autoscaling.knative.dev` or `kpa.autoscaling.knative.dev`
+ autoscaling). \n Refer to the Knative documentation for
+ more information."
enum:
- kpa.autoscaling.knative.dev
- hpa.autoscaling.knative.dev
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -4677,43 +4638,36 @@ spec:
traits share this common property.
type: boolean
maxScale:
- description: |-
- An upper bound for the number of Pods that can be running in parallel for the integration.
- Knative has its own cap value that depends on the installation.
-
-
- Refer to the Knative documentation for more information.
+ description: "An upper bound for the number of Pods that can
+ be running in parallel for the integration. Knative has
+ its own cap value that depends on the installation. \n Refer
+ to the Knative documentation for more information."
type: integer
minScale:
- description: |-
- The minimum number of Pods that should be running at any time for the integration. It's **zero** by default, meaning that
- the integration is scaled down to zero when not used for a configured amount of time.
-
-
- Refer to the Knative documentation for more information.
+ description: "The minimum number of Pods that should be running
+ at any time for the integration. It's **zero** by default,
+ meaning that the integration is scaled down to zero when
+ not used for a configured amount of time. \n Refer to the
+ Knative documentation for more information."
type: integer
rolloutDuration:
- description: |-
- Enables to gradually shift traffic to the latest Revision and sets the rollout duration.
- It's disabled by default and must be expressed as a Golang `time.Duration` string representation,
- rounded to a second precision.
+ description: Enables to gradually shift traffic to the latest
+ Revision and sets the rollout duration. It's disabled by
+ default and must be expressed as a Golang `time.Duration`
+ string representation, rounded to a second precision.
type: string
timeoutSeconds:
- description: |-
- The maximum duration in seconds that the request instance is allowed to respond to a request.
- This field propagates to the integration pod's terminationGracePeriodSeconds
-
-
- Refer to the Knative documentation for more information.
+ description: "The maximum duration in seconds that the request
+ instance is allowed to respond to a request. This field
+ propagates to the integration pod's terminationGracePeriodSeconds
+ \n Refer to the Knative documentation for more information."
format: int64
type: integer
visibility:
- description: |-
- Setting `cluster-local`, Knative service becomes a private service.
- Specifically, this option applies the `networking.knative.dev/visibility` label to Knative service.
-
-
- Refer to the Knative documentation for more information.
+ description: "Setting `cluster-local`, Knative service becomes
+ a private service. Specifically, this option applies the
+ `networking.knative.dev/visibility` label to Knative service.
+ \n Refer to the Knative documentation for more information."
enum:
- cluster-local
type: string
@@ -4725,9 +4679,8 @@ spec:
description: Colorize the log output
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -4767,18 +4720,20 @@ spec:
description: The configuration of Mount trait
properties:
configs:
- description: |-
- A list of configuration pointing to configmap/secret.
- The configuration are expected to be UTF-8 resources as they are processed by runtime Camel Context and tried to be parsed as property files.
- They are also made available on the classpath in order to ease their usage directly from the Route.
- Syntax: [configmap|secret]:name[/key], where name represents the resource name and key optionally represents the resource key to be filtered
+ description: 'A list of configuration pointing to configmap/secret.
+ The configuration are expected to be UTF-8 resources as
+ they are processed by runtime Camel Context and tried to
+ be parsed as property files. They are also made available
+ on the classpath in order to ease their usage directly from
+ the Route. Syntax: [configmap|secret]:name[/key], where
+ name represents the resource name and key optionally represents
+ the resource key to be filtered'
items:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
emptyDirs:
@@ -4791,17 +4746,21 @@ spec:
description: 'Deprecated: no longer in use.'
type: boolean
hotReload:
- description: |-
- Enable "hot reload" when a secret/configmap mounted is edited (default `false`). The configmap/secret must be
- marked with `camel.apache.org/integration` label to be taken in account. The resource will be watched for any kind change, also for
- changes in metadata.
+ description: Enable "hot reload" when a secret/configmap mounted
+ is edited (default `false`). The configmap/secret must be
+ marked with `camel.apache.org/integration` label to be taken
+ in account. The resource will be watched for any kind change,
+ also for changes in metadata.
type: boolean
resources:
- description: |-
- A list of resources (text or binary content) pointing to configmap/secret.
- The resources are expected to be any resource type (text or binary content).
- The destination path can be either a default location or any path specified by the user.
- Syntax: [configmap|secret]:name[/key][@path], where name represents the resource name, key optionally represents the resource key to be filtered and path represents the destination path
+ description: 'A list of resources (text or binary content)
+ pointing to configmap/secret. The resources are expected
+ to be any resource type (text or binary content). The destination
+ path can be either a default location or any path specified
+ by the user. Syntax: [configmap|secret]:name[/key][@path],
+ where name represents the resource name, key optionally
+ represents the resource key to be filtered and path represents
+ the destination path'
items:
type: string
type: array
@@ -4826,9 +4785,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -4839,9 +4797,8 @@ spec:
description: The configuration of Owner trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -4863,9 +4820,8 @@ spec:
description: The configuration of PDB trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -4873,53 +4829,56 @@ spec:
traits share this common property.
type: boolean
maxUnavailable:
- description: |-
- The number of pods for the Integration that can be unavailable after an eviction.
- It can be either an absolute number or a percentage (default `1` if `min-available` is also not set).
- Only one of `max-unavailable` and `min-available` can be specified.
+ description: The number of pods for the Integration that can
+ be unavailable after an eviction. It can be either an absolute
+ number or a percentage (default `1` if `min-available` is
+ also not set). Only one of `max-unavailable` and `min-available`
+ can be specified.
type: string
minAvailable:
- description: |-
- The number of pods for the Integration that must still be available after an eviction.
- It can be either an absolute number or a percentage.
- Only one of `min-available` and `max-unavailable` can be specified.
+ description: The number of pods for the Integration that must
+ still be available after an eviction. It can be either an
+ absolute number or a percentage. Only one of `min-available`
+ and `max-unavailable` can be specified.
type: string
type: object
platform:
description: The configuration of Platform trait
properties:
auto:
- description: |-
- To automatically detect from the environment if a default platform can be created (it will be created on OpenShift or when a registry address is set).
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'To automatically detect from the environment
+ if a default platform can be created (it will be created
+ on OpenShift or when a registry address is set). Deprecated:
+ Platform is auto generated by the operator install procedure
+ - maintained for backward compatibility'
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
createDefault:
- description: |-
- To create a default (empty) platform when the platform is missing.
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'To create a default (empty) platform when the
+ platform is missing. Deprecated: Platform is auto generated
+ by the operator install procedure - maintained for backward
+ compatibility'
type: boolean
enabled:
description: 'Deprecated: no longer in use.'
type: boolean
global:
- description: |-
- Indicates if the platform should be created globally in the case of global operator (default true).
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'Indicates if the platform should be created
+ globally in the case of global operator (default true).
+ Deprecated: Platform is auto generated by the operator install
+ procedure - maintained for backward compatibility'
type: boolean
type: object
pod:
description: The configuration of Pod trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -4931,9 +4890,8 @@ spec:
description: The configuration of Prometheus trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -4959,9 +4917,8 @@ spec:
secret on the pod if it is of type `kubernetes.io/dockerconfigjson`.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -4984,10 +4941,10 @@ spec:
description: The configuration of Quarkus trait
properties:
buildMode:
- description: |-
- The Quarkus mode to run: either `jvm` or `native` (default `jvm`).
- In case both `jvm` and `native` are specified, two `IntegrationKit` resources are created,
- with the `native` kit having precedence over the `jvm` one once ready.
+ description: 'The Quarkus mode to run: either `jvm` or `native`
+ (default `jvm`). In case both `jvm` and `native` are specified,
+ two `IntegrationKit` resources are created, with the `native`
+ kit having precedence over the `jvm` one once ready.'
items:
description: QuarkusMode is the type of Quarkus build packaging.
enum:
@@ -4996,9 +4953,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -5014,18 +4970,18 @@ spec:
in the runtime catalog)
type: string
packageTypes:
- description: |-
- The Quarkus package types, `fast-jar` or `native` (default `fast-jar`).
- In case both `fast-jar` and `native` are specified, two `IntegrationKit` resources are created,
- with the native kit having precedence over the `fast-jar` one once ready.
- The order influences the resolution of the current kit for the integration.
- The kit corresponding to the first package type will be assigned to the
- integration in case no existing kit that matches the integration exists.
- Deprecated: use `build-mode` instead.
+ description: 'The Quarkus package types, `fast-jar` or `native`
+ (default `fast-jar`). In case both `fast-jar` and `native`
+ are specified, two `IntegrationKit` resources are created,
+ with the native kit having precedence over the `fast-jar`
+ one once ready. The order influences the resolution of the
+ current kit for the integration. The kit corresponding to
+ the first package type will be assigned to the integration
+ in case no existing kit that matches the integration exists.
+ Deprecated: use `build-mode` instead.'
items:
- description: |-
- QuarkusPackageType is the type of Quarkus build packaging.
- Deprecated: use `QuarkusMode` instead.
+ description: 'QuarkusPackageType is the type of Quarkus
+ build packaging. Deprecated: use `QuarkusMode` instead.'
enum:
- fast-jar
- native
@@ -5033,14 +4989,12 @@ spec:
type: array
type: object
registry:
- description: |-
- The configuration of Registry trait (support removed since version 2.5.0).
- Deprecated: use jvm trait or read documentation.
+ description: 'The configuration of Registry trait (support removed
+ since version 2.5.0). Deprecated: use jvm trait or read documentation.'
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -5054,16 +5008,14 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to route.
- This can be used to set route specific annotations
- For annotations options see https://docs.openshift.com/container-platform/3.11/architecture/networking/routes.html#route-specific-annotations
- CLI usage example: -t "route.annotations.'haproxy.router.openshift.io/balance'=true"
+ description: 'The annotations added to route. This can be
+ used to set route specific annotations For annotations options
+ see https://docs.openshift.com/container-platform/3.11/architecture/networking/routes.html#route-specific-annotations
+ CLI usage example: -t "route.annotations.''haproxy.router.openshift.io/balance''=true"'
type: object
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -5074,82 +5026,74 @@ spec:
description: To configure the host exposed by the route.
type: string
tlsCACertificate:
- description: |-
- The TLS CA certificate contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS CA certificate contents. \n Refer to
+ the OpenShift route documentation for additional information."
type: string
tlsCACertificateSecret:
- description: |-
- The secret name and key reference to the TLS CA certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the TLS
+ CA certificate. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only one
+ key in the secret it will be read, otherwise you can set
+ a key name separated with a \"/\". \n Refer to the OpenShift
+ route documentation for additional information."
type: string
tlsCertificate:
- description: |-
- The TLS certificate contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS certificate contents. \n Refer to the
+ OpenShift route documentation for additional information."
type: string
tlsCertificateSecret:
- description: |-
- The secret name and key reference to the TLS certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the TLS
+ certificate. The format is \"secret-name[/key-name]\", the
+ value represents the secret name, if there is only one key
+ in the secret it will be read, otherwise you can set a key
+ name separated with a \"/\". \n Refer to the OpenShift route
+ documentation for additional information."
type: string
tlsDestinationCACertificate:
- description: |-
- The destination CA certificate provides the contents of the ca certificate of the final destination. When using reencrypt
- termination this file should be provided in order to have routers use it for health checks on the secure connection.
- If this field is not specified, the router may provide its own destination CA and perform hostname validation using
- the short service name (service.namespace.svc), which allows infrastructure generated certificates to automatically
- verify.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The destination CA certificate provides the
+ contents of the ca certificate of the final destination.
+ \ When using reencrypt termination this file should be provided
+ in order to have routers use it for health checks on the
+ secure connection. If this field is not specified, the router
+ may provide its own destination CA and perform hostname
+ validation using the short service name (service.namespace.svc),
+ which allows infrastructure generated certificates to automatically
+ verify. \n Refer to the OpenShift route documentation for
+ additional information."
type: string
tlsDestinationCACertificateSecret:
- description: |-
- The secret name and key reference to the destination CA certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the destination
+ CA certificate. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only one
+ key in the secret it will be read, otherwise you can set
+ a key name separated with a \"/\". \n Refer to the OpenShift
+ route documentation for additional information."
type: string
tlsInsecureEdgeTerminationPolicy:
- description: |-
- To configure how to deal with insecure traffic, e.g. `Allow`, `Disable` or `Redirect` traffic.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "To configure how to deal with insecure traffic,
+ e.g. `Allow`, `Disable` or `Redirect` traffic. \n Refer
+ to the OpenShift route documentation for additional information."
enum:
- None
- Allow
- Redirect
type: string
tlsKey:
- description: |-
- The TLS certificate key contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS certificate key contents. \n Refer to
+ the OpenShift route documentation for additional information."
type: string
tlsKeySecret:
- description: |-
- The secret name and key reference to the TLS certificate key. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the TLS
+ certificate key. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only one
+ key in the secret it will be read, otherwise you can set
+ a key name separated with a \"/\". \n Refer to the OpenShift
+ route documentation for additional information."
type: string
tlsTermination:
- description: |-
- The TLS termination type, like `edge`, `passthrough` or `reencrypt`.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS termination type, like `edge`, `passthrough`
+ or `reencrypt`. \n Refer to the OpenShift route documentation
+ for additional information."
enum:
- edge
- reencrypt
@@ -5160,9 +5104,8 @@ spec:
description: The configuration of Security Context trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -5194,9 +5137,8 @@ spec:
needs to be created.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -5204,9 +5146,8 @@ spec:
traits share this common property.
type: boolean
nodePort:
- description: |-
- Enable Service to be exposed as NodePort (default `false`).
- Deprecated: Use service type instead.
+ description: 'Enable Service to be exposed as NodePort (default
+ `false`). Deprecated: Use service type instead.'
type: boolean
type:
description: The type of service to be used, either 'ClusterIP',
@@ -5221,9 +5162,8 @@ spec:
description: The configuration of Service Binding trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -5250,9 +5190,8 @@ spec:
description: The configuration of Toleration trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -5289,14 +5228,13 @@ spec:
description: 'Deprecated: no longer in use'
type: object
baseImage:
- description: |-
- a base image that can be used as base layer for all images.
- It can be useful if you want to provide some custom base image with further utility software
+ description: a base image that can be used as base layer for all
+ images. It can be useful if you want to provide some custom
+ base image with further utility software
type: string
buildCatalogToolTimeout:
- description: |-
- the timeout (in seconds) to use when creating the build tools container image
- Deprecated: no longer in use
+ description: 'the timeout (in seconds) to use when creating the
+ build tools container image Deprecated: no longer in use'
type: string
buildConfiguration:
description: the configuration required to build an Integration
@@ -5362,13 +5300,13 @@ spec:
applications
properties:
caSecrets:
- description: |-
- The Secrets name and key, containing the CA certificate(s) used to connect
- to remote Maven repositories.
- It can contain X.509 certificates, and PKCS#7 formatted certificate chains.
- A JKS formatted keystore is automatically created to store the CA certificate(s),
- and configured to be used as a trusted certificate(s) by the Maven commands.
- Note that the root CA certificates are also imported into the created keystore.
+ description: The Secrets name and key, containing the CA certificate(s)
+ used to connect to remote Maven repositories. It can contain
+ X.509 certificates, and PKCS#7 formatted certificate chains.
+ A JKS formatted keystore is automatically created to store
+ the CA certificate(s), and configured to be used as a trusted
+ certificate(s) by the Maven commands. Note that the root
+ CA certificates are also imported into the created keystore.
items:
description: SecretKeySelector selects a key of a Secret.
properties:
@@ -5377,10 +5315,8 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
description: Specify whether the Secret or its key must
@@ -5389,20 +5325,16 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: array
cliOptions:
- description: |-
- The CLI options that are appended to the list of arguments for Maven commands,
- e.g., `-V,--no-transfer-progress,-Dstyle.color=never`.
+ description: The CLI options that are appended to the list
+ of arguments for Maven commands, e.g., `-V,--no-transfer-progress,-Dstyle.color=never`.
See https://maven.apache.org/ref/3.8.4/maven-embedder/cli.html.
items:
type: string
type: array
extension:
- description: |-
- The Maven build extensions.
- See https://maven.apache.org/guides/mini/guide-using-extensions.html.
+ description: The Maven build extensions. See https://maven.apache.org/guides/mini/guide-using-extensions.html.
items:
description: MavenArtifact defines a GAV (Group:Artifact:Type:Version:Classifier)
Maven artifact.
@@ -5431,9 +5363,8 @@ spec:
description: The path of the local Maven repository.
type: string
profiles:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the Maven profile.
+ description: A reference to the ConfigMap or Secret key that
+ contains the Maven profile.
items:
description: ValueSource --.
properties:
@@ -5444,10 +5375,9 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the ConfigMap or its
@@ -5456,7 +5386,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -5465,10 +5394,9 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the Secret or its key
@@ -5477,7 +5405,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
properties:
@@ -5486,9 +5413,8 @@ spec:
description: The Maven properties.
type: object
settings:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the Maven settings.
+ description: A reference to the ConfigMap or Secret key that
+ contains the Maven settings.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -5497,10 +5423,9 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the ConfigMap or its
@@ -5509,7 +5434,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -5518,10 +5442,9 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the Secret or its key
@@ -5530,12 +5453,10 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
settingsSecurity:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the security of the Maven settings.
+ description: A reference to the ConfigMap or Secret key that
+ contains the security of the Maven settings.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -5544,10 +5465,9 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the ConfigMap or its
@@ -5556,7 +5476,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -5565,10 +5484,9 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the Secret or its key
@@ -5577,7 +5495,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: object
maxRunningBuilds:
@@ -5662,13 +5579,12 @@ spec:
type: object
type: array
configuration:
- description: |-
- Deprecated:
- Use camel trait (camel.properties) to manage properties
- Use mount trait (mount.configs) to manage configs
- Use mount trait (mount.resources) to manage resources
- Use mount trait (mount.volumes) to manage volumes
- list of configuration properties to be attached to all the Integration/IntegrationKits built from this IntegrationPlatform
+ description: 'Deprecated: Use camel trait (camel.properties) to manage
+ properties Use mount trait (mount.configs) to manage configs Use
+ mount trait (mount.resources) to manage resources Use mount trait
+ (mount.volumes) to manage volumes list of configuration properties
+ to be attached to all the Integration/IntegrationKits built from
+ this IntegrationPlatform'
items:
description: ConfigurationSpec represents a generic configuration
specification.
@@ -5717,9 +5633,10 @@ spec:
description: defines in what phase the IntegrationPlatform is found
type: string
profile:
- description: |-
- the profile you wish to use. It will apply certain traits which are required by the specific profile chosen.
- It usually relates the Cluster with the optional definition of special profiles (ie, Knative)
+ description: the profile you wish to use. It will apply certain traits
+ which are required by the specific profile chosen. It usually relates
+ the Cluster with the optional definition of special profiles (ie,
+ Knative)
type: string
traits:
description: list of traits to be executed for all the Integration/IntegrationKits
@@ -5747,9 +5664,8 @@ spec:
description: The configuration of Affinity trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -5768,9 +5684,9 @@ spec:
in the same node (default `false`).
type: boolean
podAffinityLabels:
- description: |-
- Defines a set of pods (namely those matching the label selector, relative to the given namespace) that the
- integration pod(s) should be co-located with.
+ description: Defines a set of pods (namely those matching
+ the label selector, relative to the given namespace) that
+ the integration pod(s) should be co-located with.
items:
type: string
type: array
@@ -5779,9 +5695,9 @@ spec:
in the same node (default `false`).
type: boolean
podAntiAffinityLabels:
- description: |-
- Defines a set of pods (namely those matching the label selector, relative to the given namespace) that the
- integration pod(s) should not be co-located with.
+ description: Defines a set of pods (namely those matching
+ the label selector, relative to the given namespace) that
+ the integration pod(s) should not be co-located with.
items:
type: string
type: array
@@ -5796,14 +5712,13 @@ spec:
for the builder pod.
type: object
baseImage:
- description: |-
- Specify a base image. In order to have the application working properly it must be a container image which has a Java JDK
- installed and ready to use on path (ie `/usr/bin/java`).
+ description: Specify a base image. In order to have the application
+ working properly it must be a container image which has
+ a Java JDK installed and ready to use on path (ie `/usr/bin/java`).
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -5814,21 +5729,27 @@ spec:
existing containers (default `true`)
type: boolean
limitCPU:
- description: |-
- When using `pod` strategy, the maximum amount of CPU required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the maximum amount
+ of CPU required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
limitMemory:
- description: |-
- When using `pod` strategy, the maximum amount of memory required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the maximum amount
+ of memory required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
mavenProfiles:
- description: |-
- A list of references pointing to configmaps/secrets that contains a maven profile.
- This configmap/secret is a resource of the IntegrationKit created, therefore it needs to be present in the namespace where the operator is going to create the IntegrationKit.
- The content of the maven profile is expected to be a text containing a valid maven profile starting with `` and ending with `` that will be integrated as an inline profile in the POM.
- Syntax: [configmap|secret]:name[/key], where name represents the resource name, key optionally represents the resource key to be filtered (default key value = profile.xml).
+ description: 'A list of references pointing to configmaps/secrets
+ that contains a maven profile. This configmap/secret is
+ a resource of the IntegrationKit created, therefore it needs
+ to be present in the namespace where the operator is going
+ to create the IntegrationKit. The content of the maven profile
+ is expected to be a text containing a valid maven profile
+ starting with `` and ending with `` that
+ will be integrated as an inline profile in the POM. Syntax:
+ [configmap|secret]:name[/key], where name represents the
+ resource name, key optionally represents the resource key
+ to be filtered (default key value = profile.xml).'
items:
type: string
type: array
@@ -5859,14 +5780,14 @@ spec:
type: string
type: array
requestCPU:
- description: |-
- When using `pod` strategy, the minimum amount of CPU required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the minimum amount
+ of CPU required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
requestMemory:
- description: |-
- When using `pod` strategy, the minimum amount of memory required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the minimum amount
+ of memory required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
strategy:
description: The strategy to use, either `pod` or `routine`
@@ -5882,10 +5803,11 @@ spec:
type: string
type: array
tasksFilter:
- description: |-
- A list of tasks sorted by the order of execution in a csv format, ie, `,,...`.
- Mind that you must include also the operator tasks (`builder`, `quarkus-native`, `package`, `jib`, `s2i`)
- if you need to execute them. Useful only with `pod` strategy.
+ description: A list of tasks sorted by the order of execution
+ in a csv format, ie, `,,...`. Mind
+ that you must include also the operator tasks (`builder`,
+ `quarkus-native`, `package`, `jib`, `s2i`) if you need to
+ execute them. Useful only with `pod` strategy.
type: string
tasksLimitCPU:
description: A list of limit cpu configuration for the specific
@@ -5912,18 +5834,17 @@ spec:
type: string
type: array
verbose:
- description: |-
- Enable verbose logging on build components that support it (e.g. Kaniko build pod).
- Deprecated no longer in use
+ description: Enable verbose logging on build components that
+ support it (e.g. Kaniko build pod). Deprecated no longer
+ in use
type: boolean
type: object
camel:
description: The configuration of Camel trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -5936,10 +5857,12 @@ spec:
type: string
type: array
runtimeVersion:
- description: |-
- The camel-k-runtime version to use for the integration. It overrides the default version set in the Integration Platform.
- You can use a fixed version (for example "3.2.3") or a semantic version (for example "3.x") which will try to resolve
- to the best matching Catalog existing on the cluster.
+ description: The camel-k-runtime version to use for the integration.
+ It overrides the default version set in the Integration
+ Platform. You can use a fixed version (for example "3.2.3")
+ or a semantic version (for example "3.x") which will try
+ to resolve to the best matching Catalog existing on the
+ cluster.
type: string
type: object
container:
@@ -5967,9 +5890,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -5980,10 +5902,13 @@ spec:
Service.
type: boolean
image:
- description: |-
- The main container image to use for the Integration. When using this parameter the operator will create a synthetic IntegrationKit which
- won't be able to execute traits requiring CamelCatalog. If the container image you're using is coming from an IntegrationKit, use instead
- Integration `.spec.integrationKit` parameter. If you're moving the Integration across environments, you will also need to create an "external" IntegrationKit.
+ description: The main container image to use for the Integration.
+ When using this parameter the operator will create a synthetic
+ IntegrationKit which won't be able to execute traits requiring
+ CamelCatalog. If the container image you're using is coming
+ from an IntegrationKit, use instead Integration `.spec.integrationKit`
+ parameter. If you're moving the Integration across environments,
+ you will also need to create an "external" IntegrationKit.
type: string
imagePullPolicy:
description: 'The pull policy: Always|Never|IfNotPresent'
@@ -6051,52 +5976,50 @@ spec:
description: The configuration of Cron trait
properties:
activeDeadlineSeconds:
- description: |-
- Specifies the duration in seconds, relative to the start time, that the job
- may be continuously active before it is considered to be failed.
- It defaults to 60s.
+ description: Specifies the duration in seconds, relative to
+ the start time, that the job may be continuously active
+ before it is considered to be failed. It defaults to 60s.
format: int64
type: integer
auto:
- description: |-
- Automatically deploy the integration as CronJob when all routes are
- either starting from a periodic consumer (only `cron`, `timer` and `quartz` are supported) or a passive consumer (e.g. `direct` is a passive consumer).
-
-
- It's required that all periodic consumers have the same period, and it can be expressed as cron schedule (e.g. `1m` can be expressed as `0/1 * * * *`,
- while `35m` or `50s` cannot).
+ description: "Automatically deploy the integration as CronJob
+ when all routes are either starting from a periodic consumer
+ (only `cron`, `timer` and `quartz` are supported) or a passive
+ consumer (e.g. `direct` is a passive consumer). \n It's
+ required that all periodic consumers have the same period,
+ and it can be expressed as cron schedule (e.g. `1m` can
+ be expressed as `0/1 * * * *`, while `35m` or `50s` cannot)."
type: boolean
backoffLimit:
- description: |-
- Specifies the number of retries before marking the job failed.
- It defaults to 2.
+ description: Specifies the number of retries before marking
+ the job failed. It defaults to 2.
format: int32
type: integer
components:
- description: |-
- A comma separated list of the Camel components that need to be customized in order for them to work when the schedule is triggered externally by Kubernetes.
- A specific customizer is activated for each specified component. E.g. for the `timer` component, the `cron-timer` customizer is
- activated (it's present in the `org.apache.camel.k:camel-k-cron` library).
-
-
- Supported components are currently: `cron`, `timer` and `quartz`.
+ description: "A comma separated list of the Camel components
+ that need to be customized in order for them to work when
+ the schedule is triggered externally by Kubernetes. A specific
+ customizer is activated for each specified component. E.g.
+ for the `timer` component, the `cron-timer` customizer is
+ activated (it's present in the `org.apache.camel.k:camel-k-cron`
+ library). \n Supported components are currently: `cron`,
+ `timer` and `quartz`."
type: string
concurrencyPolicy:
- description: |-
- Specifies how to treat concurrent executions of a Job.
- Valid values are:
- - "Allow": allows CronJobs to run concurrently;
- - "Forbid" (default): forbids concurrent runs, skipping next run if previous run hasn't finished yet;
- - "Replace": cancels currently running job and replaces it with a new one
+ description: 'Specifies how to treat concurrent executions
+ of a Job. Valid values are: - "Allow": allows CronJobs to
+ run concurrently; - "Forbid" (default): forbids concurrent
+ runs, skipping next run if previous run hasn''t finished
+ yet; - "Replace": cancels currently running job and replaces
+ it with a new one'
enum:
- Allow
- Forbid
- Replace
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6104,19 +6027,19 @@ spec:
traits share this common property.
type: boolean
fallback:
- description: |-
- Use the default Camel implementation of the `cron` endpoint (`quartz`) instead of trying to materialize the integration
- as Kubernetes CronJob.
+ description: Use the default Camel implementation of the `cron`
+ endpoint (`quartz`) instead of trying to materialize the
+ integration as Kubernetes CronJob.
type: boolean
schedule:
- description: |-
- The CronJob schedule for the whole integration. If multiple routes are declared, they must have the same schedule for this
- mechanism to work correctly.
+ description: The CronJob schedule for the whole integration.
+ If multiple routes are declared, they must have the same
+ schedule for this mechanism to work correctly.
type: string
startingDeadlineSeconds:
- description: |-
- Optional deadline in seconds for starting the job if it misses scheduled
- time for any reason. Missed jobs executions will be counted as failed ones.
+ description: Optional deadline in seconds for starting the
+ job if it misses scheduled time for any reason. Missed
+ jobs executions will be counted as failed ones.
format: int64
type: integer
timeZone:
@@ -6127,9 +6050,8 @@ spec:
description: The configuration of Dependencies trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6140,9 +6062,8 @@ spec:
description: The configuration of Deployer trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6158,51 +6079,49 @@ spec:
- knative-service
type: string
useSSA:
- description: |-
- Use server-side apply to update the owned resources (default `true`).
- Note that it automatically falls back to client-side patching, if SSA is not available, e.g., on old Kubernetes clusters.
+ description: Use server-side apply to update the owned resources
+ (default `true`). Note that it automatically falls back
+ to client-side patching, if SSA is not available, e.g.,
+ on old Kubernetes clusters.
type: boolean
type: object
deployment:
description: The configuration of Deployment trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
description: 'Deprecated: no longer in use.'
type: boolean
progressDeadlineSeconds:
- description: |-
- The maximum time in seconds for the deployment to make progress before it
- is considered to be failed. It defaults to `60s`.
+ description: The maximum time in seconds for the deployment
+ to make progress before it is considered to be failed. It
+ defaults to `60s`.
format: int32
type: integer
rollingUpdateMaxSurge:
anyOf:
- type: integer
- type: string
- description: |-
- The maximum number of pods that can be scheduled above the desired number of
- pods.
- Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
- This can not be 0 if MaxUnavailable is 0.
- Absolute number is calculated from percentage by rounding up.
- Defaults to `25%`.
+ description: 'The maximum number of pods that can be scheduled
+ above the desired number of pods. Value can be an absolute
+ number (ex: 5) or a percentage of desired pods (ex: 10%).
+ This can not be 0 if MaxUnavailable is 0. Absolute number
+ is calculated from percentage by rounding up. Defaults to
+ `25%`.'
x-kubernetes-int-or-string: true
rollingUpdateMaxUnavailable:
anyOf:
- type: integer
- type: string
- description: |-
- The maximum number of pods that can be unavailable during the update.
- Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
- Absolute number is calculated from percentage by rounding down.
- This can not be 0 if MaxSurge is 0.
- Defaults to `25%`.
+ description: 'The maximum number of pods that can be unavailable
+ during the update. Value can be an absolute number (ex:
+ 5) or a percentage of desired pods (ex: 10%). Absolute number
+ is calculated from percentage by rounding down. This can
+ not be 0 if MaxSurge is 0. Defaults to `25%`.'
x-kubernetes-int-or-string: true
strategy:
description: The deployment strategy to use to replace existing
@@ -6216,9 +6135,8 @@ spec:
description: The configuration of Environment trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
containerMeta:
@@ -6233,11 +6151,12 @@ spec:
`NO_PROXY` environment variables (default `true`)
type: boolean
vars:
- description: |-
- A list of environment variables to be added to the integration container.
- The syntax is either VAR=VALUE or VAR=[configmap|secret]:name/key, where name represents the resource name,
- and key represents the resource key to be mapped as and environment variable.
- These take precedence over any previously defined environment variables.
+ description: A list of environment variables to be added to
+ the integration container. The syntax is either VAR=VALUE
+ or VAR=[configmap|secret]:name/key, where name represents
+ the resource name, and key represents the resource key to
+ be mapped as and environment variable. These take precedence
+ over any previously defined environment variables.
items:
type: string
type: array
@@ -6246,9 +6165,8 @@ spec:
description: The configuration of Error Handler trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6263,15 +6181,14 @@ spec:
description: The configuration of GC trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
discoveryCache:
- description: |-
- Discovery client cache to be used, either `disabled`, `disk` or `memory` (default `memory`).
- Deprecated: to be removed from trait configuration.
+ description: 'Discovery client cache to be used, either `disabled`,
+ `disk` or `memory` (default `memory`). Deprecated: to be
+ removed from trait configuration.'
enum:
- disabled
- disk
@@ -6286,9 +6203,8 @@ spec:
description: The configuration of Health trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6410,19 +6326,17 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to the ingress.
- This can be used to set controller specific annotations, e.g., when using the NGINX Ingress controller:
- See https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md
+ description: 'The annotations added to the ingress. This can
+ be used to set controller specific annotations, e.g., when
+ using the NGINX Ingress controller: See https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md'
type: object
auto:
description: To automatically add an ingress whenever the
integration uses an HTTP endpoint consumer.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6432,14 +6346,18 @@ spec:
host:
description: To configure the host exposed by the ingress.
type: string
+ ingressClassName:
+ description: The Ingress class name as defined by the Ingress
+ spec See https://kubernetes.io/docs/concepts/services-networking/ingress/
+ type: string
path:
description: To configure the path exposed by the ingress
(default `/`).
type: string
pathType:
- description: |-
- To configure the path type exposed by the ingress.
- One of `Exact`, `Prefix`, `ImplementationSpecific` (default to `Prefix`).
+ description: To configure the path type exposed by the ingress.
+ One of `Exact`, `Prefix`, `ImplementationSpecific` (default
+ to `Prefix`).
enum:
- Exact
- Prefix
@@ -6463,9 +6381,8 @@ spec:
by default).
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6482,23 +6399,25 @@ spec:
description: The configuration of Jolokia trait
properties:
CACert:
- description: |-
- The PEM encoded CA certification file path, used to verify client certificates,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt` for OpenShift).
+ description: The PEM encoded CA certification file path, used
+ to verify client certificates, applicable when `protocol`
+ is `https` and `use-ssl-client-authentication` is `true`
+ (default `/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt`
+ for OpenShift).
type: string
clientPrincipal:
- description: |-
- The principal(s) which must be given in a client certificate to allow access to the Jolokia endpoint,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `clientPrincipal=cn=system:master-proxy`, `cn=hawtio-online.hawtio.svc` and `cn=fuse-console.fuse.svc` for OpenShift).
+ description: The principal(s) which must be given in a client
+ certificate to allow access to the Jolokia endpoint, applicable
+ when `protocol` is `https` and `use-ssl-client-authentication`
+ is `true` (default `clientPrincipal=cn=system:master-proxy`,
+ `cn=hawtio-online.hawtio.svc` and `cn=fuse-console.fuse.svc`
+ for OpenShift).
items:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
discoveryEnabled:
@@ -6509,20 +6428,20 @@ spec:
traits share this common property.
type: boolean
extendedClientCheck:
- description: |-
- Mandate the client certificate contains a client flag in the extended key usage section,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `true` for OpenShift).
+ description: Mandate the client certificate contains a client
+ flag in the extended key usage section, applicable when
+ `protocol` is `https` and `use-ssl-client-authentication`
+ is `true` (default `true` for OpenShift).
type: boolean
host:
- description: |-
- The Host address to which the Jolokia agent should bind to. If `"\*"` or `"0.0.0.0"` is given,
- the servers binds to every network interface (default `"*"`).
+ description: The Host address to which the Jolokia agent should
+ bind to. If `"\*"` or `"0.0.0.0"` is given, the servers
+ binds to every network interface (default `"*"`).
type: string
options:
- description: |-
- A list of additional Jolokia options as defined
- in https://jolokia.org/reference/html/agents.html#agent-jvm-config[JVM agent configuration options]
+ description: A list of additional Jolokia options as defined
+ in https://jolokia.org/reference/html/agents.html#agent-jvm-config[JVM
+ agent configuration options]
items:
type: string
type: array
@@ -6553,9 +6472,8 @@ spec:
separator)
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
debug:
@@ -6584,9 +6502,9 @@ spec:
type: string
type: array
printCommand:
- description: |-
- Prints the command used the start the JVM in the container logs (default `true`)
- Deprecated: no longer in use.
+ description: 'Prints the command used the start the JVM in
+ the container logs (default `true`) Deprecated: no longer
+ in use.'
type: boolean
type: object
kamelets:
@@ -6597,9 +6515,8 @@ spec:
and their default configuration (enabled by default)
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6632,16 +6549,14 @@ spec:
description: Enable automatic discovery of all trait properties.
type: boolean
channelSinks:
- description: |-
- List of channels used as destination of integration routes.
- Can contain simple channel names or full Camel URIs.
+ description: List of channels used as destination of integration
+ routes. Can contain simple channel names or full Camel URIs.
items:
type: string
type: array
channelSources:
- description: |-
- List of channels used as source of integration routes.
- Can contain simple channel names or full Camel URIs.
+ description: List of channels used as source of integration
+ routes. Can contain simple channel names or full Camel URIs.
items:
type: string
type: array
@@ -6650,9 +6565,8 @@ spec:
in JSON format.
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6660,9 +6574,9 @@ spec:
traits share this common property.
type: boolean
endpointSinks:
- description: |-
- List of endpoints used as destination of integration routes.
- Can contain simple endpoint names or full Camel URIs.
+ description: List of endpoints used as destination of integration
+ routes. Can contain simple endpoint names or full Camel
+ URIs.
items:
type: string
type: array
@@ -6673,50 +6587,54 @@ spec:
type: string
type: array
eventSinks:
- description: |-
- List of event types that the integration will produce.
- Can contain simple event types or full Camel URIs (to use a specific broker).
+ description: List of event types that the integration will
+ produce. Can contain simple event types or full Camel URIs
+ (to use a specific broker).
items:
type: string
type: array
eventSources:
- description: |-
- List of event types that the integration will be subscribed to.
- Can contain simple event types or full Camel URIs (to use a specific broker different from "default").
+ description: List of event types that the integration will
+ be subscribed to. Can contain simple event types or full
+ Camel URIs (to use a specific broker different from "default").
items:
type: string
type: array
filterEventType:
- description: |-
- Enables the default filtering for the Knative trigger using the event type
- If this is true, the created Knative trigger uses the event type as a filter on the event stream when no other filter criteria is given. (default: true)
+ description: 'Enables the default filtering for the Knative
+ trigger using the event type If this is true, the created
+ Knative trigger uses the event type as a filter on the event
+ stream when no other filter criteria is given. (default:
+ true)'
type: boolean
filterSourceChannels:
- description: |-
- Enables filtering on events based on the header "ce-knativehistory". Since this header has been removed in newer versions of
- Knative, filtering is disabled by default.
+ description: Enables filtering on events based on the header
+ "ce-knativehistory". Since this header has been removed
+ in newer versions of Knative, filtering is disabled by default.
type: boolean
filters:
- description: |-
- Sets filter attributes on the event stream (such as event type, source, subject and so on).
- A list of key-value pairs that represent filter attributes and its values.
- The syntax is KEY=VALUE, e.g., `source="my.source"`.
- Filter attributes get set on the Knative trigger that is being created as part of this integration.
+ description: Sets filter attributes on the event stream (such
+ as event type, source, subject and so on). A list of key-value
+ pairs that represent filter attributes and its values. The
+ syntax is KEY=VALUE, e.g., `source="my.source"`. Filter
+ attributes get set on the Knative trigger that is being
+ created as part of this integration.
items:
type: string
type: array
namespaceLabel:
- description: |-
- Enables the camel-k-operator to set the "bindings.knative.dev/include=true" label to the namespace
- As Knative requires this label to perform injection of K_SINK URL into the service.
- If this is false, the integration pod may start and fail, read the SinkBinding Knative documentation. (default: true)
+ description: 'Enables the camel-k-operator to set the "bindings.knative.dev/include=true"
+ label to the namespace As Knative requires this label to
+ perform injection of K_SINK URL into the service. If this
+ is false, the integration pod may start and fail, read the
+ SinkBinding Knative documentation. (default: true)'
type: boolean
sinkBinding:
- description: |-
- Allows binding the integration to a sink via a Knative SinkBinding resource.
- This can be used when the integration targets a single sink.
- It's enabled by default when the integration targets a single sink
- (except when the integration is owned by a Knative source).
+ description: Allows binding the integration to a sink via
+ a Knative SinkBinding resource. This can be used when the
+ integration targets a single sink. It's enabled by default
+ when the integration targets a single sink (except when
+ the integration is owned by a Knative source).
type: boolean
type: object
knative-service:
@@ -6725,47 +6643,39 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to route.
- This can be used to set knative service specific annotations
- CLI usage example: -t "knative-service.annotations.'haproxy.router.openshift.io/balance'=true"
+ description: 'The annotations added to route. This can be
+ used to set knative service specific annotations CLI usage
+ example: -t "knative-service.annotations.''haproxy.router.openshift.io/balance''=true"'
type: object
auto:
- description: |-
- Automatically deploy the integration as Knative service when all conditions hold:
-
-
- * Integration is using the Knative profile
- * All routes are either starting from an HTTP based consumer or a passive consumer (e.g. `direct` is a passive consumer)
+ description: "Automatically deploy the integration as Knative
+ service when all conditions hold: \n * Integration is using
+ the Knative profile * All routes are either starting from
+ an HTTP based consumer or a passive consumer (e.g. `direct`
+ is a passive consumer)"
type: boolean
autoscalingMetric:
- description: |-
- Configures the Knative autoscaling metric property (e.g. to set `concurrency` based or `cpu` based autoscaling).
-
-
- Refer to the Knative documentation for more information.
+ description: "Configures the Knative autoscaling metric property
+ (e.g. to set `concurrency` based or `cpu` based autoscaling).
+ \n Refer to the Knative documentation for more information."
type: string
autoscalingTarget:
- description: |-
- Sets the allowed concurrency level or CPU percentage (depending on the autoscaling metric) for each Pod.
-
-
- Refer to the Knative documentation for more information.
+ description: "Sets the allowed concurrency level or CPU percentage
+ (depending on the autoscaling metric) for each Pod. \n Refer
+ to the Knative documentation for more information."
type: integer
class:
- description: |-
- Configures the Knative autoscaling class property (e.g. to set `hpa.autoscaling.knative.dev` or `kpa.autoscaling.knative.dev` autoscaling).
-
-
- Refer to the Knative documentation for more information.
+ description: "Configures the Knative autoscaling class property
+ (e.g. to set `hpa.autoscaling.knative.dev` or `kpa.autoscaling.knative.dev`
+ autoscaling). \n Refer to the Knative documentation for
+ more information."
enum:
- kpa.autoscaling.knative.dev
- hpa.autoscaling.knative.dev
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6773,43 +6683,36 @@ spec:
traits share this common property.
type: boolean
maxScale:
- description: |-
- An upper bound for the number of Pods that can be running in parallel for the integration.
- Knative has its own cap value that depends on the installation.
-
-
- Refer to the Knative documentation for more information.
+ description: "An upper bound for the number of Pods that can
+ be running in parallel for the integration. Knative has
+ its own cap value that depends on the installation. \n Refer
+ to the Knative documentation for more information."
type: integer
minScale:
- description: |-
- The minimum number of Pods that should be running at any time for the integration. It's **zero** by default, meaning that
- the integration is scaled down to zero when not used for a configured amount of time.
-
-
- Refer to the Knative documentation for more information.
+ description: "The minimum number of Pods that should be running
+ at any time for the integration. It's **zero** by default,
+ meaning that the integration is scaled down to zero when
+ not used for a configured amount of time. \n Refer to the
+ Knative documentation for more information."
type: integer
rolloutDuration:
- description: |-
- Enables to gradually shift traffic to the latest Revision and sets the rollout duration.
- It's disabled by default and must be expressed as a Golang `time.Duration` string representation,
- rounded to a second precision.
+ description: Enables to gradually shift traffic to the latest
+ Revision and sets the rollout duration. It's disabled by
+ default and must be expressed as a Golang `time.Duration`
+ string representation, rounded to a second precision.
type: string
timeoutSeconds:
- description: |-
- The maximum duration in seconds that the request instance is allowed to respond to a request.
- This field propagates to the integration pod's terminationGracePeriodSeconds
-
-
- Refer to the Knative documentation for more information.
+ description: "The maximum duration in seconds that the request
+ instance is allowed to respond to a request. This field
+ propagates to the integration pod's terminationGracePeriodSeconds
+ \n Refer to the Knative documentation for more information."
format: int64
type: integer
visibility:
- description: |-
- Setting `cluster-local`, Knative service becomes a private service.
- Specifically, this option applies the `networking.knative.dev/visibility` label to Knative service.
-
-
- Refer to the Knative documentation for more information.
+ description: "Setting `cluster-local`, Knative service becomes
+ a private service. Specifically, this option applies the
+ `networking.knative.dev/visibility` label to Knative service.
+ \n Refer to the Knative documentation for more information."
enum:
- cluster-local
type: string
@@ -6821,9 +6724,8 @@ spec:
description: Colorize the log output
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6863,18 +6765,20 @@ spec:
description: The configuration of Mount trait
properties:
configs:
- description: |-
- A list of configuration pointing to configmap/secret.
- The configuration are expected to be UTF-8 resources as they are processed by runtime Camel Context and tried to be parsed as property files.
- They are also made available on the classpath in order to ease their usage directly from the Route.
- Syntax: [configmap|secret]:name[/key], where name represents the resource name and key optionally represents the resource key to be filtered
+ description: 'A list of configuration pointing to configmap/secret.
+ The configuration are expected to be UTF-8 resources as
+ they are processed by runtime Camel Context and tried to
+ be parsed as property files. They are also made available
+ on the classpath in order to ease their usage directly from
+ the Route. Syntax: [configmap|secret]:name[/key], where
+ name represents the resource name and key optionally represents
+ the resource key to be filtered'
items:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
emptyDirs:
@@ -6887,17 +6791,21 @@ spec:
description: 'Deprecated: no longer in use.'
type: boolean
hotReload:
- description: |-
- Enable "hot reload" when a secret/configmap mounted is edited (default `false`). The configmap/secret must be
- marked with `camel.apache.org/integration` label to be taken in account. The resource will be watched for any kind change, also for
- changes in metadata.
+ description: Enable "hot reload" when a secret/configmap mounted
+ is edited (default `false`). The configmap/secret must be
+ marked with `camel.apache.org/integration` label to be taken
+ in account. The resource will be watched for any kind change,
+ also for changes in metadata.
type: boolean
resources:
- description: |-
- A list of resources (text or binary content) pointing to configmap/secret.
- The resources are expected to be any resource type (text or binary content).
- The destination path can be either a default location or any path specified by the user.
- Syntax: [configmap|secret]:name[/key][@path], where name represents the resource name, key optionally represents the resource key to be filtered and path represents the destination path
+ description: 'A list of resources (text or binary content)
+ pointing to configmap/secret. The resources are expected
+ to be any resource type (text or binary content). The destination
+ path can be either a default location or any path specified
+ by the user. Syntax: [configmap|secret]:name[/key][@path],
+ where name represents the resource name, key optionally
+ represents the resource key to be filtered and path represents
+ the destination path'
items:
type: string
type: array
@@ -6922,9 +6830,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6935,9 +6842,8 @@ spec:
description: The configuration of Owner trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6959,9 +6865,8 @@ spec:
description: The configuration of PDB trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6969,53 +6874,56 @@ spec:
traits share this common property.
type: boolean
maxUnavailable:
- description: |-
- The number of pods for the Integration that can be unavailable after an eviction.
- It can be either an absolute number or a percentage (default `1` if `min-available` is also not set).
- Only one of `max-unavailable` and `min-available` can be specified.
+ description: The number of pods for the Integration that can
+ be unavailable after an eviction. It can be either an absolute
+ number or a percentage (default `1` if `min-available` is
+ also not set). Only one of `max-unavailable` and `min-available`
+ can be specified.
type: string
minAvailable:
- description: |-
- The number of pods for the Integration that must still be available after an eviction.
- It can be either an absolute number or a percentage.
- Only one of `min-available` and `max-unavailable` can be specified.
+ description: The number of pods for the Integration that must
+ still be available after an eviction. It can be either an
+ absolute number or a percentage. Only one of `min-available`
+ and `max-unavailable` can be specified.
type: string
type: object
platform:
description: The configuration of Platform trait
properties:
auto:
- description: |-
- To automatically detect from the environment if a default platform can be created (it will be created on OpenShift or when a registry address is set).
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'To automatically detect from the environment
+ if a default platform can be created (it will be created
+ on OpenShift or when a registry address is set). Deprecated:
+ Platform is auto generated by the operator install procedure
+ - maintained for backward compatibility'
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
createDefault:
- description: |-
- To create a default (empty) platform when the platform is missing.
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'To create a default (empty) platform when the
+ platform is missing. Deprecated: Platform is auto generated
+ by the operator install procedure - maintained for backward
+ compatibility'
type: boolean
enabled:
description: 'Deprecated: no longer in use.'
type: boolean
global:
- description: |-
- Indicates if the platform should be created globally in the case of global operator (default true).
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'Indicates if the platform should be created
+ globally in the case of global operator (default true).
+ Deprecated: Platform is auto generated by the operator install
+ procedure - maintained for backward compatibility'
type: boolean
type: object
pod:
description: The configuration of Pod trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7027,9 +6935,8 @@ spec:
description: The configuration of Prometheus trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7055,9 +6962,8 @@ spec:
secret on the pod if it is of type `kubernetes.io/dockerconfigjson`.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7080,10 +6986,10 @@ spec:
description: The configuration of Quarkus trait
properties:
buildMode:
- description: |-
- The Quarkus mode to run: either `jvm` or `native` (default `jvm`).
- In case both `jvm` and `native` are specified, two `IntegrationKit` resources are created,
- with the `native` kit having precedence over the `jvm` one once ready.
+ description: 'The Quarkus mode to run: either `jvm` or `native`
+ (default `jvm`). In case both `jvm` and `native` are specified,
+ two `IntegrationKit` resources are created, with the `native`
+ kit having precedence over the `jvm` one once ready.'
items:
description: QuarkusMode is the type of Quarkus build packaging.
enum:
@@ -7092,9 +6998,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7110,18 +7015,18 @@ spec:
in the runtime catalog)
type: string
packageTypes:
- description: |-
- The Quarkus package types, `fast-jar` or `native` (default `fast-jar`).
- In case both `fast-jar` and `native` are specified, two `IntegrationKit` resources are created,
- with the native kit having precedence over the `fast-jar` one once ready.
- The order influences the resolution of the current kit for the integration.
- The kit corresponding to the first package type will be assigned to the
- integration in case no existing kit that matches the integration exists.
- Deprecated: use `build-mode` instead.
+ description: 'The Quarkus package types, `fast-jar` or `native`
+ (default `fast-jar`). In case both `fast-jar` and `native`
+ are specified, two `IntegrationKit` resources are created,
+ with the native kit having precedence over the `fast-jar`
+ one once ready. The order influences the resolution of the
+ current kit for the integration. The kit corresponding to
+ the first package type will be assigned to the integration
+ in case no existing kit that matches the integration exists.
+ Deprecated: use `build-mode` instead.'
items:
- description: |-
- QuarkusPackageType is the type of Quarkus build packaging.
- Deprecated: use `QuarkusMode` instead.
+ description: 'QuarkusPackageType is the type of Quarkus
+ build packaging. Deprecated: use `QuarkusMode` instead.'
enum:
- fast-jar
- native
@@ -7129,14 +7034,12 @@ spec:
type: array
type: object
registry:
- description: |-
- The configuration of Registry trait (support removed since version 2.5.0).
- Deprecated: use jvm trait or read documentation.
+ description: 'The configuration of Registry trait (support removed
+ since version 2.5.0). Deprecated: use jvm trait or read documentation.'
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7150,16 +7053,14 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to route.
- This can be used to set route specific annotations
- For annotations options see https://docs.openshift.com/container-platform/3.11/architecture/networking/routes.html#route-specific-annotations
- CLI usage example: -t "route.annotations.'haproxy.router.openshift.io/balance'=true"
+ description: 'The annotations added to route. This can be
+ used to set route specific annotations For annotations options
+ see https://docs.openshift.com/container-platform/3.11/architecture/networking/routes.html#route-specific-annotations
+ CLI usage example: -t "route.annotations.''haproxy.router.openshift.io/balance''=true"'
type: object
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7170,82 +7071,74 @@ spec:
description: To configure the host exposed by the route.
type: string
tlsCACertificate:
- description: |-
- The TLS CA certificate contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS CA certificate contents. \n Refer to
+ the OpenShift route documentation for additional information."
type: string
tlsCACertificateSecret:
- description: |-
- The secret name and key reference to the TLS CA certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the TLS
+ CA certificate. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only one
+ key in the secret it will be read, otherwise you can set
+ a key name separated with a \"/\". \n Refer to the OpenShift
+ route documentation for additional information."
type: string
tlsCertificate:
- description: |-
- The TLS certificate contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS certificate contents. \n Refer to the
+ OpenShift route documentation for additional information."
type: string
tlsCertificateSecret:
- description: |-
- The secret name and key reference to the TLS certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the TLS
+ certificate. The format is \"secret-name[/key-name]\", the
+ value represents the secret name, if there is only one key
+ in the secret it will be read, otherwise you can set a key
+ name separated with a \"/\". \n Refer to the OpenShift route
+ documentation for additional information."
type: string
tlsDestinationCACertificate:
- description: |-
- The destination CA certificate provides the contents of the ca certificate of the final destination. When using reencrypt
- termination this file should be provided in order to have routers use it for health checks on the secure connection.
- If this field is not specified, the router may provide its own destination CA and perform hostname validation using
- the short service name (service.namespace.svc), which allows infrastructure generated certificates to automatically
- verify.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The destination CA certificate provides the
+ contents of the ca certificate of the final destination.
+ \ When using reencrypt termination this file should be provided
+ in order to have routers use it for health checks on the
+ secure connection. If this field is not specified, the router
+ may provide its own destination CA and perform hostname
+ validation using the short service name (service.namespace.svc),
+ which allows infrastructure generated certificates to automatically
+ verify. \n Refer to the OpenShift route documentation for
+ additional information."
type: string
tlsDestinationCACertificateSecret:
- description: |-
- The secret name and key reference to the destination CA certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the destination
+ CA certificate. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only one
+ key in the secret it will be read, otherwise you can set
+ a key name separated with a \"/\". \n Refer to the OpenShift
+ route documentation for additional information."
type: string
tlsInsecureEdgeTerminationPolicy:
- description: |-
- To configure how to deal with insecure traffic, e.g. `Allow`, `Disable` or `Redirect` traffic.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "To configure how to deal with insecure traffic,
+ e.g. `Allow`, `Disable` or `Redirect` traffic. \n Refer
+ to the OpenShift route documentation for additional information."
enum:
- None
- Allow
- Redirect
type: string
tlsKey:
- description: |-
- The TLS certificate key contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS certificate key contents. \n Refer to
+ the OpenShift route documentation for additional information."
type: string
tlsKeySecret:
- description: |-
- The secret name and key reference to the TLS certificate key. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the TLS
+ certificate key. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only one
+ key in the secret it will be read, otherwise you can set
+ a key name separated with a \"/\". \n Refer to the OpenShift
+ route documentation for additional information."
type: string
tlsTermination:
- description: |-
- The TLS termination type, like `edge`, `passthrough` or `reencrypt`.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS termination type, like `edge`, `passthrough`
+ or `reencrypt`. \n Refer to the OpenShift route documentation
+ for additional information."
enum:
- edge
- reencrypt
@@ -7256,9 +7149,8 @@ spec:
description: The configuration of Security Context trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7290,9 +7182,8 @@ spec:
needs to be created.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7300,9 +7191,8 @@ spec:
traits share this common property.
type: boolean
nodePort:
- description: |-
- Enable Service to be exposed as NodePort (default `false`).
- Deprecated: Use service type instead.
+ description: 'Enable Service to be exposed as NodePort (default
+ `false`). Deprecated: Use service type instead.'
type: boolean
type:
description: The type of service to be used, either 'ClusterIP',
@@ -7317,9 +7207,8 @@ spec:
description: The configuration of Service Binding trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7346,9 +7235,8 @@ spec:
description: The configuration of Toleration trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7381,12 +7269,19 @@ spec:
storage: true
subresources:
status: {}
+status:
+ acceptedNames:
+ kind: ""
+ plural: ""
+ conditions: []
+ storedVersions: []
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
- controller-gen.kubebuilder.io/version: v0.15.0
+ controller-gen.kubebuilder.io/version: v0.6.1
+ creationTimestamp: null
labels:
app: camel-k
name: integrationprofiles.camel.apache.org
@@ -7416,24 +7311,20 @@ spec:
name: v1
schema:
openAPIV3Schema:
- description: |-
- IntegrationProfile is the resource used to apply user defined settings to the Camel K operator behavior.
- It defines the behavior of all Custom Resources (`IntegrationKit`, `Integration`, `Kamelet`) in the given namespace.
+ description: IntegrationProfile is the resource used to apply user defined
+ settings to the Camel K operator behavior. It defines the behavior of all
+ Custom Resources (`IntegrationKit`, `Integration`, `Kamelet`) in the given
+ namespace.
properties:
apiVersion:
- description: |-
- APIVersion defines the versioned schema of this representation of an object.
- Servers should convert recognized schemas to the latest internal value, and
- may reject unrecognized values.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+ description: 'APIVersion defines the versioned schema of this representation
+ of an object. Servers should convert recognized schemas to the latest
+ internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: |-
- Kind is a string value representing the REST resource this object represents.
- Servers may infer this from the endpoint the client submits requests to.
- Cannot be updated.
- In CamelCase.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ description: 'Kind is a string value representing the REST resource this
+ object represents. Servers may infer this from the endpoint the client
+ submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
@@ -7445,22 +7336,22 @@ spec:
description: specify how to build the Integration/IntegrationKits
properties:
baseImage:
- description: |-
- a base image that can be used as base layer for all images.
- It can be useful if you want to provide some custom base image with further utility software
+ description: a base image that can be used as base layer for all
+ images. It can be useful if you want to provide some custom
+ base image with further utility software
type: string
maven:
description: Maven configuration used to build the Camel/Camel-Quarkus
applications
properties:
caSecrets:
- description: |-
- The Secrets name and key, containing the CA certificate(s) used to connect
- to remote Maven repositories.
- It can contain X.509 certificates, and PKCS#7 formatted certificate chains.
- A JKS formatted keystore is automatically created to store the CA certificate(s),
- and configured to be used as a trusted certificate(s) by the Maven commands.
- Note that the root CA certificates are also imported into the created keystore.
+ description: The Secrets name and key, containing the CA certificate(s)
+ used to connect to remote Maven repositories. It can contain
+ X.509 certificates, and PKCS#7 formatted certificate chains.
+ A JKS formatted keystore is automatically created to store
+ the CA certificate(s), and configured to be used as a trusted
+ certificate(s) by the Maven commands. Note that the root
+ CA certificates are also imported into the created keystore.
items:
description: SecretKeySelector selects a key of a Secret.
properties:
@@ -7469,10 +7360,8 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
description: Specify whether the Secret or its key must
@@ -7481,20 +7370,16 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: array
cliOptions:
- description: |-
- The CLI options that are appended to the list of arguments for Maven commands,
- e.g., `-V,--no-transfer-progress,-Dstyle.color=never`.
+ description: The CLI options that are appended to the list
+ of arguments for Maven commands, e.g., `-V,--no-transfer-progress,-Dstyle.color=never`.
See https://maven.apache.org/ref/3.8.4/maven-embedder/cli.html.
items:
type: string
type: array
extension:
- description: |-
- The Maven build extensions.
- See https://maven.apache.org/guides/mini/guide-using-extensions.html.
+ description: The Maven build extensions. See https://maven.apache.org/guides/mini/guide-using-extensions.html.
items:
description: MavenArtifact defines a GAV (Group:Artifact:Type:Version:Classifier)
Maven artifact.
@@ -7523,9 +7408,8 @@ spec:
description: The path of the local Maven repository.
type: string
profiles:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the Maven profile.
+ description: A reference to the ConfigMap or Secret key that
+ contains the Maven profile.
items:
description: ValueSource --.
properties:
@@ -7536,10 +7420,9 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the ConfigMap or its
@@ -7548,7 +7431,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -7557,10 +7439,9 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the Secret or its key
@@ -7569,7 +7450,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
properties:
@@ -7578,9 +7458,8 @@ spec:
description: The Maven properties.
type: object
settings:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the Maven settings.
+ description: A reference to the ConfigMap or Secret key that
+ contains the Maven settings.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -7589,10 +7468,9 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the ConfigMap or its
@@ -7601,7 +7479,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -7610,10 +7487,9 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the Secret or its key
@@ -7622,12 +7498,10 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
settingsSecurity:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the security of the Maven settings.
+ description: A reference to the ConfigMap or Secret key that
+ contains the security of the Maven settings.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -7636,10 +7510,9 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the ConfigMap or its
@@ -7648,7 +7521,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -7657,10 +7529,9 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the Secret or its key
@@ -7669,7 +7540,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: object
registry:
@@ -7748,9 +7618,8 @@ spec:
description: The configuration of Affinity trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7769,9 +7638,9 @@ spec:
in the same node (default `false`).
type: boolean
podAffinityLabels:
- description: |-
- Defines a set of pods (namely those matching the label selector, relative to the given namespace) that the
- integration pod(s) should be co-located with.
+ description: Defines a set of pods (namely those matching
+ the label selector, relative to the given namespace) that
+ the integration pod(s) should be co-located with.
items:
type: string
type: array
@@ -7780,9 +7649,9 @@ spec:
in the same node (default `false`).
type: boolean
podAntiAffinityLabels:
- description: |-
- Defines a set of pods (namely those matching the label selector, relative to the given namespace) that the
- integration pod(s) should not be co-located with.
+ description: Defines a set of pods (namely those matching
+ the label selector, relative to the given namespace) that
+ the integration pod(s) should not be co-located with.
items:
type: string
type: array
@@ -7797,14 +7666,13 @@ spec:
for the builder pod.
type: object
baseImage:
- description: |-
- Specify a base image. In order to have the application working properly it must be a container image which has a Java JDK
- installed and ready to use on path (ie `/usr/bin/java`).
+ description: Specify a base image. In order to have the application
+ working properly it must be a container image which has
+ a Java JDK installed and ready to use on path (ie `/usr/bin/java`).
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7815,21 +7683,27 @@ spec:
existing containers (default `true`)
type: boolean
limitCPU:
- description: |-
- When using `pod` strategy, the maximum amount of CPU required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the maximum amount
+ of CPU required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
limitMemory:
- description: |-
- When using `pod` strategy, the maximum amount of memory required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the maximum amount
+ of memory required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
mavenProfiles:
- description: |-
- A list of references pointing to configmaps/secrets that contains a maven profile.
- This configmap/secret is a resource of the IntegrationKit created, therefore it needs to be present in the namespace where the operator is going to create the IntegrationKit.
- The content of the maven profile is expected to be a text containing a valid maven profile starting with `` and ending with `` that will be integrated as an inline profile in the POM.
- Syntax: [configmap|secret]:name[/key], where name represents the resource name, key optionally represents the resource key to be filtered (default key value = profile.xml).
+ description: 'A list of references pointing to configmaps/secrets
+ that contains a maven profile. This configmap/secret is
+ a resource of the IntegrationKit created, therefore it needs
+ to be present in the namespace where the operator is going
+ to create the IntegrationKit. The content of the maven profile
+ is expected to be a text containing a valid maven profile
+ starting with `` and ending with `` that
+ will be integrated as an inline profile in the POM. Syntax:
+ [configmap|secret]:name[/key], where name represents the
+ resource name, key optionally represents the resource key
+ to be filtered (default key value = profile.xml).'
items:
type: string
type: array
@@ -7860,14 +7734,14 @@ spec:
type: string
type: array
requestCPU:
- description: |-
- When using `pod` strategy, the minimum amount of CPU required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the minimum amount
+ of CPU required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
requestMemory:
- description: |-
- When using `pod` strategy, the minimum amount of memory required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the minimum amount
+ of memory required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
strategy:
description: The strategy to use, either `pod` or `routine`
@@ -7883,10 +7757,11 @@ spec:
type: string
type: array
tasksFilter:
- description: |-
- A list of tasks sorted by the order of execution in a csv format, ie, `,,...`.
- Mind that you must include also the operator tasks (`builder`, `quarkus-native`, `package`, `jib`, `s2i`)
- if you need to execute them. Useful only with `pod` strategy.
+ description: A list of tasks sorted by the order of execution
+ in a csv format, ie, `,,...`. Mind
+ that you must include also the operator tasks (`builder`,
+ `quarkus-native`, `package`, `jib`, `s2i`) if you need to
+ execute them. Useful only with `pod` strategy.
type: string
tasksLimitCPU:
description: A list of limit cpu configuration for the specific
@@ -7913,18 +7788,17 @@ spec:
type: string
type: array
verbose:
- description: |-
- Enable verbose logging on build components that support it (e.g. Kaniko build pod).
- Deprecated no longer in use
+ description: Enable verbose logging on build components that
+ support it (e.g. Kaniko build pod). Deprecated no longer
+ in use
type: boolean
type: object
camel:
description: The configuration of Camel trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7937,10 +7811,12 @@ spec:
type: string
type: array
runtimeVersion:
- description: |-
- The camel-k-runtime version to use for the integration. It overrides the default version set in the Integration Platform.
- You can use a fixed version (for example "3.2.3") or a semantic version (for example "3.x") which will try to resolve
- to the best matching Catalog existing on the cluster.
+ description: The camel-k-runtime version to use for the integration.
+ It overrides the default version set in the Integration
+ Platform. You can use a fixed version (for example "3.2.3")
+ or a semantic version (for example "3.x") which will try
+ to resolve to the best matching Catalog existing on the
+ cluster.
type: string
type: object
container:
@@ -7968,9 +7844,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7981,10 +7856,13 @@ spec:
Service.
type: boolean
image:
- description: |-
- The main container image to use for the Integration. When using this parameter the operator will create a synthetic IntegrationKit which
- won't be able to execute traits requiring CamelCatalog. If the container image you're using is coming from an IntegrationKit, use instead
- Integration `.spec.integrationKit` parameter. If you're moving the Integration across environments, you will also need to create an "external" IntegrationKit.
+ description: The main container image to use for the Integration.
+ When using this parameter the operator will create a synthetic
+ IntegrationKit which won't be able to execute traits requiring
+ CamelCatalog. If the container image you're using is coming
+ from an IntegrationKit, use instead Integration `.spec.integrationKit`
+ parameter. If you're moving the Integration across environments,
+ you will also need to create an "external" IntegrationKit.
type: string
imagePullPolicy:
description: 'The pull policy: Always|Never|IfNotPresent'
@@ -8052,52 +7930,50 @@ spec:
description: The configuration of Cron trait
properties:
activeDeadlineSeconds:
- description: |-
- Specifies the duration in seconds, relative to the start time, that the job
- may be continuously active before it is considered to be failed.
- It defaults to 60s.
+ description: Specifies the duration in seconds, relative to
+ the start time, that the job may be continuously active
+ before it is considered to be failed. It defaults to 60s.
format: int64
type: integer
auto:
- description: |-
- Automatically deploy the integration as CronJob when all routes are
- either starting from a periodic consumer (only `cron`, `timer` and `quartz` are supported) or a passive consumer (e.g. `direct` is a passive consumer).
-
-
- It's required that all periodic consumers have the same period, and it can be expressed as cron schedule (e.g. `1m` can be expressed as `0/1 * * * *`,
- while `35m` or `50s` cannot).
+ description: "Automatically deploy the integration as CronJob
+ when all routes are either starting from a periodic consumer
+ (only `cron`, `timer` and `quartz` are supported) or a passive
+ consumer (e.g. `direct` is a passive consumer). \n It's
+ required that all periodic consumers have the same period,
+ and it can be expressed as cron schedule (e.g. `1m` can
+ be expressed as `0/1 * * * *`, while `35m` or `50s` cannot)."
type: boolean
backoffLimit:
- description: |-
- Specifies the number of retries before marking the job failed.
- It defaults to 2.
+ description: Specifies the number of retries before marking
+ the job failed. It defaults to 2.
format: int32
type: integer
components:
- description: |-
- A comma separated list of the Camel components that need to be customized in order for them to work when the schedule is triggered externally by Kubernetes.
- A specific customizer is activated for each specified component. E.g. for the `timer` component, the `cron-timer` customizer is
- activated (it's present in the `org.apache.camel.k:camel-k-cron` library).
-
-
- Supported components are currently: `cron`, `timer` and `quartz`.
+ description: "A comma separated list of the Camel components
+ that need to be customized in order for them to work when
+ the schedule is triggered externally by Kubernetes. A specific
+ customizer is activated for each specified component. E.g.
+ for the `timer` component, the `cron-timer` customizer is
+ activated (it's present in the `org.apache.camel.k:camel-k-cron`
+ library). \n Supported components are currently: `cron`,
+ `timer` and `quartz`."
type: string
concurrencyPolicy:
- description: |-
- Specifies how to treat concurrent executions of a Job.
- Valid values are:
- - "Allow": allows CronJobs to run concurrently;
- - "Forbid" (default): forbids concurrent runs, skipping next run if previous run hasn't finished yet;
- - "Replace": cancels currently running job and replaces it with a new one
+ description: 'Specifies how to treat concurrent executions
+ of a Job. Valid values are: - "Allow": allows CronJobs to
+ run concurrently; - "Forbid" (default): forbids concurrent
+ runs, skipping next run if previous run hasn''t finished
+ yet; - "Replace": cancels currently running job and replaces
+ it with a new one'
enum:
- Allow
- Forbid
- Replace
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -8105,19 +7981,19 @@ spec:
traits share this common property.
type: boolean
fallback:
- description: |-
- Use the default Camel implementation of the `cron` endpoint (`quartz`) instead of trying to materialize the integration
- as Kubernetes CronJob.
+ description: Use the default Camel implementation of the `cron`
+ endpoint (`quartz`) instead of trying to materialize the
+ integration as Kubernetes CronJob.
type: boolean
schedule:
- description: |-
- The CronJob schedule for the whole integration. If multiple routes are declared, they must have the same schedule for this
- mechanism to work correctly.
+ description: The CronJob schedule for the whole integration.
+ If multiple routes are declared, they must have the same
+ schedule for this mechanism to work correctly.
type: string
startingDeadlineSeconds:
- description: |-
- Optional deadline in seconds for starting the job if it misses scheduled
- time for any reason. Missed jobs executions will be counted as failed ones.
+ description: Optional deadline in seconds for starting the
+ job if it misses scheduled time for any reason. Missed
+ jobs executions will be counted as failed ones.
format: int64
type: integer
timeZone:
@@ -8128,9 +8004,8 @@ spec:
description: The configuration of Dependencies trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -8141,9 +8016,8 @@ spec:
description: The configuration of Deployer trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -8159,51 +8033,49 @@ spec:
- knative-service
type: string
useSSA:
- description: |-
- Use server-side apply to update the owned resources (default `true`).
- Note that it automatically falls back to client-side patching, if SSA is not available, e.g., on old Kubernetes clusters.
+ description: Use server-side apply to update the owned resources
+ (default `true`). Note that it automatically falls back
+ to client-side patching, if SSA is not available, e.g.,
+ on old Kubernetes clusters.
type: boolean
type: object
deployment:
description: The configuration of Deployment trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
description: 'Deprecated: no longer in use.'
type: boolean
progressDeadlineSeconds:
- description: |-
- The maximum time in seconds for the deployment to make progress before it
- is considered to be failed. It defaults to `60s`.
+ description: The maximum time in seconds for the deployment
+ to make progress before it is considered to be failed. It
+ defaults to `60s`.
format: int32
type: integer
rollingUpdateMaxSurge:
anyOf:
- type: integer
- type: string
- description: |-
- The maximum number of pods that can be scheduled above the desired number of
- pods.
- Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
- This can not be 0 if MaxUnavailable is 0.
- Absolute number is calculated from percentage by rounding up.
- Defaults to `25%`.
+ description: 'The maximum number of pods that can be scheduled
+ above the desired number of pods. Value can be an absolute
+ number (ex: 5) or a percentage of desired pods (ex: 10%).
+ This can not be 0 if MaxUnavailable is 0. Absolute number
+ is calculated from percentage by rounding up. Defaults to
+ `25%`.'
x-kubernetes-int-or-string: true
rollingUpdateMaxUnavailable:
anyOf:
- type: integer
- type: string
- description: |-
- The maximum number of pods that can be unavailable during the update.
- Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
- Absolute number is calculated from percentage by rounding down.
- This can not be 0 if MaxSurge is 0.
- Defaults to `25%`.
+ description: 'The maximum number of pods that can be unavailable
+ during the update. Value can be an absolute number (ex:
+ 5) or a percentage of desired pods (ex: 10%). Absolute number
+ is calculated from percentage by rounding down. This can
+ not be 0 if MaxSurge is 0. Defaults to `25%`.'
x-kubernetes-int-or-string: true
strategy:
description: The deployment strategy to use to replace existing
@@ -8217,9 +8089,8 @@ spec:
description: The configuration of Environment trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
containerMeta:
@@ -8234,11 +8105,12 @@ spec:
`NO_PROXY` environment variables (default `true`)
type: boolean
vars:
- description: |-
- A list of environment variables to be added to the integration container.
- The syntax is either VAR=VALUE or VAR=[configmap|secret]:name/key, where name represents the resource name,
- and key represents the resource key to be mapped as and environment variable.
- These take precedence over any previously defined environment variables.
+ description: A list of environment variables to be added to
+ the integration container. The syntax is either VAR=VALUE
+ or VAR=[configmap|secret]:name/key, where name represents
+ the resource name, and key represents the resource key to
+ be mapped as and environment variable. These take precedence
+ over any previously defined environment variables.
items:
type: string
type: array
@@ -8247,9 +8119,8 @@ spec:
description: The configuration of Error Handler trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -8264,15 +8135,14 @@ spec:
description: The configuration of GC trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
discoveryCache:
- description: |-
- Discovery client cache to be used, either `disabled`, `disk` or `memory` (default `memory`).
- Deprecated: to be removed from trait configuration.
+ description: 'Discovery client cache to be used, either `disabled`,
+ `disk` or `memory` (default `memory`). Deprecated: to be
+ removed from trait configuration.'
enum:
- disabled
- disk
@@ -8287,9 +8157,8 @@ spec:
description: The configuration of Health trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -8411,19 +8280,17 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to the ingress.
- This can be used to set controller specific annotations, e.g., when using the NGINX Ingress controller:
- See https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md
+ description: 'The annotations added to the ingress. This can
+ be used to set controller specific annotations, e.g., when
+ using the NGINX Ingress controller: See https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md'
type: object
auto:
description: To automatically add an ingress whenever the
integration uses an HTTP endpoint consumer.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -8433,14 +8300,18 @@ spec:
host:
description: To configure the host exposed by the ingress.
type: string
+ ingressClassName:
+ description: The Ingress class name as defined by the Ingress
+ spec See https://kubernetes.io/docs/concepts/services-networking/ingress/
+ type: string
path:
description: To configure the path exposed by the ingress
(default `/`).
type: string
pathType:
- description: |-
- To configure the path type exposed by the ingress.
- One of `Exact`, `Prefix`, `ImplementationSpecific` (default to `Prefix`).
+ description: To configure the path type exposed by the ingress.
+ One of `Exact`, `Prefix`, `ImplementationSpecific` (default
+ to `Prefix`).
enum:
- Exact
- Prefix
@@ -8464,9 +8335,8 @@ spec:
by default).
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -8483,23 +8353,25 @@ spec:
description: The configuration of Jolokia trait
properties:
CACert:
- description: |-
- The PEM encoded CA certification file path, used to verify client certificates,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt` for OpenShift).
+ description: The PEM encoded CA certification file path, used
+ to verify client certificates, applicable when `protocol`
+ is `https` and `use-ssl-client-authentication` is `true`
+ (default `/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt`
+ for OpenShift).
type: string
clientPrincipal:
- description: |-
- The principal(s) which must be given in a client certificate to allow access to the Jolokia endpoint,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `clientPrincipal=cn=system:master-proxy`, `cn=hawtio-online.hawtio.svc` and `cn=fuse-console.fuse.svc` for OpenShift).
+ description: The principal(s) which must be given in a client
+ certificate to allow access to the Jolokia endpoint, applicable
+ when `protocol` is `https` and `use-ssl-client-authentication`
+ is `true` (default `clientPrincipal=cn=system:master-proxy`,
+ `cn=hawtio-online.hawtio.svc` and `cn=fuse-console.fuse.svc`
+ for OpenShift).
items:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
discoveryEnabled:
@@ -8510,20 +8382,20 @@ spec:
traits share this common property.
type: boolean
extendedClientCheck:
- description: |-
- Mandate the client certificate contains a client flag in the extended key usage section,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `true` for OpenShift).
+ description: Mandate the client certificate contains a client
+ flag in the extended key usage section, applicable when
+ `protocol` is `https` and `use-ssl-client-authentication`
+ is `true` (default `true` for OpenShift).
type: boolean
host:
- description: |-
- The Host address to which the Jolokia agent should bind to. If `"\*"` or `"0.0.0.0"` is given,
- the servers binds to every network interface (default `"*"`).
+ description: The Host address to which the Jolokia agent should
+ bind to. If `"\*"` or `"0.0.0.0"` is given, the servers
+ binds to every network interface (default `"*"`).
type: string
options:
- description: |-
- A list of additional Jolokia options as defined
- in https://jolokia.org/reference/html/agents.html#agent-jvm-config[JVM agent configuration options]
+ description: A list of additional Jolokia options as defined
+ in https://jolokia.org/reference/html/agents.html#agent-jvm-config[JVM
+ agent configuration options]
items:
type: string
type: array
@@ -8554,9 +8426,8 @@ spec:
separator)
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
debug:
@@ -8585,9 +8456,9 @@ spec:
type: string
type: array
printCommand:
- description: |-
- Prints the command used the start the JVM in the container logs (default `true`)
- Deprecated: no longer in use.
+ description: 'Prints the command used the start the JVM in
+ the container logs (default `true`) Deprecated: no longer
+ in use.'
type: boolean
type: object
kamelets:
@@ -8598,9 +8469,8 @@ spec:
and their default configuration (enabled by default)
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -8633,16 +8503,14 @@ spec:
description: Enable automatic discovery of all trait properties.
type: boolean
channelSinks:
- description: |-
- List of channels used as destination of integration routes.
- Can contain simple channel names or full Camel URIs.
+ description: List of channels used as destination of integration
+ routes. Can contain simple channel names or full Camel URIs.
items:
type: string
type: array
channelSources:
- description: |-
- List of channels used as source of integration routes.
- Can contain simple channel names or full Camel URIs.
+ description: List of channels used as source of integration
+ routes. Can contain simple channel names or full Camel URIs.
items:
type: string
type: array
@@ -8651,9 +8519,8 @@ spec:
in JSON format.
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -8661,9 +8528,9 @@ spec:
traits share this common property.
type: boolean
endpointSinks:
- description: |-
- List of endpoints used as destination of integration routes.
- Can contain simple endpoint names or full Camel URIs.
+ description: List of endpoints used as destination of integration
+ routes. Can contain simple endpoint names or full Camel
+ URIs.
items:
type: string
type: array
@@ -8674,50 +8541,54 @@ spec:
type: string
type: array
eventSinks:
- description: |-
- List of event types that the integration will produce.
- Can contain simple event types or full Camel URIs (to use a specific broker).
+ description: List of event types that the integration will
+ produce. Can contain simple event types or full Camel URIs
+ (to use a specific broker).
items:
type: string
type: array
eventSources:
- description: |-
- List of event types that the integration will be subscribed to.
- Can contain simple event types or full Camel URIs (to use a specific broker different from "default").
+ description: List of event types that the integration will
+ be subscribed to. Can contain simple event types or full
+ Camel URIs (to use a specific broker different from "default").
items:
type: string
type: array
filterEventType:
- description: |-
- Enables the default filtering for the Knative trigger using the event type
- If this is true, the created Knative trigger uses the event type as a filter on the event stream when no other filter criteria is given. (default: true)
+ description: 'Enables the default filtering for the Knative
+ trigger using the event type If this is true, the created
+ Knative trigger uses the event type as a filter on the event
+ stream when no other filter criteria is given. (default:
+ true)'
type: boolean
filterSourceChannels:
- description: |-
- Enables filtering on events based on the header "ce-knativehistory". Since this header has been removed in newer versions of
- Knative, filtering is disabled by default.
+ description: Enables filtering on events based on the header
+ "ce-knativehistory". Since this header has been removed
+ in newer versions of Knative, filtering is disabled by default.
type: boolean
filters:
- description: |-
- Sets filter attributes on the event stream (such as event type, source, subject and so on).
- A list of key-value pairs that represent filter attributes and its values.
- The syntax is KEY=VALUE, e.g., `source="my.source"`.
- Filter attributes get set on the Knative trigger that is being created as part of this integration.
+ description: Sets filter attributes on the event stream (such
+ as event type, source, subject and so on). A list of key-value
+ pairs that represent filter attributes and its values. The
+ syntax is KEY=VALUE, e.g., `source="my.source"`. Filter
+ attributes get set on the Knative trigger that is being
+ created as part of this integration.
items:
type: string
type: array
namespaceLabel:
- description: |-
- Enables the camel-k-operator to set the "bindings.knative.dev/include=true" label to the namespace
- As Knative requires this label to perform injection of K_SINK URL into the service.
- If this is false, the integration pod may start and fail, read the SinkBinding Knative documentation. (default: true)
+ description: 'Enables the camel-k-operator to set the "bindings.knative.dev/include=true"
+ label to the namespace As Knative requires this label to
+ perform injection of K_SINK URL into the service. If this
+ is false, the integration pod may start and fail, read the
+ SinkBinding Knative documentation. (default: true)'
type: boolean
sinkBinding:
- description: |-
- Allows binding the integration to a sink via a Knative SinkBinding resource.
- This can be used when the integration targets a single sink.
- It's enabled by default when the integration targets a single sink
- (except when the integration is owned by a Knative source).
+ description: Allows binding the integration to a sink via
+ a Knative SinkBinding resource. This can be used when the
+ integration targets a single sink. It's enabled by default
+ when the integration targets a single sink (except when
+ the integration is owned by a Knative source).
type: boolean
type: object
knative-service:
@@ -8726,47 +8597,39 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to route.
- This can be used to set knative service specific annotations
- CLI usage example: -t "knative-service.annotations.'haproxy.router.openshift.io/balance'=true"
+ description: 'The annotations added to route. This can be
+ used to set knative service specific annotations CLI usage
+ example: -t "knative-service.annotations.''haproxy.router.openshift.io/balance''=true"'
type: object
auto:
- description: |-
- Automatically deploy the integration as Knative service when all conditions hold:
-
-
- * Integration is using the Knative profile
- * All routes are either starting from an HTTP based consumer or a passive consumer (e.g. `direct` is a passive consumer)
+ description: "Automatically deploy the integration as Knative
+ service when all conditions hold: \n * Integration is using
+ the Knative profile * All routes are either starting from
+ an HTTP based consumer or a passive consumer (e.g. `direct`
+ is a passive consumer)"
type: boolean
autoscalingMetric:
- description: |-
- Configures the Knative autoscaling metric property (e.g. to set `concurrency` based or `cpu` based autoscaling).
-
-
- Refer to the Knative documentation for more information.
+ description: "Configures the Knative autoscaling metric property
+ (e.g. to set `concurrency` based or `cpu` based autoscaling).
+ \n Refer to the Knative documentation for more information."
type: string
autoscalingTarget:
- description: |-
- Sets the allowed concurrency level or CPU percentage (depending on the autoscaling metric) for each Pod.
-
-
- Refer to the Knative documentation for more information.
+ description: "Sets the allowed concurrency level or CPU percentage
+ (depending on the autoscaling metric) for each Pod. \n Refer
+ to the Knative documentation for more information."
type: integer
class:
- description: |-
- Configures the Knative autoscaling class property (e.g. to set `hpa.autoscaling.knative.dev` or `kpa.autoscaling.knative.dev` autoscaling).
-
-
- Refer to the Knative documentation for more information.
+ description: "Configures the Knative autoscaling class property
+ (e.g. to set `hpa.autoscaling.knative.dev` or `kpa.autoscaling.knative.dev`
+ autoscaling). \n Refer to the Knative documentation for
+ more information."
enum:
- kpa.autoscaling.knative.dev
- hpa.autoscaling.knative.dev
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -8774,43 +8637,36 @@ spec:
traits share this common property.
type: boolean
maxScale:
- description: |-
- An upper bound for the number of Pods that can be running in parallel for the integration.
- Knative has its own cap value that depends on the installation.
-
-
- Refer to the Knative documentation for more information.
+ description: "An upper bound for the number of Pods that can
+ be running in parallel for the integration. Knative has
+ its own cap value that depends on the installation. \n Refer
+ to the Knative documentation for more information."
type: integer
minScale:
- description: |-
- The minimum number of Pods that should be running at any time for the integration. It's **zero** by default, meaning that
- the integration is scaled down to zero when not used for a configured amount of time.
-
-
- Refer to the Knative documentation for more information.
+ description: "The minimum number of Pods that should be running
+ at any time for the integration. It's **zero** by default,
+ meaning that the integration is scaled down to zero when
+ not used for a configured amount of time. \n Refer to the
+ Knative documentation for more information."
type: integer
rolloutDuration:
- description: |-
- Enables to gradually shift traffic to the latest Revision and sets the rollout duration.
- It's disabled by default and must be expressed as a Golang `time.Duration` string representation,
- rounded to a second precision.
+ description: Enables to gradually shift traffic to the latest
+ Revision and sets the rollout duration. It's disabled by
+ default and must be expressed as a Golang `time.Duration`
+ string representation, rounded to a second precision.
type: string
timeoutSeconds:
- description: |-
- The maximum duration in seconds that the request instance is allowed to respond to a request.
- This field propagates to the integration pod's terminationGracePeriodSeconds
-
-
- Refer to the Knative documentation for more information.
+ description: "The maximum duration in seconds that the request
+ instance is allowed to respond to a request. This field
+ propagates to the integration pod's terminationGracePeriodSeconds
+ \n Refer to the Knative documentation for more information."
format: int64
type: integer
visibility:
- description: |-
- Setting `cluster-local`, Knative service becomes a private service.
- Specifically, this option applies the `networking.knative.dev/visibility` label to Knative service.
-
-
- Refer to the Knative documentation for more information.
+ description: "Setting `cluster-local`, Knative service becomes
+ a private service. Specifically, this option applies the
+ `networking.knative.dev/visibility` label to Knative service.
+ \n Refer to the Knative documentation for more information."
enum:
- cluster-local
type: string
@@ -8822,9 +8678,8 @@ spec:
description: Colorize the log output
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -8864,18 +8719,20 @@ spec:
description: The configuration of Mount trait
properties:
configs:
- description: |-
- A list of configuration pointing to configmap/secret.
- The configuration are expected to be UTF-8 resources as they are processed by runtime Camel Context and tried to be parsed as property files.
- They are also made available on the classpath in order to ease their usage directly from the Route.
- Syntax: [configmap|secret]:name[/key], where name represents the resource name and key optionally represents the resource key to be filtered
+ description: 'A list of configuration pointing to configmap/secret.
+ The configuration are expected to be UTF-8 resources as
+ they are processed by runtime Camel Context and tried to
+ be parsed as property files. They are also made available
+ on the classpath in order to ease their usage directly from
+ the Route. Syntax: [configmap|secret]:name[/key], where
+ name represents the resource name and key optionally represents
+ the resource key to be filtered'
items:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
emptyDirs:
@@ -8888,17 +8745,21 @@ spec:
description: 'Deprecated: no longer in use.'
type: boolean
hotReload:
- description: |-
- Enable "hot reload" when a secret/configmap mounted is edited (default `false`). The configmap/secret must be
- marked with `camel.apache.org/integration` label to be taken in account. The resource will be watched for any kind change, also for
- changes in metadata.
+ description: Enable "hot reload" when a secret/configmap mounted
+ is edited (default `false`). The configmap/secret must be
+ marked with `camel.apache.org/integration` label to be taken
+ in account. The resource will be watched for any kind change,
+ also for changes in metadata.
type: boolean
resources:
- description: |-
- A list of resources (text or binary content) pointing to configmap/secret.
- The resources are expected to be any resource type (text or binary content).
- The destination path can be either a default location or any path specified by the user.
- Syntax: [configmap|secret]:name[/key][@path], where name represents the resource name, key optionally represents the resource key to be filtered and path represents the destination path
+ description: 'A list of resources (text or binary content)
+ pointing to configmap/secret. The resources are expected
+ to be any resource type (text or binary content). The destination
+ path can be either a default location or any path specified
+ by the user. Syntax: [configmap|secret]:name[/key][@path],
+ where name represents the resource name, key optionally
+ represents the resource key to be filtered and path represents
+ the destination path'
items:
type: string
type: array
@@ -8923,9 +8784,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -8936,9 +8796,8 @@ spec:
description: The configuration of Owner trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -8960,9 +8819,8 @@ spec:
description: The configuration of PDB trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -8970,53 +8828,56 @@ spec:
traits share this common property.
type: boolean
maxUnavailable:
- description: |-
- The number of pods for the Integration that can be unavailable after an eviction.
- It can be either an absolute number or a percentage (default `1` if `min-available` is also not set).
- Only one of `max-unavailable` and `min-available` can be specified.
+ description: The number of pods for the Integration that can
+ be unavailable after an eviction. It can be either an absolute
+ number or a percentage (default `1` if `min-available` is
+ also not set). Only one of `max-unavailable` and `min-available`
+ can be specified.
type: string
minAvailable:
- description: |-
- The number of pods for the Integration that must still be available after an eviction.
- It can be either an absolute number or a percentage.
- Only one of `min-available` and `max-unavailable` can be specified.
+ description: The number of pods for the Integration that must
+ still be available after an eviction. It can be either an
+ absolute number or a percentage. Only one of `min-available`
+ and `max-unavailable` can be specified.
type: string
type: object
platform:
description: The configuration of Platform trait
properties:
auto:
- description: |-
- To automatically detect from the environment if a default platform can be created (it will be created on OpenShift or when a registry address is set).
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'To automatically detect from the environment
+ if a default platform can be created (it will be created
+ on OpenShift or when a registry address is set). Deprecated:
+ Platform is auto generated by the operator install procedure
+ - maintained for backward compatibility'
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
createDefault:
- description: |-
- To create a default (empty) platform when the platform is missing.
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'To create a default (empty) platform when the
+ platform is missing. Deprecated: Platform is auto generated
+ by the operator install procedure - maintained for backward
+ compatibility'
type: boolean
enabled:
description: 'Deprecated: no longer in use.'
type: boolean
global:
- description: |-
- Indicates if the platform should be created globally in the case of global operator (default true).
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'Indicates if the platform should be created
+ globally in the case of global operator (default true).
+ Deprecated: Platform is auto generated by the operator install
+ procedure - maintained for backward compatibility'
type: boolean
type: object
pod:
description: The configuration of Pod trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -9028,9 +8889,8 @@ spec:
description: The configuration of Prometheus trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -9056,9 +8916,8 @@ spec:
secret on the pod if it is of type `kubernetes.io/dockerconfigjson`.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -9081,10 +8940,10 @@ spec:
description: The configuration of Quarkus trait
properties:
buildMode:
- description: |-
- The Quarkus mode to run: either `jvm` or `native` (default `jvm`).
- In case both `jvm` and `native` are specified, two `IntegrationKit` resources are created,
- with the `native` kit having precedence over the `jvm` one once ready.
+ description: 'The Quarkus mode to run: either `jvm` or `native`
+ (default `jvm`). In case both `jvm` and `native` are specified,
+ two `IntegrationKit` resources are created, with the `native`
+ kit having precedence over the `jvm` one once ready.'
items:
description: QuarkusMode is the type of Quarkus build packaging.
enum:
@@ -9093,9 +8952,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -9111,18 +8969,18 @@ spec:
in the runtime catalog)
type: string
packageTypes:
- description: |-
- The Quarkus package types, `fast-jar` or `native` (default `fast-jar`).
- In case both `fast-jar` and `native` are specified, two `IntegrationKit` resources are created,
- with the native kit having precedence over the `fast-jar` one once ready.
- The order influences the resolution of the current kit for the integration.
- The kit corresponding to the first package type will be assigned to the
- integration in case no existing kit that matches the integration exists.
- Deprecated: use `build-mode` instead.
+ description: 'The Quarkus package types, `fast-jar` or `native`
+ (default `fast-jar`). In case both `fast-jar` and `native`
+ are specified, two `IntegrationKit` resources are created,
+ with the native kit having precedence over the `fast-jar`
+ one once ready. The order influences the resolution of the
+ current kit for the integration. The kit corresponding to
+ the first package type will be assigned to the integration
+ in case no existing kit that matches the integration exists.
+ Deprecated: use `build-mode` instead.'
items:
- description: |-
- QuarkusPackageType is the type of Quarkus build packaging.
- Deprecated: use `QuarkusMode` instead.
+ description: 'QuarkusPackageType is the type of Quarkus
+ build packaging. Deprecated: use `QuarkusMode` instead.'
enum:
- fast-jar
- native
@@ -9130,14 +8988,12 @@ spec:
type: array
type: object
registry:
- description: |-
- The configuration of Registry trait (support removed since version 2.5.0).
- Deprecated: use jvm trait or read documentation.
+ description: 'The configuration of Registry trait (support removed
+ since version 2.5.0). Deprecated: use jvm trait or read documentation.'
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -9151,16 +9007,14 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to route.
- This can be used to set route specific annotations
- For annotations options see https://docs.openshift.com/container-platform/3.11/architecture/networking/routes.html#route-specific-annotations
- CLI usage example: -t "route.annotations.'haproxy.router.openshift.io/balance'=true"
+ description: 'The annotations added to route. This can be
+ used to set route specific annotations For annotations options
+ see https://docs.openshift.com/container-platform/3.11/architecture/networking/routes.html#route-specific-annotations
+ CLI usage example: -t "route.annotations.''haproxy.router.openshift.io/balance''=true"'
type: object
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -9171,82 +9025,74 @@ spec:
description: To configure the host exposed by the route.
type: string
tlsCACertificate:
- description: |-
- The TLS CA certificate contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS CA certificate contents. \n Refer to
+ the OpenShift route documentation for additional information."
type: string
tlsCACertificateSecret:
- description: |-
- The secret name and key reference to the TLS CA certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the TLS
+ CA certificate. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only one
+ key in the secret it will be read, otherwise you can set
+ a key name separated with a \"/\". \n Refer to the OpenShift
+ route documentation for additional information."
type: string
tlsCertificate:
- description: |-
- The TLS certificate contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS certificate contents. \n Refer to the
+ OpenShift route documentation for additional information."
type: string
tlsCertificateSecret:
- description: |-
- The secret name and key reference to the TLS certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the TLS
+ certificate. The format is \"secret-name[/key-name]\", the
+ value represents the secret name, if there is only one key
+ in the secret it will be read, otherwise you can set a key
+ name separated with a \"/\". \n Refer to the OpenShift route
+ documentation for additional information."
type: string
tlsDestinationCACertificate:
- description: |-
- The destination CA certificate provides the contents of the ca certificate of the final destination. When using reencrypt
- termination this file should be provided in order to have routers use it for health checks on the secure connection.
- If this field is not specified, the router may provide its own destination CA and perform hostname validation using
- the short service name (service.namespace.svc), which allows infrastructure generated certificates to automatically
- verify.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The destination CA certificate provides the
+ contents of the ca certificate of the final destination.
+ \ When using reencrypt termination this file should be provided
+ in order to have routers use it for health checks on the
+ secure connection. If this field is not specified, the router
+ may provide its own destination CA and perform hostname
+ validation using the short service name (service.namespace.svc),
+ which allows infrastructure generated certificates to automatically
+ verify. \n Refer to the OpenShift route documentation for
+ additional information."
type: string
tlsDestinationCACertificateSecret:
- description: |-
- The secret name and key reference to the destination CA certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the destination
+ CA certificate. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only one
+ key in the secret it will be read, otherwise you can set
+ a key name separated with a \"/\". \n Refer to the OpenShift
+ route documentation for additional information."
type: string
tlsInsecureEdgeTerminationPolicy:
- description: |-
- To configure how to deal with insecure traffic, e.g. `Allow`, `Disable` or `Redirect` traffic.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "To configure how to deal with insecure traffic,
+ e.g. `Allow`, `Disable` or `Redirect` traffic. \n Refer
+ to the OpenShift route documentation for additional information."
enum:
- None
- Allow
- Redirect
type: string
tlsKey:
- description: |-
- The TLS certificate key contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS certificate key contents. \n Refer to
+ the OpenShift route documentation for additional information."
type: string
tlsKeySecret:
- description: |-
- The secret name and key reference to the TLS certificate key. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the TLS
+ certificate key. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only one
+ key in the secret it will be read, otherwise you can set
+ a key name separated with a \"/\". \n Refer to the OpenShift
+ route documentation for additional information."
type: string
tlsTermination:
- description: |-
- The TLS termination type, like `edge`, `passthrough` or `reencrypt`.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS termination type, like `edge`, `passthrough`
+ or `reencrypt`. \n Refer to the OpenShift route documentation
+ for additional information."
enum:
- edge
- reencrypt
@@ -9257,9 +9103,8 @@ spec:
description: The configuration of Security Context trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -9291,9 +9136,8 @@ spec:
needs to be created.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -9301,9 +9145,8 @@ spec:
traits share this common property.
type: boolean
nodePort:
- description: |-
- Enable Service to be exposed as NodePort (default `false`).
- Deprecated: Use service type instead.
+ description: 'Enable Service to be exposed as NodePort (default
+ `false`). Deprecated: Use service type instead.'
type: boolean
type:
description: The type of service to be used, either 'ClusterIP',
@@ -9318,9 +9161,8 @@ spec:
description: The configuration of Service Binding trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -9347,9 +9189,8 @@ spec:
description: The configuration of Toleration trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -9381,22 +9222,22 @@ spec:
description: specify how to build the Integration/IntegrationKits
properties:
baseImage:
- description: |-
- a base image that can be used as base layer for all images.
- It can be useful if you want to provide some custom base image with further utility software
+ description: a base image that can be used as base layer for all
+ images. It can be useful if you want to provide some custom
+ base image with further utility software
type: string
maven:
description: Maven configuration used to build the Camel/Camel-Quarkus
applications
properties:
caSecrets:
- description: |-
- The Secrets name and key, containing the CA certificate(s) used to connect
- to remote Maven repositories.
- It can contain X.509 certificates, and PKCS#7 formatted certificate chains.
- A JKS formatted keystore is automatically created to store the CA certificate(s),
- and configured to be used as a trusted certificate(s) by the Maven commands.
- Note that the root CA certificates are also imported into the created keystore.
+ description: The Secrets name and key, containing the CA certificate(s)
+ used to connect to remote Maven repositories. It can contain
+ X.509 certificates, and PKCS#7 formatted certificate chains.
+ A JKS formatted keystore is automatically created to store
+ the CA certificate(s), and configured to be used as a trusted
+ certificate(s) by the Maven commands. Note that the root
+ CA certificates are also imported into the created keystore.
items:
description: SecretKeySelector selects a key of a Secret.
properties:
@@ -9405,10 +9246,8 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
description: Specify whether the Secret or its key must
@@ -9417,20 +9256,16 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: array
cliOptions:
- description: |-
- The CLI options that are appended to the list of arguments for Maven commands,
- e.g., `-V,--no-transfer-progress,-Dstyle.color=never`.
+ description: The CLI options that are appended to the list
+ of arguments for Maven commands, e.g., `-V,--no-transfer-progress,-Dstyle.color=never`.
See https://maven.apache.org/ref/3.8.4/maven-embedder/cli.html.
items:
type: string
type: array
extension:
- description: |-
- The Maven build extensions.
- See https://maven.apache.org/guides/mini/guide-using-extensions.html.
+ description: The Maven build extensions. See https://maven.apache.org/guides/mini/guide-using-extensions.html.
items:
description: MavenArtifact defines a GAV (Group:Artifact:Type:Version:Classifier)
Maven artifact.
@@ -9459,9 +9294,8 @@ spec:
description: The path of the local Maven repository.
type: string
profiles:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the Maven profile.
+ description: A reference to the ConfigMap or Secret key that
+ contains the Maven profile.
items:
description: ValueSource --.
properties:
@@ -9472,10 +9306,9 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the ConfigMap or its
@@ -9484,7 +9317,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -9493,10 +9325,9 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the Secret or its key
@@ -9505,7 +9336,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
properties:
@@ -9514,9 +9344,8 @@ spec:
description: The Maven properties.
type: object
settings:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the Maven settings.
+ description: A reference to the ConfigMap or Secret key that
+ contains the Maven settings.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -9525,10 +9354,9 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the ConfigMap or its
@@ -9537,7 +9365,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -9546,10 +9373,9 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the Secret or its key
@@ -9558,12 +9384,10 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
settingsSecurity:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the security of the Maven settings.
+ description: A reference to the ConfigMap or Secret key that
+ contains the security of the Maven settings.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -9572,10 +9396,9 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the ConfigMap or its
@@ -9584,7 +9407,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -9593,10 +9415,9 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the Secret or its key
@@ -9605,7 +9426,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: object
registry:
@@ -9726,9 +9546,8 @@ spec:
description: The configuration of Affinity trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -9747,9 +9566,9 @@ spec:
in the same node (default `false`).
type: boolean
podAffinityLabels:
- description: |-
- Defines a set of pods (namely those matching the label selector, relative to the given namespace) that the
- integration pod(s) should be co-located with.
+ description: Defines a set of pods (namely those matching
+ the label selector, relative to the given namespace) that
+ the integration pod(s) should be co-located with.
items:
type: string
type: array
@@ -9758,9 +9577,9 @@ spec:
in the same node (default `false`).
type: boolean
podAntiAffinityLabels:
- description: |-
- Defines a set of pods (namely those matching the label selector, relative to the given namespace) that the
- integration pod(s) should not be co-located with.
+ description: Defines a set of pods (namely those matching
+ the label selector, relative to the given namespace) that
+ the integration pod(s) should not be co-located with.
items:
type: string
type: array
@@ -9775,14 +9594,13 @@ spec:
for the builder pod.
type: object
baseImage:
- description: |-
- Specify a base image. In order to have the application working properly it must be a container image which has a Java JDK
- installed and ready to use on path (ie `/usr/bin/java`).
+ description: Specify a base image. In order to have the application
+ working properly it must be a container image which has
+ a Java JDK installed and ready to use on path (ie `/usr/bin/java`).
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -9793,21 +9611,27 @@ spec:
existing containers (default `true`)
type: boolean
limitCPU:
- description: |-
- When using `pod` strategy, the maximum amount of CPU required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the maximum amount
+ of CPU required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
limitMemory:
- description: |-
- When using `pod` strategy, the maximum amount of memory required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the maximum amount
+ of memory required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
mavenProfiles:
- description: |-
- A list of references pointing to configmaps/secrets that contains a maven profile.
- This configmap/secret is a resource of the IntegrationKit created, therefore it needs to be present in the namespace where the operator is going to create the IntegrationKit.
- The content of the maven profile is expected to be a text containing a valid maven profile starting with `` and ending with `` that will be integrated as an inline profile in the POM.
- Syntax: [configmap|secret]:name[/key], where name represents the resource name, key optionally represents the resource key to be filtered (default key value = profile.xml).
+ description: 'A list of references pointing to configmaps/secrets
+ that contains a maven profile. This configmap/secret is
+ a resource of the IntegrationKit created, therefore it needs
+ to be present in the namespace where the operator is going
+ to create the IntegrationKit. The content of the maven profile
+ is expected to be a text containing a valid maven profile
+ starting with `` and ending with `` that
+ will be integrated as an inline profile in the POM. Syntax:
+ [configmap|secret]:name[/key], where name represents the
+ resource name, key optionally represents the resource key
+ to be filtered (default key value = profile.xml).'
items:
type: string
type: array
@@ -9838,14 +9662,14 @@ spec:
type: string
type: array
requestCPU:
- description: |-
- When using `pod` strategy, the minimum amount of CPU required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the minimum amount
+ of CPU required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
requestMemory:
- description: |-
- When using `pod` strategy, the minimum amount of memory required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the minimum amount
+ of memory required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
strategy:
description: The strategy to use, either `pod` or `routine`
@@ -9861,10 +9685,11 @@ spec:
type: string
type: array
tasksFilter:
- description: |-
- A list of tasks sorted by the order of execution in a csv format, ie, `,,...`.
- Mind that you must include also the operator tasks (`builder`, `quarkus-native`, `package`, `jib`, `s2i`)
- if you need to execute them. Useful only with `pod` strategy.
+ description: A list of tasks sorted by the order of execution
+ in a csv format, ie, `,,...`. Mind
+ that you must include also the operator tasks (`builder`,
+ `quarkus-native`, `package`, `jib`, `s2i`) if you need to
+ execute them. Useful only with `pod` strategy.
type: string
tasksLimitCPU:
description: A list of limit cpu configuration for the specific
@@ -9891,18 +9716,17 @@ spec:
type: string
type: array
verbose:
- description: |-
- Enable verbose logging on build components that support it (e.g. Kaniko build pod).
- Deprecated no longer in use
+ description: Enable verbose logging on build components that
+ support it (e.g. Kaniko build pod). Deprecated no longer
+ in use
type: boolean
type: object
camel:
description: The configuration of Camel trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -9915,10 +9739,12 @@ spec:
type: string
type: array
runtimeVersion:
- description: |-
- The camel-k-runtime version to use for the integration. It overrides the default version set in the Integration Platform.
- You can use a fixed version (for example "3.2.3") or a semantic version (for example "3.x") which will try to resolve
- to the best matching Catalog existing on the cluster.
+ description: The camel-k-runtime version to use for the integration.
+ It overrides the default version set in the Integration
+ Platform. You can use a fixed version (for example "3.2.3")
+ or a semantic version (for example "3.x") which will try
+ to resolve to the best matching Catalog existing on the
+ cluster.
type: string
type: object
container:
@@ -9946,9 +9772,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -9959,10 +9784,13 @@ spec:
Service.
type: boolean
image:
- description: |-
- The main container image to use for the Integration. When using this parameter the operator will create a synthetic IntegrationKit which
- won't be able to execute traits requiring CamelCatalog. If the container image you're using is coming from an IntegrationKit, use instead
- Integration `.spec.integrationKit` parameter. If you're moving the Integration across environments, you will also need to create an "external" IntegrationKit.
+ description: The main container image to use for the Integration.
+ When using this parameter the operator will create a synthetic
+ IntegrationKit which won't be able to execute traits requiring
+ CamelCatalog. If the container image you're using is coming
+ from an IntegrationKit, use instead Integration `.spec.integrationKit`
+ parameter. If you're moving the Integration across environments,
+ you will also need to create an "external" IntegrationKit.
type: string
imagePullPolicy:
description: 'The pull policy: Always|Never|IfNotPresent'
@@ -10030,52 +9858,50 @@ spec:
description: The configuration of Cron trait
properties:
activeDeadlineSeconds:
- description: |-
- Specifies the duration in seconds, relative to the start time, that the job
- may be continuously active before it is considered to be failed.
- It defaults to 60s.
+ description: Specifies the duration in seconds, relative to
+ the start time, that the job may be continuously active
+ before it is considered to be failed. It defaults to 60s.
format: int64
type: integer
auto:
- description: |-
- Automatically deploy the integration as CronJob when all routes are
- either starting from a periodic consumer (only `cron`, `timer` and `quartz` are supported) or a passive consumer (e.g. `direct` is a passive consumer).
-
-
- It's required that all periodic consumers have the same period, and it can be expressed as cron schedule (e.g. `1m` can be expressed as `0/1 * * * *`,
- while `35m` or `50s` cannot).
+ description: "Automatically deploy the integration as CronJob
+ when all routes are either starting from a periodic consumer
+ (only `cron`, `timer` and `quartz` are supported) or a passive
+ consumer (e.g. `direct` is a passive consumer). \n It's
+ required that all periodic consumers have the same period,
+ and it can be expressed as cron schedule (e.g. `1m` can
+ be expressed as `0/1 * * * *`, while `35m` or `50s` cannot)."
type: boolean
backoffLimit:
- description: |-
- Specifies the number of retries before marking the job failed.
- It defaults to 2.
+ description: Specifies the number of retries before marking
+ the job failed. It defaults to 2.
format: int32
type: integer
components:
- description: |-
- A comma separated list of the Camel components that need to be customized in order for them to work when the schedule is triggered externally by Kubernetes.
- A specific customizer is activated for each specified component. E.g. for the `timer` component, the `cron-timer` customizer is
- activated (it's present in the `org.apache.camel.k:camel-k-cron` library).
-
-
- Supported components are currently: `cron`, `timer` and `quartz`.
+ description: "A comma separated list of the Camel components
+ that need to be customized in order for them to work when
+ the schedule is triggered externally by Kubernetes. A specific
+ customizer is activated for each specified component. E.g.
+ for the `timer` component, the `cron-timer` customizer is
+ activated (it's present in the `org.apache.camel.k:camel-k-cron`
+ library). \n Supported components are currently: `cron`,
+ `timer` and `quartz`."
type: string
concurrencyPolicy:
- description: |-
- Specifies how to treat concurrent executions of a Job.
- Valid values are:
- - "Allow": allows CronJobs to run concurrently;
- - "Forbid" (default): forbids concurrent runs, skipping next run if previous run hasn't finished yet;
- - "Replace": cancels currently running job and replaces it with a new one
+ description: 'Specifies how to treat concurrent executions
+ of a Job. Valid values are: - "Allow": allows CronJobs to
+ run concurrently; - "Forbid" (default): forbids concurrent
+ runs, skipping next run if previous run hasn''t finished
+ yet; - "Replace": cancels currently running job and replaces
+ it with a new one'
enum:
- Allow
- Forbid
- Replace
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -10083,19 +9909,19 @@ spec:
traits share this common property.
type: boolean
fallback:
- description: |-
- Use the default Camel implementation of the `cron` endpoint (`quartz`) instead of trying to materialize the integration
- as Kubernetes CronJob.
+ description: Use the default Camel implementation of the `cron`
+ endpoint (`quartz`) instead of trying to materialize the
+ integration as Kubernetes CronJob.
type: boolean
schedule:
- description: |-
- The CronJob schedule for the whole integration. If multiple routes are declared, they must have the same schedule for this
- mechanism to work correctly.
+ description: The CronJob schedule for the whole integration.
+ If multiple routes are declared, they must have the same
+ schedule for this mechanism to work correctly.
type: string
startingDeadlineSeconds:
- description: |-
- Optional deadline in seconds for starting the job if it misses scheduled
- time for any reason. Missed jobs executions will be counted as failed ones.
+ description: Optional deadline in seconds for starting the
+ job if it misses scheduled time for any reason. Missed
+ jobs executions will be counted as failed ones.
format: int64
type: integer
timeZone:
@@ -10106,9 +9932,8 @@ spec:
description: The configuration of Dependencies trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -10119,9 +9944,8 @@ spec:
description: The configuration of Deployer trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -10137,51 +9961,49 @@ spec:
- knative-service
type: string
useSSA:
- description: |-
- Use server-side apply to update the owned resources (default `true`).
- Note that it automatically falls back to client-side patching, if SSA is not available, e.g., on old Kubernetes clusters.
+ description: Use server-side apply to update the owned resources
+ (default `true`). Note that it automatically falls back
+ to client-side patching, if SSA is not available, e.g.,
+ on old Kubernetes clusters.
type: boolean
type: object
deployment:
description: The configuration of Deployment trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
description: 'Deprecated: no longer in use.'
type: boolean
progressDeadlineSeconds:
- description: |-
- The maximum time in seconds for the deployment to make progress before it
- is considered to be failed. It defaults to `60s`.
+ description: The maximum time in seconds for the deployment
+ to make progress before it is considered to be failed. It
+ defaults to `60s`.
format: int32
type: integer
rollingUpdateMaxSurge:
anyOf:
- type: integer
- type: string
- description: |-
- The maximum number of pods that can be scheduled above the desired number of
- pods.
- Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
- This can not be 0 if MaxUnavailable is 0.
- Absolute number is calculated from percentage by rounding up.
- Defaults to `25%`.
+ description: 'The maximum number of pods that can be scheduled
+ above the desired number of pods. Value can be an absolute
+ number (ex: 5) or a percentage of desired pods (ex: 10%).
+ This can not be 0 if MaxUnavailable is 0. Absolute number
+ is calculated from percentage by rounding up. Defaults to
+ `25%`.'
x-kubernetes-int-or-string: true
rollingUpdateMaxUnavailable:
anyOf:
- type: integer
- type: string
- description: |-
- The maximum number of pods that can be unavailable during the update.
- Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
- Absolute number is calculated from percentage by rounding down.
- This can not be 0 if MaxSurge is 0.
- Defaults to `25%`.
+ description: 'The maximum number of pods that can be unavailable
+ during the update. Value can be an absolute number (ex:
+ 5) or a percentage of desired pods (ex: 10%). Absolute number
+ is calculated from percentage by rounding down. This can
+ not be 0 if MaxSurge is 0. Defaults to `25%`.'
x-kubernetes-int-or-string: true
strategy:
description: The deployment strategy to use to replace existing
@@ -10195,9 +10017,8 @@ spec:
description: The configuration of Environment trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
containerMeta:
@@ -10212,11 +10033,12 @@ spec:
`NO_PROXY` environment variables (default `true`)
type: boolean
vars:
- description: |-
- A list of environment variables to be added to the integration container.
- The syntax is either VAR=VALUE or VAR=[configmap|secret]:name/key, where name represents the resource name,
- and key represents the resource key to be mapped as and environment variable.
- These take precedence over any previously defined environment variables.
+ description: A list of environment variables to be added to
+ the integration container. The syntax is either VAR=VALUE
+ or VAR=[configmap|secret]:name/key, where name represents
+ the resource name, and key represents the resource key to
+ be mapped as and environment variable. These take precedence
+ over any previously defined environment variables.
items:
type: string
type: array
@@ -10225,9 +10047,8 @@ spec:
description: The configuration of Error Handler trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -10242,15 +10063,14 @@ spec:
description: The configuration of GC trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
discoveryCache:
- description: |-
- Discovery client cache to be used, either `disabled`, `disk` or `memory` (default `memory`).
- Deprecated: to be removed from trait configuration.
+ description: 'Discovery client cache to be used, either `disabled`,
+ `disk` or `memory` (default `memory`). Deprecated: to be
+ removed from trait configuration.'
enum:
- disabled
- disk
@@ -10265,9 +10085,8 @@ spec:
description: The configuration of Health trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -10389,19 +10208,17 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to the ingress.
- This can be used to set controller specific annotations, e.g., when using the NGINX Ingress controller:
- See https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md
+ description: 'The annotations added to the ingress. This can
+ be used to set controller specific annotations, e.g., when
+ using the NGINX Ingress controller: See https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md'
type: object
auto:
description: To automatically add an ingress whenever the
integration uses an HTTP endpoint consumer.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -10411,14 +10228,18 @@ spec:
host:
description: To configure the host exposed by the ingress.
type: string
+ ingressClassName:
+ description: The Ingress class name as defined by the Ingress
+ spec See https://kubernetes.io/docs/concepts/services-networking/ingress/
+ type: string
path:
description: To configure the path exposed by the ingress
(default `/`).
type: string
pathType:
- description: |-
- To configure the path type exposed by the ingress.
- One of `Exact`, `Prefix`, `ImplementationSpecific` (default to `Prefix`).
+ description: To configure the path type exposed by the ingress.
+ One of `Exact`, `Prefix`, `ImplementationSpecific` (default
+ to `Prefix`).
enum:
- Exact
- Prefix
@@ -10442,9 +10263,8 @@ spec:
by default).
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -10461,23 +10281,25 @@ spec:
description: The configuration of Jolokia trait
properties:
CACert:
- description: |-
- The PEM encoded CA certification file path, used to verify client certificates,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt` for OpenShift).
+ description: The PEM encoded CA certification file path, used
+ to verify client certificates, applicable when `protocol`
+ is `https` and `use-ssl-client-authentication` is `true`
+ (default `/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt`
+ for OpenShift).
type: string
clientPrincipal:
- description: |-
- The principal(s) which must be given in a client certificate to allow access to the Jolokia endpoint,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `clientPrincipal=cn=system:master-proxy`, `cn=hawtio-online.hawtio.svc` and `cn=fuse-console.fuse.svc` for OpenShift).
+ description: The principal(s) which must be given in a client
+ certificate to allow access to the Jolokia endpoint, applicable
+ when `protocol` is `https` and `use-ssl-client-authentication`
+ is `true` (default `clientPrincipal=cn=system:master-proxy`,
+ `cn=hawtio-online.hawtio.svc` and `cn=fuse-console.fuse.svc`
+ for OpenShift).
items:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
discoveryEnabled:
@@ -10488,20 +10310,20 @@ spec:
traits share this common property.
type: boolean
extendedClientCheck:
- description: |-
- Mandate the client certificate contains a client flag in the extended key usage section,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `true` for OpenShift).
+ description: Mandate the client certificate contains a client
+ flag in the extended key usage section, applicable when
+ `protocol` is `https` and `use-ssl-client-authentication`
+ is `true` (default `true` for OpenShift).
type: boolean
host:
- description: |-
- The Host address to which the Jolokia agent should bind to. If `"\*"` or `"0.0.0.0"` is given,
- the servers binds to every network interface (default `"*"`).
+ description: The Host address to which the Jolokia agent should
+ bind to. If `"\*"` or `"0.0.0.0"` is given, the servers
+ binds to every network interface (default `"*"`).
type: string
options:
- description: |-
- A list of additional Jolokia options as defined
- in https://jolokia.org/reference/html/agents.html#agent-jvm-config[JVM agent configuration options]
+ description: A list of additional Jolokia options as defined
+ in https://jolokia.org/reference/html/agents.html#agent-jvm-config[JVM
+ agent configuration options]
items:
type: string
type: array
@@ -10532,9 +10354,8 @@ spec:
separator)
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
debug:
@@ -10563,9 +10384,9 @@ spec:
type: string
type: array
printCommand:
- description: |-
- Prints the command used the start the JVM in the container logs (default `true`)
- Deprecated: no longer in use.
+ description: 'Prints the command used the start the JVM in
+ the container logs (default `true`) Deprecated: no longer
+ in use.'
type: boolean
type: object
kamelets:
@@ -10576,9 +10397,8 @@ spec:
and their default configuration (enabled by default)
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -10611,16 +10431,14 @@ spec:
description: Enable automatic discovery of all trait properties.
type: boolean
channelSinks:
- description: |-
- List of channels used as destination of integration routes.
- Can contain simple channel names or full Camel URIs.
+ description: List of channels used as destination of integration
+ routes. Can contain simple channel names or full Camel URIs.
items:
type: string
type: array
channelSources:
- description: |-
- List of channels used as source of integration routes.
- Can contain simple channel names or full Camel URIs.
+ description: List of channels used as source of integration
+ routes. Can contain simple channel names or full Camel URIs.
items:
type: string
type: array
@@ -10629,9 +10447,8 @@ spec:
in JSON format.
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -10639,9 +10456,9 @@ spec:
traits share this common property.
type: boolean
endpointSinks:
- description: |-
- List of endpoints used as destination of integration routes.
- Can contain simple endpoint names or full Camel URIs.
+ description: List of endpoints used as destination of integration
+ routes. Can contain simple endpoint names or full Camel
+ URIs.
items:
type: string
type: array
@@ -10652,50 +10469,54 @@ spec:
type: string
type: array
eventSinks:
- description: |-
- List of event types that the integration will produce.
- Can contain simple event types or full Camel URIs (to use a specific broker).
+ description: List of event types that the integration will
+ produce. Can contain simple event types or full Camel URIs
+ (to use a specific broker).
items:
type: string
type: array
eventSources:
- description: |-
- List of event types that the integration will be subscribed to.
- Can contain simple event types or full Camel URIs (to use a specific broker different from "default").
+ description: List of event types that the integration will
+ be subscribed to. Can contain simple event types or full
+ Camel URIs (to use a specific broker different from "default").
items:
type: string
type: array
filterEventType:
- description: |-
- Enables the default filtering for the Knative trigger using the event type
- If this is true, the created Knative trigger uses the event type as a filter on the event stream when no other filter criteria is given. (default: true)
+ description: 'Enables the default filtering for the Knative
+ trigger using the event type If this is true, the created
+ Knative trigger uses the event type as a filter on the event
+ stream when no other filter criteria is given. (default:
+ true)'
type: boolean
filterSourceChannels:
- description: |-
- Enables filtering on events based on the header "ce-knativehistory". Since this header has been removed in newer versions of
- Knative, filtering is disabled by default.
+ description: Enables filtering on events based on the header
+ "ce-knativehistory". Since this header has been removed
+ in newer versions of Knative, filtering is disabled by default.
type: boolean
filters:
- description: |-
- Sets filter attributes on the event stream (such as event type, source, subject and so on).
- A list of key-value pairs that represent filter attributes and its values.
- The syntax is KEY=VALUE, e.g., `source="my.source"`.
- Filter attributes get set on the Knative trigger that is being created as part of this integration.
+ description: Sets filter attributes on the event stream (such
+ as event type, source, subject and so on). A list of key-value
+ pairs that represent filter attributes and its values. The
+ syntax is KEY=VALUE, e.g., `source="my.source"`. Filter
+ attributes get set on the Knative trigger that is being
+ created as part of this integration.
items:
type: string
type: array
namespaceLabel:
- description: |-
- Enables the camel-k-operator to set the "bindings.knative.dev/include=true" label to the namespace
- As Knative requires this label to perform injection of K_SINK URL into the service.
- If this is false, the integration pod may start and fail, read the SinkBinding Knative documentation. (default: true)
+ description: 'Enables the camel-k-operator to set the "bindings.knative.dev/include=true"
+ label to the namespace As Knative requires this label to
+ perform injection of K_SINK URL into the service. If this
+ is false, the integration pod may start and fail, read the
+ SinkBinding Knative documentation. (default: true)'
type: boolean
sinkBinding:
- description: |-
- Allows binding the integration to a sink via a Knative SinkBinding resource.
- This can be used when the integration targets a single sink.
- It's enabled by default when the integration targets a single sink
- (except when the integration is owned by a Knative source).
+ description: Allows binding the integration to a sink via
+ a Knative SinkBinding resource. This can be used when the
+ integration targets a single sink. It's enabled by default
+ when the integration targets a single sink (except when
+ the integration is owned by a Knative source).
type: boolean
type: object
knative-service:
@@ -10704,47 +10525,39 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to route.
- This can be used to set knative service specific annotations
- CLI usage example: -t "knative-service.annotations.'haproxy.router.openshift.io/balance'=true"
+ description: 'The annotations added to route. This can be
+ used to set knative service specific annotations CLI usage
+ example: -t "knative-service.annotations.''haproxy.router.openshift.io/balance''=true"'
type: object
auto:
- description: |-
- Automatically deploy the integration as Knative service when all conditions hold:
-
-
- * Integration is using the Knative profile
- * All routes are either starting from an HTTP based consumer or a passive consumer (e.g. `direct` is a passive consumer)
+ description: "Automatically deploy the integration as Knative
+ service when all conditions hold: \n * Integration is using
+ the Knative profile * All routes are either starting from
+ an HTTP based consumer or a passive consumer (e.g. `direct`
+ is a passive consumer)"
type: boolean
autoscalingMetric:
- description: |-
- Configures the Knative autoscaling metric property (e.g. to set `concurrency` based or `cpu` based autoscaling).
-
-
- Refer to the Knative documentation for more information.
+ description: "Configures the Knative autoscaling metric property
+ (e.g. to set `concurrency` based or `cpu` based autoscaling).
+ \n Refer to the Knative documentation for more information."
type: string
autoscalingTarget:
- description: |-
- Sets the allowed concurrency level or CPU percentage (depending on the autoscaling metric) for each Pod.
-
-
- Refer to the Knative documentation for more information.
+ description: "Sets the allowed concurrency level or CPU percentage
+ (depending on the autoscaling metric) for each Pod. \n Refer
+ to the Knative documentation for more information."
type: integer
class:
- description: |-
- Configures the Knative autoscaling class property (e.g. to set `hpa.autoscaling.knative.dev` or `kpa.autoscaling.knative.dev` autoscaling).
-
-
- Refer to the Knative documentation for more information.
+ description: "Configures the Knative autoscaling class property
+ (e.g. to set `hpa.autoscaling.knative.dev` or `kpa.autoscaling.knative.dev`
+ autoscaling). \n Refer to the Knative documentation for
+ more information."
enum:
- kpa.autoscaling.knative.dev
- hpa.autoscaling.knative.dev
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -10752,43 +10565,36 @@ spec:
traits share this common property.
type: boolean
maxScale:
- description: |-
- An upper bound for the number of Pods that can be running in parallel for the integration.
- Knative has its own cap value that depends on the installation.
-
-
- Refer to the Knative documentation for more information.
+ description: "An upper bound for the number of Pods that can
+ be running in parallel for the integration. Knative has
+ its own cap value that depends on the installation. \n Refer
+ to the Knative documentation for more information."
type: integer
minScale:
- description: |-
- The minimum number of Pods that should be running at any time for the integration. It's **zero** by default, meaning that
- the integration is scaled down to zero when not used for a configured amount of time.
-
-
- Refer to the Knative documentation for more information.
+ description: "The minimum number of Pods that should be running
+ at any time for the integration. It's **zero** by default,
+ meaning that the integration is scaled down to zero when
+ not used for a configured amount of time. \n Refer to the
+ Knative documentation for more information."
type: integer
rolloutDuration:
- description: |-
- Enables to gradually shift traffic to the latest Revision and sets the rollout duration.
- It's disabled by default and must be expressed as a Golang `time.Duration` string representation,
- rounded to a second precision.
+ description: Enables to gradually shift traffic to the latest
+ Revision and sets the rollout duration. It's disabled by
+ default and must be expressed as a Golang `time.Duration`
+ string representation, rounded to a second precision.
type: string
timeoutSeconds:
- description: |-
- The maximum duration in seconds that the request instance is allowed to respond to a request.
- This field propagates to the integration pod's terminationGracePeriodSeconds
-
-
- Refer to the Knative documentation for more information.
+ description: "The maximum duration in seconds that the request
+ instance is allowed to respond to a request. This field
+ propagates to the integration pod's terminationGracePeriodSeconds
+ \n Refer to the Knative documentation for more information."
format: int64
type: integer
visibility:
- description: |-
- Setting `cluster-local`, Knative service becomes a private service.
- Specifically, this option applies the `networking.knative.dev/visibility` label to Knative service.
-
-
- Refer to the Knative documentation for more information.
+ description: "Setting `cluster-local`, Knative service becomes
+ a private service. Specifically, this option applies the
+ `networking.knative.dev/visibility` label to Knative service.
+ \n Refer to the Knative documentation for more information."
enum:
- cluster-local
type: string
@@ -10800,9 +10606,8 @@ spec:
description: Colorize the log output
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -10842,18 +10647,20 @@ spec:
description: The configuration of Mount trait
properties:
configs:
- description: |-
- A list of configuration pointing to configmap/secret.
- The configuration are expected to be UTF-8 resources as they are processed by runtime Camel Context and tried to be parsed as property files.
- They are also made available on the classpath in order to ease their usage directly from the Route.
- Syntax: [configmap|secret]:name[/key], where name represents the resource name and key optionally represents the resource key to be filtered
+ description: 'A list of configuration pointing to configmap/secret.
+ The configuration are expected to be UTF-8 resources as
+ they are processed by runtime Camel Context and tried to
+ be parsed as property files. They are also made available
+ on the classpath in order to ease their usage directly from
+ the Route. Syntax: [configmap|secret]:name[/key], where
+ name represents the resource name and key optionally represents
+ the resource key to be filtered'
items:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
emptyDirs:
@@ -10866,17 +10673,21 @@ spec:
description: 'Deprecated: no longer in use.'
type: boolean
hotReload:
- description: |-
- Enable "hot reload" when a secret/configmap mounted is edited (default `false`). The configmap/secret must be
- marked with `camel.apache.org/integration` label to be taken in account. The resource will be watched for any kind change, also for
- changes in metadata.
+ description: Enable "hot reload" when a secret/configmap mounted
+ is edited (default `false`). The configmap/secret must be
+ marked with `camel.apache.org/integration` label to be taken
+ in account. The resource will be watched for any kind change,
+ also for changes in metadata.
type: boolean
resources:
- description: |-
- A list of resources (text or binary content) pointing to configmap/secret.
- The resources are expected to be any resource type (text or binary content).
- The destination path can be either a default location or any path specified by the user.
- Syntax: [configmap|secret]:name[/key][@path], where name represents the resource name, key optionally represents the resource key to be filtered and path represents the destination path
+ description: 'A list of resources (text or binary content)
+ pointing to configmap/secret. The resources are expected
+ to be any resource type (text or binary content). The destination
+ path can be either a default location or any path specified
+ by the user. Syntax: [configmap|secret]:name[/key][@path],
+ where name represents the resource name, key optionally
+ represents the resource key to be filtered and path represents
+ the destination path'
items:
type: string
type: array
@@ -10901,9 +10712,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -10914,9 +10724,8 @@ spec:
description: The configuration of Owner trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -10938,9 +10747,8 @@ spec:
description: The configuration of PDB trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -10948,53 +10756,56 @@ spec:
traits share this common property.
type: boolean
maxUnavailable:
- description: |-
- The number of pods for the Integration that can be unavailable after an eviction.
- It can be either an absolute number or a percentage (default `1` if `min-available` is also not set).
- Only one of `max-unavailable` and `min-available` can be specified.
+ description: The number of pods for the Integration that can
+ be unavailable after an eviction. It can be either an absolute
+ number or a percentage (default `1` if `min-available` is
+ also not set). Only one of `max-unavailable` and `min-available`
+ can be specified.
type: string
minAvailable:
- description: |-
- The number of pods for the Integration that must still be available after an eviction.
- It can be either an absolute number or a percentage.
- Only one of `min-available` and `max-unavailable` can be specified.
+ description: The number of pods for the Integration that must
+ still be available after an eviction. It can be either an
+ absolute number or a percentage. Only one of `min-available`
+ and `max-unavailable` can be specified.
type: string
type: object
platform:
description: The configuration of Platform trait
properties:
auto:
- description: |-
- To automatically detect from the environment if a default platform can be created (it will be created on OpenShift or when a registry address is set).
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'To automatically detect from the environment
+ if a default platform can be created (it will be created
+ on OpenShift or when a registry address is set). Deprecated:
+ Platform is auto generated by the operator install procedure
+ - maintained for backward compatibility'
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
createDefault:
- description: |-
- To create a default (empty) platform when the platform is missing.
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'To create a default (empty) platform when the
+ platform is missing. Deprecated: Platform is auto generated
+ by the operator install procedure - maintained for backward
+ compatibility'
type: boolean
enabled:
description: 'Deprecated: no longer in use.'
type: boolean
global:
- description: |-
- Indicates if the platform should be created globally in the case of global operator (default true).
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'Indicates if the platform should be created
+ globally in the case of global operator (default true).
+ Deprecated: Platform is auto generated by the operator install
+ procedure - maintained for backward compatibility'
type: boolean
type: object
pod:
description: The configuration of Pod trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -11006,9 +10817,8 @@ spec:
description: The configuration of Prometheus trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -11034,9 +10844,8 @@ spec:
secret on the pod if it is of type `kubernetes.io/dockerconfigjson`.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -11059,10 +10868,10 @@ spec:
description: The configuration of Quarkus trait
properties:
buildMode:
- description: |-
- The Quarkus mode to run: either `jvm` or `native` (default `jvm`).
- In case both `jvm` and `native` are specified, two `IntegrationKit` resources are created,
- with the `native` kit having precedence over the `jvm` one once ready.
+ description: 'The Quarkus mode to run: either `jvm` or `native`
+ (default `jvm`). In case both `jvm` and `native` are specified,
+ two `IntegrationKit` resources are created, with the `native`
+ kit having precedence over the `jvm` one once ready.'
items:
description: QuarkusMode is the type of Quarkus build packaging.
enum:
@@ -11071,9 +10880,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -11089,18 +10897,18 @@ spec:
in the runtime catalog)
type: string
packageTypes:
- description: |-
- The Quarkus package types, `fast-jar` or `native` (default `fast-jar`).
- In case both `fast-jar` and `native` are specified, two `IntegrationKit` resources are created,
- with the native kit having precedence over the `fast-jar` one once ready.
- The order influences the resolution of the current kit for the integration.
- The kit corresponding to the first package type will be assigned to the
- integration in case no existing kit that matches the integration exists.
- Deprecated: use `build-mode` instead.
+ description: 'The Quarkus package types, `fast-jar` or `native`
+ (default `fast-jar`). In case both `fast-jar` and `native`
+ are specified, two `IntegrationKit` resources are created,
+ with the native kit having precedence over the `fast-jar`
+ one once ready. The order influences the resolution of the
+ current kit for the integration. The kit corresponding to
+ the first package type will be assigned to the integration
+ in case no existing kit that matches the integration exists.
+ Deprecated: use `build-mode` instead.'
items:
- description: |-
- QuarkusPackageType is the type of Quarkus build packaging.
- Deprecated: use `QuarkusMode` instead.
+ description: 'QuarkusPackageType is the type of Quarkus
+ build packaging. Deprecated: use `QuarkusMode` instead.'
enum:
- fast-jar
- native
@@ -11108,14 +10916,12 @@ spec:
type: array
type: object
registry:
- description: |-
- The configuration of Registry trait (support removed since version 2.5.0).
- Deprecated: use jvm trait or read documentation.
+ description: 'The configuration of Registry trait (support removed
+ since version 2.5.0). Deprecated: use jvm trait or read documentation.'
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -11129,16 +10935,14 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to route.
- This can be used to set route specific annotations
- For annotations options see https://docs.openshift.com/container-platform/3.11/architecture/networking/routes.html#route-specific-annotations
- CLI usage example: -t "route.annotations.'haproxy.router.openshift.io/balance'=true"
+ description: 'The annotations added to route. This can be
+ used to set route specific annotations For annotations options
+ see https://docs.openshift.com/container-platform/3.11/architecture/networking/routes.html#route-specific-annotations
+ CLI usage example: -t "route.annotations.''haproxy.router.openshift.io/balance''=true"'
type: object
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -11149,82 +10953,74 @@ spec:
description: To configure the host exposed by the route.
type: string
tlsCACertificate:
- description: |-
- The TLS CA certificate contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS CA certificate contents. \n Refer to
+ the OpenShift route documentation for additional information."
type: string
tlsCACertificateSecret:
- description: |-
- The secret name and key reference to the TLS CA certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the TLS
+ CA certificate. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only one
+ key in the secret it will be read, otherwise you can set
+ a key name separated with a \"/\". \n Refer to the OpenShift
+ route documentation for additional information."
type: string
tlsCertificate:
- description: |-
- The TLS certificate contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS certificate contents. \n Refer to the
+ OpenShift route documentation for additional information."
type: string
tlsCertificateSecret:
- description: |-
- The secret name and key reference to the TLS certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the TLS
+ certificate. The format is \"secret-name[/key-name]\", the
+ value represents the secret name, if there is only one key
+ in the secret it will be read, otherwise you can set a key
+ name separated with a \"/\". \n Refer to the OpenShift route
+ documentation for additional information."
type: string
tlsDestinationCACertificate:
- description: |-
- The destination CA certificate provides the contents of the ca certificate of the final destination. When using reencrypt
- termination this file should be provided in order to have routers use it for health checks on the secure connection.
- If this field is not specified, the router may provide its own destination CA and perform hostname validation using
- the short service name (service.namespace.svc), which allows infrastructure generated certificates to automatically
- verify.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The destination CA certificate provides the
+ contents of the ca certificate of the final destination.
+ \ When using reencrypt termination this file should be provided
+ in order to have routers use it for health checks on the
+ secure connection. If this field is not specified, the router
+ may provide its own destination CA and perform hostname
+ validation using the short service name (service.namespace.svc),
+ which allows infrastructure generated certificates to automatically
+ verify. \n Refer to the OpenShift route documentation for
+ additional information."
type: string
tlsDestinationCACertificateSecret:
- description: |-
- The secret name and key reference to the destination CA certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the destination
+ CA certificate. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only one
+ key in the secret it will be read, otherwise you can set
+ a key name separated with a \"/\". \n Refer to the OpenShift
+ route documentation for additional information."
type: string
tlsInsecureEdgeTerminationPolicy:
- description: |-
- To configure how to deal with insecure traffic, e.g. `Allow`, `Disable` or `Redirect` traffic.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "To configure how to deal with insecure traffic,
+ e.g. `Allow`, `Disable` or `Redirect` traffic. \n Refer
+ to the OpenShift route documentation for additional information."
enum:
- None
- Allow
- Redirect
type: string
tlsKey:
- description: |-
- The TLS certificate key contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS certificate key contents. \n Refer to
+ the OpenShift route documentation for additional information."
type: string
tlsKeySecret:
- description: |-
- The secret name and key reference to the TLS certificate key. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the TLS
+ certificate key. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only one
+ key in the secret it will be read, otherwise you can set
+ a key name separated with a \"/\". \n Refer to the OpenShift
+ route documentation for additional information."
type: string
tlsTermination:
- description: |-
- The TLS termination type, like `edge`, `passthrough` or `reencrypt`.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS termination type, like `edge`, `passthrough`
+ or `reencrypt`. \n Refer to the OpenShift route documentation
+ for additional information."
enum:
- edge
- reencrypt
@@ -11235,9 +11031,8 @@ spec:
description: The configuration of Security Context trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -11269,9 +11064,8 @@ spec:
needs to be created.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -11279,9 +11073,8 @@ spec:
traits share this common property.
type: boolean
nodePort:
- description: |-
- Enable Service to be exposed as NodePort (default `false`).
- Deprecated: Use service type instead.
+ description: 'Enable Service to be exposed as NodePort (default
+ `false`). Deprecated: Use service type instead.'
type: boolean
type:
description: The type of service to be used, either 'ClusterIP',
@@ -11296,9 +11089,8 @@ spec:
description: The configuration of Service Binding trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -11325,9 +11117,8 @@ spec:
description: The configuration of Toleration trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -11357,12 +11148,19 @@ spec:
storage: true
subresources:
status: {}
+status:
+ acceptedNames:
+ kind: ""
+ plural: ""
+ conditions: []
+ storedVersions: []
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
- controller-gen.kubebuilder.io/version: v0.15.0
+ controller-gen.kubebuilder.io/version: v0.6.1
+ creationTimestamp: null
labels:
app: camel-k
name: integrations.camel.apache.org
@@ -11411,19 +11209,14 @@ spec:
description: Integration is the Schema for the integrations API.
properties:
apiVersion:
- description: |-
- APIVersion defines the versioned schema of this representation of an object.
- Servers should convert recognized schemas to the latest internal value, and
- may reject unrecognized values.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+ description: 'APIVersion defines the versioned schema of this representation
+ of an object. Servers should convert recognized schemas to the latest
+ internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: |-
- Kind is a string value representing the REST resource this object represents.
- Servers may infer this from the endpoint the client submits requests to.
- Cannot be updated.
- In CamelCase.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ description: 'Kind is a string value representing the REST resource this
+ object represents. Servers may infer this from the endpoint the client
+ submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
@@ -11431,12 +11224,10 @@ spec:
description: the desired Integration specification
properties:
configuration:
- description: |-
- Deprecated:
- Use camel trait (camel.properties) to manage properties
- Use mount trait (mount.configs) to manage configs
- Use mount trait (mount.resources) to manage resources
- Use mount trait (mount.volumes) to manage volumes
+ description: 'Deprecated: Use camel trait (camel.properties) to manage
+ properties Use mount trait (mount.configs) to manage configs Use
+ mount trait (mount.resources) to manage resources Use mount trait
+ (mount.volumes) to manage volumes'
items:
description: ConfigurationSpec represents a generic configuration
specification.
@@ -11477,43 +11268,35 @@ spec:
description: API version of the referent.
type: string
fieldPath:
- description: |-
- If referring to a piece of an object instead of an entire object, this string
- should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
- For example, if the object reference is to a container within a pod, this would take on a value like:
- "spec.containers{name}" (where "name" refers to the name of the container that triggered
- the event) or if no container name is specified "spec.containers[2]" (container with
- index 2 in this pod). This syntax is chosen only to have some well-defined way of
- referencing a part of an object.
- TODO: this design is not final and this field is subject to change in the future.
+ description: 'If referring to a piece of an object instead of
+ an entire object, this string should contain a valid JSON/Go
+ field access statement, such as desiredState.manifest.containers[2].
+ For example, if the object reference is to a container within
+ a pod, this would take on a value like: "spec.containers{name}"
+ (where "name" refers to the name of the container that triggered
+ the event) or if no container name is specified "spec.containers[2]"
+ (container with index 2 in this pod). This syntax is chosen
+ only to have some well-defined way of referencing a part of
+ an object. TODO: this design is not final and this field is
+ subject to change in the future.'
type: string
kind:
- description: |-
- Kind of the referent.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ 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: 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'
type: string
namespace:
- description: |-
- Namespace of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
+ description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type: string
resourceVersion:
- description: |-
- Specific resourceVersion to which this reference is made, if any.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
+ description: 'Specific resourceVersion to which this reference
+ is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
type: string
uid:
- description: |-
- UID of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
+ description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
type: string
type: object
- x-kubernetes-map-type: atomic
profile:
description: the profile needed to run this Integration
type: string
@@ -11554,8 +11337,7 @@ spec:
description: True if the spec is generated from a Kamelet
type: boolean
interceptors:
- description: |-
- Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
+ description: Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
uses to pre/post process sources
items:
type: string
@@ -11565,9 +11347,8 @@ spec:
to interpret this source code
type: string
loader:
- description: |-
- Loader is an optional id of the org.apache.camel.k.RoutesLoader that will
- interpret this source at runtime
+ description: Loader is an optional id of the org.apache.camel.k.RoutesLoader
+ that will interpret this source at runtime
type: string
name:
description: the name of the specification
@@ -11611,35 +11392,38 @@ spec:
to run within a pod.
properties:
args:
- description: |-
- Arguments to the entrypoint.
- The container image's CMD is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Arguments to the entrypoint. The container
+ image''s CMD is used if this is not provided. Variable
+ references $(VAR_NAME) are expanded using the container''s
+ environment. If a variable cannot be resolved, the
+ reference in the input string will be unchanged. Double
+ $$ are reduced to a single $, which allows for escaping
+ the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce
+ the string literal "$(VAR_NAME)". Escaped references
+ will never be expanded, regardless of whether the
+ variable exists or not. Cannot be updated. More info:
+ https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
command:
- description: |-
- Entrypoint array. Not executed within a shell.
- The container image's ENTRYPOINT is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Entrypoint array. Not executed within
+ a shell. The container image''s ENTRYPOINT is used
+ if this is not provided. Variable references $(VAR_NAME)
+ are expanded using the container''s environment. If
+ a variable cannot be resolved, the reference in the
+ input string will be unchanged. Double $$ are reduced
+ to a single $, which allows for escaping the $(VAR_NAME)
+ syntax: i.e. "$$(VAR_NAME)" will produce the string
+ literal "$(VAR_NAME)". Escaped references will never
+ be expanded, regardless of whether the variable exists
+ or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
env:
- description: |-
- List of environment variables to set in the container.
- Cannot be updated.
+ description: List of environment variables to set in
+ the container. Cannot be updated.
items:
description: EnvVar represents an environment variable
present in a Container.
@@ -11649,16 +11433,17 @@ spec:
Must be a C_IDENTIFIER.
type: string
value:
- description: |-
- Variable references $(VAR_NAME) are expanded
- using the previously defined environment variables in the container and
- any service environment variables. If a variable cannot be resolved,
- the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
- "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
- Escaped references will never be expanded, regardless of whether the variable
- exists or not.
- Defaults to "".
+ description: 'Variable references $(VAR_NAME)
+ are expanded using the previously defined environment
+ variables in the container and any service environment
+ variables. If a variable cannot be resolved,
+ the reference in the input string will be unchanged.
+ Double $$ are reduced to a single $, which allows
+ for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)"
+ will produce the string literal "$(VAR_NAME)".
+ Escaped references will never be expanded, regardless
+ of whether the variable exists or not. Defaults
+ to "".'
type: string
valueFrom:
description: Source for the environment variable's
@@ -11671,10 +11456,10 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
@@ -11683,11 +11468,12 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
fieldRef:
- description: |-
- Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`,
- spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ description: 'Selects a field of the pod:
+ supports metadata.name, metadata.namespace,
+ `metadata.labels['''']`, `metadata.annotations['''']`,
+ spec.nodeName, spec.serviceAccountName,
+ status.hostIP, status.podIP, status.podIPs.'
properties:
apiVersion:
description: Version of the schema the
@@ -11701,11 +11487,12 @@ spec:
required:
- fieldPath
type: object
- x-kubernetes-map-type: atomic
resourceFieldRef:
- description: |-
- Selects a resource of the container: only resources limits and requests
- (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
+ description: 'Selects a resource of the container:
+ only resources limits and requests (limits.cpu,
+ limits.memory, limits.ephemeral-storage,
+ requests.cpu, requests.memory and requests.ephemeral-storage)
+ are currently supported.'
properties:
containerName:
description: 'Container name: required
@@ -11726,7 +11513,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret in
the pod's namespace
@@ -11737,10 +11523,10 @@ spec:
key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret
@@ -11749,20 +11535,20 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
required:
- name
type: object
type: array
envFrom:
- description: |-
- List of sources to populate environment variables in the container.
- The keys defined within a source must be a C_IDENTIFIER. All invalid keys
- will be reported as an event when the container is starting. When a key exists in multiple
- sources, the value associated with the last source will take precedence.
- Values defined by an Env with a duplicate key will take precedence.
- Cannot be updated.
+ description: List of sources to populate environment
+ variables in the container. The keys defined within
+ a source must be a C_IDENTIFIER. All invalid keys
+ will be reported as an event when the container is
+ starting. When a key exists in multiple sources, the
+ value associated with the last source will take precedence.
+ Values defined by an Env with a duplicate key will
+ take precedence. Cannot be updated.
items:
description: EnvFromSource represents the source of
a set of ConfigMaps
@@ -11771,17 +11557,16 @@ spec:
description: The ConfigMap to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
prefix:
description: An optional identifier to prepend
to each key in the ConfigMap. Must be a C_IDENTIFIER.
@@ -11790,56 +11575,57 @@ spec:
description: The Secret to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret must
be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
image:
- description: |-
- Container image name.
- More info: https://kubernetes.io/docs/concepts/containers/images
- This field is optional to allow higher level config management to default or override
- container images in workload controllers like Deployments and StatefulSets.
+ description: 'Container image name. More info: https://kubernetes.io/docs/concepts/containers/images
+ This field is optional to allow higher level config
+ management to default or override container images
+ in workload controllers like Deployments and StatefulSets.'
type: string
imagePullPolicy:
- description: |-
- Image pull policy.
- One of Always, Never, IfNotPresent.
- Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
+ description: 'Image pull policy. One of Always, Never,
+ IfNotPresent. Defaults to Always if :latest tag is
+ specified, or IfNotPresent otherwise. Cannot be updated.
+ More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
- description: |-
- Actions that the management system should take in response to container lifecycle events.
- Cannot be updated.
+ description: Actions that the management system should
+ take in response to container lifecycle events. Cannot
+ be updated.
properties:
postStart:
- description: |-
- PostStart is called immediately after a container is created. If the handler fails,
- the container is terminated and restarted according to its restart policy.
- Other management of the container blocks until the hook completes.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PostStart is called immediately after
+ a container is created. If the handler fails,
+ the container is terminated and restarted according
+ to its restart policy. Other management of the
+ container blocks until the hook completes. More
+ info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
@@ -11849,8 +11635,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -11861,9 +11647,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -11881,15 +11668,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -11907,10 +11693,11 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT supported
+ as a LifecycleHandler and kept for the backward
+ compatibility. There are no validation of
+ this field and lifecycle hooks will fail in
+ runtime when tcp handler is specified.
properties:
host:
description: 'Optional: Host name to connect
@@ -11920,37 +11707,44 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
preStop:
- description: |-
- PreStop is called immediately before a container is terminated due to an
- API request or management event such as liveness/startup probe failure,
- preemption, resource contention, etc. The handler is not called if the
- container crashes or exits. The Pod's termination grace period countdown begins before the
- PreStop hook is executed. Regardless of the outcome of the handler, the
- container will eventually terminate within the Pod's termination grace
- period (unless delayed by finalizers). Other management of the container blocks until the hook completes
- or until the termination grace period is reached.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PreStop is called immediately before
+ a container is terminated due to an API request
+ or management event such as liveness/startup probe
+ failure, preemption, resource contention, etc.
+ The handler is not called if the container crashes
+ or exits. The Pod''s termination grace period
+ countdown begins before the PreStop hook is executed.
+ Regardless of the outcome of the handler, the
+ container will eventually terminate within the
+ Pod''s termination grace period (unless delayed
+ by finalizers). Other management of the container
+ blocks until the hook completes or until the termination
+ grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
@@ -11960,8 +11754,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -11972,9 +11766,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -11992,15 +11787,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -12018,10 +11812,11 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT supported
+ as a LifecycleHandler and kept for the backward
+ compatibility. There are no validation of
+ this field and lifecycle hooks will fail in
+ runtime when tcp handler is specified.
properties:
host:
description: 'Optional: Host name to connect
@@ -12031,10 +11826,10 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
@@ -12042,29 +11837,30 @@ spec:
type: object
type: object
livenessProbe:
- description: |-
- Periodic probe of container liveness.
- Container will be restarted if the probe fails.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Periodic probe of container liveness.
+ Container will be restarted if the probe fails. Cannot
+ be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to
+ execute inside the container, the working
+ directory for the command is root ('/') in
+ the container's filesystem. The command is
+ simply exec'd, it is not run inside a shell,
+ so traditional shell instructions ('|', etc)
+ won't work. To use a shell, you need to explicitly
+ call out to that shell. Exit status of 0 is
+ treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
format: int32
type: integer
@@ -12078,12 +11874,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
- (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ description: "Service is the name of the service
+ to place in the gRPC HealthCheckRequest (see
+ https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
+ \n If this is not specified, the default behavior
+ is defined by gRPC."
type: string
required:
- port
@@ -12093,9 +11888,9 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
description: Custom headers to set in the request.
@@ -12105,9 +11900,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name. This
+ will be canonicalized upon output, so
+ case-variant names will be understood
+ as the same header.
type: string
value:
description: The header field value
@@ -12124,35 +11920,34 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for the
+ probe to be considered successful after having
+ failed. Defaults to 1. Must be 1 for liveness
+ and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -12167,59 +11962,61 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod
+ needs to terminate gracefully upon probe failure.
+ The grace period is the duration in seconds after
+ the processes running in the pod are sent a termination
+ signal and the time when the processes are forcibly
+ halted with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value must
+ be non-negative integer. The value zero indicates
+ stop immediately via the kill signal (no opportunity
+ to shut down). This is a beta field and requires
+ enabling ProbeTerminationGracePeriod feature gate.
+ Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which the
+ probe times out. Defaults to 1 second. Minimum
+ value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
name:
- description: |-
- Name of the container specified as a DNS_LABEL.
+ description: Name of the container specified as a DNS_LABEL.
Each container in a pod must have a unique name (DNS_LABEL).
Cannot be updated.
type: string
ports:
- description: |-
- List of ports to expose from the container. Not specifying a port here
- DOES NOT prevent that port from being exposed. Any port which is
- listening on the default "0.0.0.0" address inside a container will be
- accessible from the network.
- Modifying this array with strategic merge patch may corrupt the data.
- For more information See https://github.com/kubernetes/kubernetes/issues/108255.
+ description: List of ports to expose from the container.
+ Not specifying a port here DOES NOT prevent that port
+ from being exposed. Any port which is listening on
+ the default "0.0.0.0" address inside a container will
+ be accessible from the network. Modifying this array
+ with strategic merge patch may corrupt the data. For
+ more information See https://github.com/kubernetes/kubernetes/issues/108255.
Cannot be updated.
items:
description: ContainerPort represents a network port
in a single container.
properties:
containerPort:
- description: |-
- Number of port to expose on the pod's IP address.
- This must be a valid port number, 0 < x < 65536.
+ description: Number of port to expose on the pod's
+ IP address. This must be a valid port number,
+ 0 < x < 65536.
format: int32
type: integer
hostIP:
@@ -12227,24 +12024,23 @@ spec:
port to.
type: string
hostPort:
- description: |-
- Number of port to expose on the host.
- If specified, this must be a valid port number, 0 < x < 65536.
- If HostNetwork is specified, this must match ContainerPort.
- Most containers do not need this.
+ description: Number of port to expose on the host.
+ If specified, this must be a valid port number,
+ 0 < x < 65536. If HostNetwork is specified,
+ this must match ContainerPort. Most containers
+ do not need this.
format: int32
type: integer
name:
- description: |-
- If specified, this must be an IANA_SVC_NAME and unique within the pod. Each
- named port in a pod must have a unique name. Name for the port that can be
- referred to by services.
+ description: If specified, this must be an IANA_SVC_NAME
+ and unique within the pod. Each named port in
+ a pod must have a unique name. Name for the
+ port that can be referred to by services.
type: string
protocol:
default: TCP
- description: |-
- Protocol for port. Must be UDP, TCP, or SCTP.
- Defaults to "TCP".
+ description: Protocol for port. Must be UDP, TCP,
+ or SCTP. Defaults to "TCP".
type: string
required:
- containerPort
@@ -12255,29 +12051,30 @@ spec:
- protocol
x-kubernetes-list-type: map
readinessProbe:
- description: |-
- Periodic probe of container service readiness.
- Container will be removed from service endpoints if the probe fails.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Periodic probe of container service readiness.
+ Container will be removed from service endpoints if
+ the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to
+ execute inside the container, the working
+ directory for the command is root ('/') in
+ the container's filesystem. The command is
+ simply exec'd, it is not run inside a shell,
+ so traditional shell instructions ('|', etc)
+ won't work. To use a shell, you need to explicitly
+ call out to that shell. Exit status of 0 is
+ treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
format: int32
type: integer
@@ -12291,12 +12088,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
- (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ description: "Service is the name of the service
+ to place in the gRPC HealthCheckRequest (see
+ https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
+ \n If this is not specified, the default behavior
+ is defined by gRPC."
type: string
required:
- port
@@ -12306,9 +12102,9 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
description: Custom headers to set in the request.
@@ -12318,9 +12114,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name. This
+ will be canonicalized upon output, so
+ case-variant names will be understood
+ as the same header.
type: string
value:
description: The header field value
@@ -12337,35 +12134,34 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for the
+ probe to be considered successful after having
+ failed. Defaults to 1. Must be 1 for liveness
+ and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -12380,33 +12176,36 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod
+ needs to terminate gracefully upon probe failure.
+ The grace period is the duration in seconds after
+ the processes running in the pod are sent a termination
+ signal and the time when the processes are forcibly
+ halted with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value must
+ be non-negative integer. The value zero indicates
+ stop immediately via the kill signal (no opportunity
+ to shut down). This is a beta field and requires
+ enabling ProbeTerminationGracePeriod feature gate.
+ Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which the
+ probe times out. Defaults to 1 second. Minimum
+ value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
@@ -12417,14 +12216,14 @@ spec:
resize policy for the container.
properties:
resourceName:
- description: |-
- Name of the resource to which this resource resize policy applies.
- Supported values: cpu, memory.
+ description: 'Name of the resource to which this
+ resource resize policy applies. Supported values:
+ cpu, memory.'
type: string
restartPolicy:
- description: |-
- Restart policy to apply when specified resource is resized.
- If not specified, it defaults to NotRequired.
+ description: Restart policy to apply when specified
+ resource is resized. If not specified, it defaults
+ to NotRequired.
type: string
required:
- resourceName
@@ -12433,31 +12232,25 @@ spec:
type: array
x-kubernetes-list-type: atomic
resources:
- description: |-
- Compute Resources required by this container.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Compute Resources required by this container.
+ Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
properties:
claims:
- description: |-
- Claims lists the names of resources, defined in spec.resourceClaims,
- that are used by this container.
-
-
- This is an alpha field and requires enabling the
- DynamicResourceAllocation feature gate.
-
-
- This field is immutable. It can only be set for containers.
+ description: "Claims lists the names of resources,
+ defined in spec.resourceClaims, that are used
+ by this container. \n This is an alpha field and
+ requires enabling the DynamicResourceAllocation
+ feature gate. \n This field is immutable. It can
+ only be set for containers."
items:
description: ResourceClaim references one entry
in PodSpec.ResourceClaims.
properties:
name:
- description: |-
- Name must match the name of one entry in pod.spec.resourceClaims of
- the Pod where this field is used. It makes that resource available
- inside a container.
+ description: Name must match the name of one
+ entry in pod.spec.resourceClaims of the
+ Pod where this field is used. It makes that
+ resource available inside a container.
type: string
required:
- name
@@ -12473,9 +12266,8 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Limits describes the maximum amount of compute resources allowed.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Limits describes the maximum amount
+ of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -12484,52 +12276,57 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Requests describes the minimum amount of compute resources required.
- If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
- otherwise to an implementation-defined value. Requests cannot exceed Limits.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Requests describes the minimum amount
+ of compute resources required. If Requests is
+ omitted for a container, it defaults to Limits
+ if that is explicitly specified, otherwise to
+ an implementation-defined value. Requests cannot
+ exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
restartPolicy:
- description: |-
- RestartPolicy defines the restart behavior of individual containers in a pod.
- This field may only be set for init containers, and the only allowed value is "Always".
- For non-init containers or when this field is not specified,
- the restart behavior is defined by the Pod's restart policy and the container type.
- Setting the RestartPolicy as "Always" for the init container will have the following effect:
- this init container will be continually restarted on
- exit until all regular containers have terminated. Once all regular
- containers have completed, all init containers with restartPolicy "Always"
- will be shut down. This lifecycle differs from normal init containers and
- is often referred to as a "sidecar" container. Although this init
- container still starts in the init container sequence, it does not wait
- for the container to complete before proceeding to the next init
- container. Instead, the next init container starts immediately after this
- init container is started, or after any startupProbe has successfully
- completed.
+ description: 'RestartPolicy defines the restart behavior
+ of individual containers in a pod. This field may
+ only be set for init containers, and the only allowed
+ value is "Always". For non-init containers or when
+ this field is not specified, the restart behavior
+ is defined by the Pod''s restart policy and the container
+ type. Setting the RestartPolicy as "Always" for the
+ init container will have the following effect: this
+ init container will be continually restarted on exit
+ until all regular containers have terminated. Once
+ all regular containers have completed, all init containers
+ with restartPolicy "Always" will be shut down. This
+ lifecycle differs from normal init containers and
+ is often referred to as a "sidecar" container. Although
+ this init container still starts in the init container
+ sequence, it does not wait for the container to complete
+ before proceeding to the next init container. Instead,
+ the next init container starts immediately after this
+ init container is started, or after any startupProbe
+ has successfully completed.'
type: string
securityContext:
- description: |-
- SecurityContext defines the security options the container should be run with.
- If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
- More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
+ description: 'SecurityContext defines the security options
+ the container should be run with. If set, the fields
+ of SecurityContext override the equivalent fields
+ of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
properties:
allowPrivilegeEscalation:
- description: |-
- AllowPrivilegeEscalation controls whether a process can gain more
- privileges than its parent process. This bool directly controls if
- the no_new_privs flag will be set on the container process.
- AllowPrivilegeEscalation is true always when the container is:
- 1) run as Privileged
- 2) has CAP_SYS_ADMIN
- Note that this field cannot be set when spec.os.name is windows.
+ description: 'AllowPrivilegeEscalation controls
+ whether a process can gain more privileges than
+ its parent process. This bool directly controls
+ if the no_new_privs flag will be set on the container
+ process. AllowPrivilegeEscalation is true always
+ when the container is: 1) run as Privileged 2)
+ has CAP_SYS_ADMIN Note that this field cannot
+ be set when spec.os.name is windows.'
type: boolean
capabilities:
- description: |-
- The capabilities to add/drop when running containers.
- Defaults to the default set of capabilities granted by the container runtime.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The capabilities to add/drop when running
+ containers. Defaults to the default set of capabilities
+ granted by the container runtime. Note that this
+ field cannot be set when spec.os.name is windows.
properties:
add:
description: Added capabilities
@@ -12547,60 +12344,66 @@ spec:
type: array
type: object
privileged:
- description: |-
- Run container in privileged mode.
- Processes in privileged containers are essentially equivalent to root on the host.
- Defaults to false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Run container in privileged mode. Processes
+ in privileged containers are essentially equivalent
+ to root on the host. Defaults to false. Note that
+ this field cannot be set when spec.os.name is
+ windows.
type: boolean
procMount:
- description: |-
- procMount denotes the type of proc mount to use for the containers.
- The default is DefaultProcMount which uses the container runtime defaults for
- readonly paths and masked paths.
- This requires the ProcMountType feature flag to be enabled.
- Note that this field cannot be set when spec.os.name is windows.
+ description: procMount denotes the type of proc
+ mount to use for the containers. The default is
+ DefaultProcMount which uses the container runtime
+ defaults for readonly paths and masked paths.
+ This requires the ProcMountType feature flag to
+ be enabled. Note that this field cannot be set
+ when spec.os.name is windows.
type: string
readOnlyRootFilesystem:
- description: |-
- Whether this container has a read-only root filesystem.
- Default is false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Whether this container has a read-only
+ root filesystem. Default is false. Note that this
+ field cannot be set when spec.os.name is windows.
type: boolean
runAsGroup:
- description: |-
- The GID to run the entrypoint of the container process.
- Uses runtime default if unset.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The GID to run the entrypoint of the
+ container process. Uses runtime default if unset.
+ May also be set in PodSecurityContext. If set
+ in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence.
+ Note that this field cannot be set when spec.os.name
+ is windows.
format: int64
type: integer
runAsNonRoot:
- description: |-
- Indicates that the container must run as a non-root user.
- If true, the Kubelet will validate the image at runtime to ensure that it
- does not run as UID 0 (root) and fail to start the container if it does.
- If unset or false, no such validation will be performed.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: Indicates that the container must run
+ as a non-root user. If true, the Kubelet will
+ validate the image at runtime to ensure that it
+ does not run as UID 0 (root) and fail to start
+ the container if it does. If unset or false, no
+ such validation will be performed. May also be
+ set in PodSecurityContext. If set in both SecurityContext
+ and PodSecurityContext, the value specified in
+ SecurityContext takes precedence.
type: boolean
runAsUser:
- description: |-
- The UID to run the entrypoint of the container process.
- Defaults to user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The UID to run the entrypoint of the
+ container process. Defaults to user specified
+ in image metadata if unspecified. May also be
+ set in PodSecurityContext. If set in both SecurityContext
+ and PodSecurityContext, the value specified in
+ SecurityContext takes precedence. Note that this
+ field cannot be set when spec.os.name is windows.
format: int64
type: integer
seLinuxOptions:
- description: |-
- The SELinux context to be applied to the container.
- If unspecified, the container runtime will allocate a random SELinux context for each
- container. May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The SELinux context to be applied to
+ the container. If unspecified, the container runtime
+ will allocate a random SELinux context for each
+ container. May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence.
+ Note that this field cannot be set when spec.os.name
+ is windows.
properties:
level:
description: Level is SELinux level label that
@@ -12620,92 +12423,104 @@ spec:
type: string
type: object
seccompProfile:
- description: |-
- The seccomp options to use by this container. If seccomp options are
- provided at both the pod & container level, the container options
- override the pod options.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The seccomp options to use by this
+ container. If seccomp options are provided at
+ both the pod & container level, the container
+ options override the pod options. Note that this
+ field cannot be set when spec.os.name is windows.
properties:
localhostProfile:
- description: |-
- localhostProfile indicates a profile defined in a file on the node should be used.
- The profile must be preconfigured on the node to work.
- Must be a descending path, relative to the kubelet's configured seccomp profile location.
- Must be set if type is "Localhost". Must NOT be set for any other type.
+ description: localhostProfile indicates a profile
+ defined in a file on the node should be used.
+ The profile must be preconfigured on the node
+ to work. Must be a descending path, relative
+ to the kubelet's configured seccomp profile
+ location. Must be set if type is "Localhost".
+ Must NOT be set for any other type.
type: string
type:
- description: |-
- type indicates which kind of seccomp profile will be applied.
- Valid options are:
-
-
- Localhost - a profile defined in a file on the node should be used.
- RuntimeDefault - the container runtime default profile should be used.
- Unconfined - no profile should be applied.
+ description: "type indicates which kind of seccomp
+ profile will be applied. Valid options are:
+ \n Localhost - a profile defined in a file
+ on the node should be used. RuntimeDefault
+ - the container runtime default profile should
+ be used. Unconfined - no profile should be
+ applied."
type: string
required:
- type
type: object
windowsOptions:
- description: |-
- The Windows specific settings applied to all containers.
- If unspecified, the options from the PodSecurityContext will be used.
- If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is linux.
+ description: The Windows specific settings applied
+ to all containers. If unspecified, the options
+ from the PodSecurityContext will be used. If set
+ in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence.
+ Note that this field cannot be set when spec.os.name
+ is linux.
properties:
gmsaCredentialSpec:
- description: |-
- GMSACredentialSpec is where the GMSA admission webhook
- (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
- GMSA credential spec named by the GMSACredentialSpecName field.
+ description: GMSACredentialSpec is where the
+ GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa)
+ inlines the contents of the GMSA credential
+ spec named by the GMSACredentialSpecName field.
type: string
gmsaCredentialSpecName:
description: GMSACredentialSpecName is the name
of the GMSA credential spec to use.
type: string
hostProcess:
- description: |-
- HostProcess determines if a container should be run as a 'Host Process' container.
- All of a Pod's containers must have the same effective HostProcess value
- (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
- In addition, if HostProcess is true then HostNetwork must also be set to true.
+ description: HostProcess determines if a container
+ should be run as a 'Host Process' container.
+ All of a Pod's containers must have the same
+ effective HostProcess value (it is not allowed
+ to have a mix of HostProcess containers and
+ non-HostProcess containers). In addition,
+ if HostProcess is true then HostNetwork must
+ also be set to true.
type: boolean
runAsUserName:
- description: |-
- The UserName in Windows to run the entrypoint of the container process.
- Defaults to the user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: The UserName in Windows to run
+ the entrypoint of the container process. Defaults
+ to the user specified in image metadata if
+ unspecified. May also be set in PodSecurityContext.
+ If set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence.
type: string
type: object
type: object
startupProbe:
- description: |-
- StartupProbe indicates that the Pod has successfully initialized.
- If specified, no other probes are executed until this completes successfully.
- If this probe fails, the Pod will be restarted, just as if the livenessProbe failed.
- This can be used to provide different probe parameters at the beginning of a Pod's lifecycle,
- when it might take a long time to load data or warm a cache, than during steady-state operation.
- This cannot be updated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'StartupProbe indicates that the Pod has
+ successfully initialized. If specified, no other probes
+ are executed until this completes successfully. If
+ this probe fails, the Pod will be restarted, just
+ as if the livenessProbe failed. This can be used to
+ provide different probe parameters at the beginning
+ of a Pod''s lifecycle, when it might take a long time
+ to load data or warm a cache, than during steady-state
+ operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to
+ execute inside the container, the working
+ directory for the command is root ('/') in
+ the container's filesystem. The command is
+ simply exec'd, it is not run inside a shell,
+ so traditional shell instructions ('|', etc)
+ won't work. To use a shell, you need to explicitly
+ call out to that shell. Exit status of 0 is
+ treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
format: int32
type: integer
@@ -12719,12 +12534,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
- (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ description: "Service is the name of the service
+ to place in the gRPC HealthCheckRequest (see
+ https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
+ \n If this is not specified, the default behavior
+ is defined by gRPC."
type: string
required:
- port
@@ -12734,9 +12548,9 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
description: Custom headers to set in the request.
@@ -12746,9 +12560,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name. This
+ will be canonicalized upon output, so
+ case-variant names will be understood
+ as the same header.
type: string
value:
description: The header field value
@@ -12765,35 +12580,34 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for the
+ probe to be considered successful after having
+ failed. Defaults to 1. Must be 1 for liveness
+ and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -12808,75 +12622,83 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod
+ needs to terminate gracefully upon probe failure.
+ The grace period is the duration in seconds after
+ the processes running in the pod are sent a termination
+ signal and the time when the processes are forcibly
+ halted with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value must
+ be non-negative integer. The value zero indicates
+ stop immediately via the kill signal (no opportunity
+ to shut down). This is a beta field and requires
+ enabling ProbeTerminationGracePeriod feature gate.
+ Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which the
+ probe times out. Defaults to 1 second. Minimum
+ value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
stdin:
- description: |-
- Whether this container should allocate a buffer for stdin in the container runtime. If this
- is not set, reads from stdin in the container will always result in EOF.
- Default is false.
+ description: Whether this container should allocate
+ a buffer for stdin in the container runtime. If this
+ is not set, reads from stdin in the container will
+ always result in EOF. Default is false.
type: boolean
stdinOnce:
- description: |-
- Whether the container runtime should close the stdin channel after it has been opened by
- a single attach. When stdin is true the stdin stream will remain open across multiple attach
- sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
- first client attaches to stdin, and then remains open and accepts data until the client disconnects,
- at which time stdin is closed and remains closed until the container is restarted. If this
- flag is false, a container processes that reads from stdin will never receive an EOF.
- Default is false
+ description: Whether the container runtime should close
+ the stdin channel after it has been opened by a single
+ attach. When stdin is true the stdin stream will remain
+ open across multiple attach sessions. If stdinOnce
+ is set to true, stdin is opened on container start,
+ is empty until the first client attaches to stdin,
+ and then remains open and accepts data until the client
+ disconnects, at which time stdin is closed and remains
+ closed until the container is restarted. If this flag
+ is false, a container processes that reads from stdin
+ will never receive an EOF. Default is false
type: boolean
terminationMessagePath:
- description: |-
- Optional: Path at which the file to which the container's termination message
- will be written is mounted into the container's filesystem.
- Message written is intended to be brief final status, such as an assertion failure message.
- Will be truncated by the node if greater than 4096 bytes. The total message length across
- all containers will be limited to 12kb.
- Defaults to /dev/termination-log.
- Cannot be updated.
+ description: 'Optional: Path at which the file to which
+ the container''s termination message will be written
+ is mounted into the container''s filesystem. Message
+ written is intended to be brief final status, such
+ as an assertion failure message. Will be truncated
+ by the node if greater than 4096 bytes. The total
+ message length across all containers will be limited
+ to 12kb. Defaults to /dev/termination-log. Cannot
+ be updated.'
type: string
terminationMessagePolicy:
- description: |-
- Indicate how the termination message should be populated. File will use the contents of
- terminationMessagePath to populate the container status message on both success and failure.
- FallbackToLogsOnError will use the last chunk of container log output if the termination
- message file is empty and the container exited with an error.
- The log output is limited to 2048 bytes or 80 lines, whichever is smaller.
- Defaults to File.
- Cannot be updated.
+ description: Indicate how the termination message should
+ be populated. File will use the contents of terminationMessagePath
+ to populate the container status message on both success
+ and failure. FallbackToLogsOnError will use the last
+ chunk of container log output if the termination message
+ file is empty and the container exited with an error.
+ The log output is limited to 2048 bytes or 80 lines,
+ whichever is smaller. Defaults to File. Cannot be
+ updated.
type: string
tty:
- description: |-
- Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
+ description: Whether this container should allocate
+ a TTY for itself, also requires 'stdin' to be true.
Default is false.
type: boolean
volumeDevices:
@@ -12901,44 +12723,44 @@ spec:
type: object
type: array
volumeMounts:
- description: |-
- Pod volumes to mount into the container's filesystem.
- Cannot be updated.
+ description: Pod volumes to mount into the container's
+ filesystem. Cannot be updated.
items:
description: VolumeMount describes a mounting of a
Volume within a container.
properties:
mountPath:
- description: |-
- Path within the container at which the volume should be mounted. Must
- not contain ':'.
+ description: Path within the container at which
+ the volume should be mounted. Must not contain
+ ':'.
type: string
mountPropagation:
- description: |-
- mountPropagation determines how mounts are propagated from the host
- to container and the other way around.
- When not set, MountPropagationNone is used.
- This field is beta in 1.10.
+ description: mountPropagation determines how mounts
+ are propagated from the host to container and
+ the other way around. When not set, MountPropagationNone
+ is used. This field is beta in 1.10.
type: string
name:
description: This must match the Name of a Volume.
type: string
readOnly:
- description: |-
- Mounted read-only if true, read-write otherwise (false or unspecified).
- Defaults to false.
+ description: Mounted read-only if true, read-write
+ otherwise (false or unspecified). Defaults to
+ false.
type: boolean
subPath:
- description: |-
- Path within the volume from which the container's volume should be mounted.
- Defaults to "" (volume's root).
+ description: Path within the volume from which
+ the container's volume should be mounted. Defaults
+ to "" (volume's root).
type: string
subPathExpr:
- description: |-
- Expanded path within the volume from which the container's volume should be mounted.
- Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.
- Defaults to "" (volume's root).
- SubPathExpr and SubPath are mutually exclusive.
+ description: Expanded path within the volume from
+ which the container's volume should be mounted.
+ Behaves similarly to SubPath but environment
+ variable references $(VAR_NAME) are expanded
+ using the container's environment. Defaults
+ to "" (volume's root). SubPathExpr and SubPath
+ are mutually exclusive.
type: string
required:
- mountPath
@@ -12946,11 +12768,10 @@ spec:
type: object
type: array
workingDir:
- description: |-
- Container's working directory.
- If not specified, the container runtime's default will be used, which
- might be configured in the container image.
- Cannot be updated.
+ description: Container's working directory. If not specified,
+ the container runtime's default will be used, which
+ might be configured in the container image. Cannot
+ be updated.
type: string
required:
- name
@@ -12962,47 +12783,50 @@ spec:
ephemeralContainers:
description: EphemeralContainers
items:
- description: |-
- An EphemeralContainer is a temporary container that you may add to an existing Pod for
- user-initiated activities such as debugging. Ephemeral containers have no resource or
- scheduling guarantees, and they will not be restarted when they exit or when a Pod is
- removed or restarted. The kubelet may evict a Pod if an ephemeral container causes the
- Pod to exceed its resource allocation.
-
-
- To add an ephemeral container, use the ephemeralcontainers subresource of an existing
- Pod. Ephemeral containers may not be removed or restarted.
+ description: "An EphemeralContainer is a temporary container
+ that you may add to an existing Pod for user-initiated
+ activities such as debugging. Ephemeral containers have
+ no resource or scheduling guarantees, and they will not
+ be restarted when they exit or when a Pod is removed or
+ restarted. The kubelet may evict a Pod if an ephemeral
+ container causes the Pod to exceed its resource allocation.
+ \n To add an ephemeral container, use the ephemeralcontainers
+ subresource of an existing Pod. Ephemeral containers may
+ not be removed or restarted."
properties:
args:
- description: |-
- Arguments to the entrypoint.
- The image's CMD is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Arguments to the entrypoint. The image''s
+ CMD is used if this is not provided. Variable references
+ $(VAR_NAME) are expanded using the container''s environment.
+ If a variable cannot be resolved, the reference in
+ the input string will be unchanged. Double $$ are
+ reduced to a single $, which allows for escaping the
+ $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce
+ the string literal "$(VAR_NAME)". Escaped references
+ will never be expanded, regardless of whether the
+ variable exists or not. Cannot be updated. More info:
+ https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
command:
- description: |-
- Entrypoint array. Not executed within a shell.
- The image's ENTRYPOINT is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Entrypoint array. Not executed within
+ a shell. The image''s ENTRYPOINT is used if this is
+ not provided. Variable references $(VAR_NAME) are
+ expanded using the container''s environment. If a
+ variable cannot be resolved, the reference in the
+ input string will be unchanged. Double $$ are reduced
+ to a single $, which allows for escaping the $(VAR_NAME)
+ syntax: i.e. "$$(VAR_NAME)" will produce the string
+ literal "$(VAR_NAME)". Escaped references will never
+ be expanded, regardless of whether the variable exists
+ or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
env:
- description: |-
- List of environment variables to set in the container.
- Cannot be updated.
+ description: List of environment variables to set in
+ the container. Cannot be updated.
items:
description: EnvVar represents an environment variable
present in a Container.
@@ -13012,16 +12836,17 @@ spec:
Must be a C_IDENTIFIER.
type: string
value:
- description: |-
- Variable references $(VAR_NAME) are expanded
- using the previously defined environment variables in the container and
- any service environment variables. If a variable cannot be resolved,
- the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
- "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
- Escaped references will never be expanded, regardless of whether the variable
- exists or not.
- Defaults to "".
+ description: 'Variable references $(VAR_NAME)
+ are expanded using the previously defined environment
+ variables in the container and any service environment
+ variables. If a variable cannot be resolved,
+ the reference in the input string will be unchanged.
+ Double $$ are reduced to a single $, which allows
+ for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)"
+ will produce the string literal "$(VAR_NAME)".
+ Escaped references will never be expanded, regardless
+ of whether the variable exists or not. Defaults
+ to "".'
type: string
valueFrom:
description: Source for the environment variable's
@@ -13034,10 +12859,10 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
@@ -13046,11 +12871,12 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
fieldRef:
- description: |-
- Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`,
- spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ description: 'Selects a field of the pod:
+ supports metadata.name, metadata.namespace,
+ `metadata.labels['''']`, `metadata.annotations['''']`,
+ spec.nodeName, spec.serviceAccountName,
+ status.hostIP, status.podIP, status.podIPs.'
properties:
apiVersion:
description: Version of the schema the
@@ -13064,11 +12890,12 @@ spec:
required:
- fieldPath
type: object
- x-kubernetes-map-type: atomic
resourceFieldRef:
- description: |-
- Selects a resource of the container: only resources limits and requests
- (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
+ description: 'Selects a resource of the container:
+ only resources limits and requests (limits.cpu,
+ limits.memory, limits.ephemeral-storage,
+ requests.cpu, requests.memory and requests.ephemeral-storage)
+ are currently supported.'
properties:
containerName:
description: 'Container name: required
@@ -13089,7 +12916,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret in
the pod's namespace
@@ -13100,10 +12926,10 @@ spec:
key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret
@@ -13112,20 +12938,20 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
required:
- name
type: object
type: array
envFrom:
- description: |-
- List of sources to populate environment variables in the container.
- The keys defined within a source must be a C_IDENTIFIER. All invalid keys
- will be reported as an event when the container is starting. When a key exists in multiple
- sources, the value associated with the last source will take precedence.
- Values defined by an Env with a duplicate key will take precedence.
- Cannot be updated.
+ description: List of sources to populate environment
+ variables in the container. The keys defined within
+ a source must be a C_IDENTIFIER. All invalid keys
+ will be reported as an event when the container is
+ starting. When a key exists in multiple sources, the
+ value associated with the last source will take precedence.
+ Values defined by an Env with a duplicate key will
+ take precedence. Cannot be updated.
items:
description: EnvFromSource represents the source of
a set of ConfigMaps
@@ -13134,17 +12960,16 @@ spec:
description: The ConfigMap to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
prefix:
description: An optional identifier to prepend
to each key in the ConfigMap. Must be a C_IDENTIFIER.
@@ -13153,53 +12978,53 @@ spec:
description: The Secret to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret must
be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
image:
- description: |-
- Container image name.
- More info: https://kubernetes.io/docs/concepts/containers/images
+ description: 'Container image name. More info: https://kubernetes.io/docs/concepts/containers/images'
type: string
imagePullPolicy:
- description: |-
- Image pull policy.
- One of Always, Never, IfNotPresent.
- Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
+ description: 'Image pull policy. One of Always, Never,
+ IfNotPresent. Defaults to Always if :latest tag is
+ specified, or IfNotPresent otherwise. Cannot be updated.
+ More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
description: Lifecycle is not allowed for ephemeral
containers.
properties:
postStart:
- description: |-
- PostStart is called immediately after a container is created. If the handler fails,
- the container is terminated and restarted according to its restart policy.
- Other management of the container blocks until the hook completes.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PostStart is called immediately after
+ a container is created. If the handler fails,
+ the container is terminated and restarted according
+ to its restart policy. Other management of the
+ container blocks until the hook completes. More
+ info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
@@ -13209,8 +13034,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -13221,9 +13046,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -13241,15 +13067,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -13267,10 +13092,11 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT supported
+ as a LifecycleHandler and kept for the backward
+ compatibility. There are no validation of
+ this field and lifecycle hooks will fail in
+ runtime when tcp handler is specified.
properties:
host:
description: 'Optional: Host name to connect
@@ -13280,37 +13106,44 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
preStop:
- description: |-
- PreStop is called immediately before a container is terminated due to an
- API request or management event such as liveness/startup probe failure,
- preemption, resource contention, etc. The handler is not called if the
- container crashes or exits. The Pod's termination grace period countdown begins before the
- PreStop hook is executed. Regardless of the outcome of the handler, the
- container will eventually terminate within the Pod's termination grace
- period (unless delayed by finalizers). Other management of the container blocks until the hook completes
- or until the termination grace period is reached.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PreStop is called immediately before
+ a container is terminated due to an API request
+ or management event such as liveness/startup probe
+ failure, preemption, resource contention, etc.
+ The handler is not called if the container crashes
+ or exits. The Pod''s termination grace period
+ countdown begins before the PreStop hook is executed.
+ Regardless of the outcome of the handler, the
+ container will eventually terminate within the
+ Pod''s termination grace period (unless delayed
+ by finalizers). Other management of the container
+ blocks until the hook completes or until the termination
+ grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
@@ -13320,8 +13153,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -13332,9 +13165,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -13352,15 +13186,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -13378,10 +13211,11 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT supported
+ as a LifecycleHandler and kept for the backward
+ compatibility. There are no validation of
+ this field and lifecycle hooks will fail in
+ runtime when tcp handler is specified.
properties:
host:
description: 'Optional: Host name to connect
@@ -13391,10 +13225,10 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
@@ -13408,19 +13242,22 @@ spec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to
+ execute inside the container, the working
+ directory for the command is root ('/') in
+ the container's filesystem. The command is
+ simply exec'd, it is not run inside a shell,
+ so traditional shell instructions ('|', etc)
+ won't work. To use a shell, you need to explicitly
+ call out to that shell. Exit status of 0 is
+ treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
format: int32
type: integer
@@ -13434,12 +13271,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
- (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ description: "Service is the name of the service
+ to place in the gRPC HealthCheckRequest (see
+ https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
+ \n If this is not specified, the default behavior
+ is defined by gRPC."
type: string
required:
- port
@@ -13449,9 +13285,9 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
description: Custom headers to set in the request.
@@ -13461,9 +13297,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name. This
+ will be canonicalized upon output, so
+ case-variant names will be understood
+ as the same header.
type: string
value:
description: The header field value
@@ -13480,35 +13317,34 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for the
+ probe to be considered successful after having
+ failed. Defaults to 1. Must be 1 for liveness
+ and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -13523,40 +13359,43 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod
+ needs to terminate gracefully upon probe failure.
+ The grace period is the duration in seconds after
+ the processes running in the pod are sent a termination
+ signal and the time when the processes are forcibly
+ halted with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value must
+ be non-negative integer. The value zero indicates
+ stop immediately via the kill signal (no opportunity
+ to shut down). This is a beta field and requires
+ enabling ProbeTerminationGracePeriod feature gate.
+ Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which the
+ probe times out. Defaults to 1 second. Minimum
+ value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
name:
- description: |-
- Name of the ephemeral container specified as a DNS_LABEL.
- This name must be unique among all containers, init containers and ephemeral containers.
+ description: Name of the ephemeral container specified
+ as a DNS_LABEL. This name must be unique among all
+ containers, init containers and ephemeral containers.
type: string
ports:
description: Ports are not allowed for ephemeral containers.
@@ -13565,9 +13404,9 @@ spec:
in a single container.
properties:
containerPort:
- description: |-
- Number of port to expose on the pod's IP address.
- This must be a valid port number, 0 < x < 65536.
+ description: Number of port to expose on the pod's
+ IP address. This must be a valid port number,
+ 0 < x < 65536.
format: int32
type: integer
hostIP:
@@ -13575,24 +13414,23 @@ spec:
port to.
type: string
hostPort:
- description: |-
- Number of port to expose on the host.
- If specified, this must be a valid port number, 0 < x < 65536.
- If HostNetwork is specified, this must match ContainerPort.
- Most containers do not need this.
+ description: Number of port to expose on the host.
+ If specified, this must be a valid port number,
+ 0 < x < 65536. If HostNetwork is specified,
+ this must match ContainerPort. Most containers
+ do not need this.
format: int32
type: integer
name:
- description: |-
- If specified, this must be an IANA_SVC_NAME and unique within the pod. Each
- named port in a pod must have a unique name. Name for the port that can be
- referred to by services.
+ description: If specified, this must be an IANA_SVC_NAME
+ and unique within the pod. Each named port in
+ a pod must have a unique name. Name for the
+ port that can be referred to by services.
type: string
protocol:
default: TCP
- description: |-
- Protocol for port. Must be UDP, TCP, or SCTP.
- Defaults to "TCP".
+ description: Protocol for port. Must be UDP, TCP,
+ or SCTP. Defaults to "TCP".
type: string
required:
- containerPort
@@ -13609,19 +13447,22 @@ spec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to
+ execute inside the container, the working
+ directory for the command is root ('/') in
+ the container's filesystem. The command is
+ simply exec'd, it is not run inside a shell,
+ so traditional shell instructions ('|', etc)
+ won't work. To use a shell, you need to explicitly
+ call out to that shell. Exit status of 0 is
+ treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
format: int32
type: integer
@@ -13635,12 +13476,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
- (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ description: "Service is the name of the service
+ to place in the gRPC HealthCheckRequest (see
+ https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
+ \n If this is not specified, the default behavior
+ is defined by gRPC."
type: string
required:
- port
@@ -13650,9 +13490,9 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
description: Custom headers to set in the request.
@@ -13662,9 +13502,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name. This
+ will be canonicalized upon output, so
+ case-variant names will be understood
+ as the same header.
type: string
value:
description: The header field value
@@ -13681,35 +13522,34 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for the
+ probe to be considered successful after having
+ failed. Defaults to 1. Must be 1 for liveness
+ and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -13724,33 +13564,36 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod
+ needs to terminate gracefully upon probe failure.
+ The grace period is the duration in seconds after
+ the processes running in the pod are sent a termination
+ signal and the time when the processes are forcibly
+ halted with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value must
+ be non-negative integer. The value zero indicates
+ stop immediately via the kill signal (no opportunity
+ to shut down). This is a beta field and requires
+ enabling ProbeTerminationGracePeriod feature gate.
+ Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which the
+ probe times out. Defaults to 1 second. Minimum
+ value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
@@ -13761,14 +13604,14 @@ spec:
resize policy for the container.
properties:
resourceName:
- description: |-
- Name of the resource to which this resource resize policy applies.
- Supported values: cpu, memory.
+ description: 'Name of the resource to which this
+ resource resize policy applies. Supported values:
+ cpu, memory.'
type: string
restartPolicy:
- description: |-
- Restart policy to apply when specified resource is resized.
- If not specified, it defaults to NotRequired.
+ description: Restart policy to apply when specified
+ resource is resized. If not specified, it defaults
+ to NotRequired.
type: string
required:
- resourceName
@@ -13777,30 +13620,26 @@ spec:
type: array
x-kubernetes-list-type: atomic
resources:
- description: |-
- Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources
+ description: Resources are not allowed for ephemeral
+ containers. Ephemeral containers use spare resources
already allocated to the pod.
properties:
claims:
- description: |-
- Claims lists the names of resources, defined in spec.resourceClaims,
- that are used by this container.
-
-
- This is an alpha field and requires enabling the
- DynamicResourceAllocation feature gate.
-
-
- This field is immutable. It can only be set for containers.
+ description: "Claims lists the names of resources,
+ defined in spec.resourceClaims, that are used
+ by this container. \n This is an alpha field and
+ requires enabling the DynamicResourceAllocation
+ feature gate. \n This field is immutable. It can
+ only be set for containers."
items:
description: ResourceClaim references one entry
in PodSpec.ResourceClaims.
properties:
name:
- description: |-
- Name must match the name of one entry in pod.spec.resourceClaims of
- the Pod where this field is used. It makes that resource available
- inside a container.
+ description: Name must match the name of one
+ entry in pod.spec.resourceClaims of the
+ Pod where this field is used. It makes that
+ resource available inside a container.
type: string
required:
- name
@@ -13816,9 +13655,8 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Limits describes the maximum amount of compute resources allowed.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Limits describes the maximum amount
+ of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -13827,40 +13665,41 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Requests describes the minimum amount of compute resources required.
- If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
- otherwise to an implementation-defined value. Requests cannot exceed Limits.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Requests describes the minimum amount
+ of compute resources required. If Requests is
+ omitted for a container, it defaults to Limits
+ if that is explicitly specified, otherwise to
+ an implementation-defined value. Requests cannot
+ exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
restartPolicy:
- description: |-
- Restart policy for the container to manage the restart behavior of each
- container within a pod.
- This may only be set for init containers. You cannot set this field on
- ephemeral containers.
+ description: Restart policy for the container to manage
+ the restart behavior of each container within a pod.
+ This may only be set for init containers. You cannot
+ set this field on ephemeral containers.
type: string
securityContext:
- description: |-
- Optional: SecurityContext defines the security options the ephemeral container should be run with.
- If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
+ description: 'Optional: SecurityContext defines the
+ security options the ephemeral container should be
+ run with. If set, the fields of SecurityContext override
+ the equivalent fields of PodSecurityContext.'
properties:
allowPrivilegeEscalation:
- description: |-
- AllowPrivilegeEscalation controls whether a process can gain more
- privileges than its parent process. This bool directly controls if
- the no_new_privs flag will be set on the container process.
- AllowPrivilegeEscalation is true always when the container is:
- 1) run as Privileged
- 2) has CAP_SYS_ADMIN
- Note that this field cannot be set when spec.os.name is windows.
+ description: 'AllowPrivilegeEscalation controls
+ whether a process can gain more privileges than
+ its parent process. This bool directly controls
+ if the no_new_privs flag will be set on the container
+ process. AllowPrivilegeEscalation is true always
+ when the container is: 1) run as Privileged 2)
+ has CAP_SYS_ADMIN Note that this field cannot
+ be set when spec.os.name is windows.'
type: boolean
capabilities:
- description: |-
- The capabilities to add/drop when running containers.
- Defaults to the default set of capabilities granted by the container runtime.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The capabilities to add/drop when running
+ containers. Defaults to the default set of capabilities
+ granted by the container runtime. Note that this
+ field cannot be set when spec.os.name is windows.
properties:
add:
description: Added capabilities
@@ -13878,60 +13717,66 @@ spec:
type: array
type: object
privileged:
- description: |-
- Run container in privileged mode.
- Processes in privileged containers are essentially equivalent to root on the host.
- Defaults to false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Run container in privileged mode. Processes
+ in privileged containers are essentially equivalent
+ to root on the host. Defaults to false. Note that
+ this field cannot be set when spec.os.name is
+ windows.
type: boolean
procMount:
- description: |-
- procMount denotes the type of proc mount to use for the containers.
- The default is DefaultProcMount which uses the container runtime defaults for
- readonly paths and masked paths.
- This requires the ProcMountType feature flag to be enabled.
- Note that this field cannot be set when spec.os.name is windows.
+ description: procMount denotes the type of proc
+ mount to use for the containers. The default is
+ DefaultProcMount which uses the container runtime
+ defaults for readonly paths and masked paths.
+ This requires the ProcMountType feature flag to
+ be enabled. Note that this field cannot be set
+ when spec.os.name is windows.
type: string
readOnlyRootFilesystem:
- description: |-
- Whether this container has a read-only root filesystem.
- Default is false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Whether this container has a read-only
+ root filesystem. Default is false. Note that this
+ field cannot be set when spec.os.name is windows.
type: boolean
runAsGroup:
- description: |-
- The GID to run the entrypoint of the container process.
- Uses runtime default if unset.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The GID to run the entrypoint of the
+ container process. Uses runtime default if unset.
+ May also be set in PodSecurityContext. If set
+ in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence.
+ Note that this field cannot be set when spec.os.name
+ is windows.
format: int64
type: integer
runAsNonRoot:
- description: |-
- Indicates that the container must run as a non-root user.
- If true, the Kubelet will validate the image at runtime to ensure that it
- does not run as UID 0 (root) and fail to start the container if it does.
- If unset or false, no such validation will be performed.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: Indicates that the container must run
+ as a non-root user. If true, the Kubelet will
+ validate the image at runtime to ensure that it
+ does not run as UID 0 (root) and fail to start
+ the container if it does. If unset or false, no
+ such validation will be performed. May also be
+ set in PodSecurityContext. If set in both SecurityContext
+ and PodSecurityContext, the value specified in
+ SecurityContext takes precedence.
type: boolean
runAsUser:
- description: |-
- The UID to run the entrypoint of the container process.
- Defaults to user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The UID to run the entrypoint of the
+ container process. Defaults to user specified
+ in image metadata if unspecified. May also be
+ set in PodSecurityContext. If set in both SecurityContext
+ and PodSecurityContext, the value specified in
+ SecurityContext takes precedence. Note that this
+ field cannot be set when spec.os.name is windows.
format: int64
type: integer
seLinuxOptions:
- description: |-
- The SELinux context to be applied to the container.
- If unspecified, the container runtime will allocate a random SELinux context for each
- container. May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The SELinux context to be applied to
+ the container. If unspecified, the container runtime
+ will allocate a random SELinux context for each
+ container. May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence.
+ Note that this field cannot be set when spec.os.name
+ is windows.
properties:
level:
description: Level is SELinux level label that
@@ -13951,62 +13796,70 @@ spec:
type: string
type: object
seccompProfile:
- description: |-
- The seccomp options to use by this container. If seccomp options are
- provided at both the pod & container level, the container options
- override the pod options.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The seccomp options to use by this
+ container. If seccomp options are provided at
+ both the pod & container level, the container
+ options override the pod options. Note that this
+ field cannot be set when spec.os.name is windows.
properties:
localhostProfile:
- description: |-
- localhostProfile indicates a profile defined in a file on the node should be used.
- The profile must be preconfigured on the node to work.
- Must be a descending path, relative to the kubelet's configured seccomp profile location.
- Must be set if type is "Localhost". Must NOT be set for any other type.
+ description: localhostProfile indicates a profile
+ defined in a file on the node should be used.
+ The profile must be preconfigured on the node
+ to work. Must be a descending path, relative
+ to the kubelet's configured seccomp profile
+ location. Must be set if type is "Localhost".
+ Must NOT be set for any other type.
type: string
type:
- description: |-
- type indicates which kind of seccomp profile will be applied.
- Valid options are:
-
-
- Localhost - a profile defined in a file on the node should be used.
- RuntimeDefault - the container runtime default profile should be used.
- Unconfined - no profile should be applied.
+ description: "type indicates which kind of seccomp
+ profile will be applied. Valid options are:
+ \n Localhost - a profile defined in a file
+ on the node should be used. RuntimeDefault
+ - the container runtime default profile should
+ be used. Unconfined - no profile should be
+ applied."
type: string
required:
- type
type: object
windowsOptions:
- description: |-
- The Windows specific settings applied to all containers.
- If unspecified, the options from the PodSecurityContext will be used.
- If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is linux.
+ description: The Windows specific settings applied
+ to all containers. If unspecified, the options
+ from the PodSecurityContext will be used. If set
+ in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence.
+ Note that this field cannot be set when spec.os.name
+ is linux.
properties:
gmsaCredentialSpec:
- description: |-
- GMSACredentialSpec is where the GMSA admission webhook
- (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
- GMSA credential spec named by the GMSACredentialSpecName field.
+ description: GMSACredentialSpec is where the
+ GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa)
+ inlines the contents of the GMSA credential
+ spec named by the GMSACredentialSpecName field.
type: string
gmsaCredentialSpecName:
description: GMSACredentialSpecName is the name
of the GMSA credential spec to use.
type: string
hostProcess:
- description: |-
- HostProcess determines if a container should be run as a 'Host Process' container.
- All of a Pod's containers must have the same effective HostProcess value
- (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
- In addition, if HostProcess is true then HostNetwork must also be set to true.
+ description: HostProcess determines if a container
+ should be run as a 'Host Process' container.
+ All of a Pod's containers must have the same
+ effective HostProcess value (it is not allowed
+ to have a mix of HostProcess containers and
+ non-HostProcess containers). In addition,
+ if HostProcess is true then HostNetwork must
+ also be set to true.
type: boolean
runAsUserName:
- description: |-
- The UserName in Windows to run the entrypoint of the container process.
- Defaults to the user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: The UserName in Windows to run
+ the entrypoint of the container process. Defaults
+ to the user specified in image metadata if
+ unspecified. May also be set in PodSecurityContext.
+ If set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence.
type: string
type: object
type: object
@@ -14017,19 +13870,22 @@ spec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to
+ execute inside the container, the working
+ directory for the command is root ('/') in
+ the container's filesystem. The command is
+ simply exec'd, it is not run inside a shell,
+ so traditional shell instructions ('|', etc)
+ won't work. To use a shell, you need to explicitly
+ call out to that shell. Exit status of 0 is
+ treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
format: int32
type: integer
@@ -14043,12 +13899,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
- (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ description: "Service is the name of the service
+ to place in the gRPC HealthCheckRequest (see
+ https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
+ \n If this is not specified, the default behavior
+ is defined by gRPC."
type: string
required:
- port
@@ -14058,9 +13913,9 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
description: Custom headers to set in the request.
@@ -14070,9 +13925,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name. This
+ will be canonicalized upon output, so
+ case-variant names will be understood
+ as the same header.
type: string
value:
description: The header field value
@@ -14089,35 +13945,34 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for the
+ probe to be considered successful after having
+ failed. Defaults to 1. Must be 1 for liveness
+ and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -14132,85 +13987,94 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod
+ needs to terminate gracefully upon probe failure.
+ The grace period is the duration in seconds after
+ the processes running in the pod are sent a termination
+ signal and the time when the processes are forcibly
+ halted with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value must
+ be non-negative integer. The value zero indicates
+ stop immediately via the kill signal (no opportunity
+ to shut down). This is a beta field and requires
+ enabling ProbeTerminationGracePeriod feature gate.
+ Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which the
+ probe times out. Defaults to 1 second. Minimum
+ value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
stdin:
- description: |-
- Whether this container should allocate a buffer for stdin in the container runtime. If this
- is not set, reads from stdin in the container will always result in EOF.
- Default is false.
+ description: Whether this container should allocate
+ a buffer for stdin in the container runtime. If this
+ is not set, reads from stdin in the container will
+ always result in EOF. Default is false.
type: boolean
stdinOnce:
- description: |-
- Whether the container runtime should close the stdin channel after it has been opened by
- a single attach. When stdin is true the stdin stream will remain open across multiple attach
- sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
- first client attaches to stdin, and then remains open and accepts data until the client disconnects,
- at which time stdin is closed and remains closed until the container is restarted. If this
- flag is false, a container processes that reads from stdin will never receive an EOF.
- Default is false
+ description: Whether the container runtime should close
+ the stdin channel after it has been opened by a single
+ attach. When stdin is true the stdin stream will remain
+ open across multiple attach sessions. If stdinOnce
+ is set to true, stdin is opened on container start,
+ is empty until the first client attaches to stdin,
+ and then remains open and accepts data until the client
+ disconnects, at which time stdin is closed and remains
+ closed until the container is restarted. If this flag
+ is false, a container processes that reads from stdin
+ will never receive an EOF. Default is false
type: boolean
targetContainerName:
- description: |-
- If set, the name of the container from PodSpec that this ephemeral container targets.
- The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container.
- If not set then the ephemeral container uses the namespaces configured in the Pod spec.
-
-
- The container runtime must implement support for this feature. If the runtime does not
- support namespace targeting then the result of setting this field is undefined.
+ description: "If set, the name of the container from
+ PodSpec that this ephemeral container targets. The
+ ephemeral container will be run in the namespaces
+ (IPC, PID, etc) of this container. If not set then
+ the ephemeral container uses the namespaces configured
+ in the Pod spec. \n The container runtime must implement
+ support for this feature. If the runtime does not
+ support namespace targeting then the result of setting
+ this field is undefined."
type: string
terminationMessagePath:
- description: |-
- Optional: Path at which the file to which the container's termination message
- will be written is mounted into the container's filesystem.
- Message written is intended to be brief final status, such as an assertion failure message.
- Will be truncated by the node if greater than 4096 bytes. The total message length across
- all containers will be limited to 12kb.
- Defaults to /dev/termination-log.
- Cannot be updated.
+ description: 'Optional: Path at which the file to which
+ the container''s termination message will be written
+ is mounted into the container''s filesystem. Message
+ written is intended to be brief final status, such
+ as an assertion failure message. Will be truncated
+ by the node if greater than 4096 bytes. The total
+ message length across all containers will be limited
+ to 12kb. Defaults to /dev/termination-log. Cannot
+ be updated.'
type: string
terminationMessagePolicy:
- description: |-
- Indicate how the termination message should be populated. File will use the contents of
- terminationMessagePath to populate the container status message on both success and failure.
- FallbackToLogsOnError will use the last chunk of container log output if the termination
- message file is empty and the container exited with an error.
- The log output is limited to 2048 bytes or 80 lines, whichever is smaller.
- Defaults to File.
- Cannot be updated.
+ description: Indicate how the termination message should
+ be populated. File will use the contents of terminationMessagePath
+ to populate the container status message on both success
+ and failure. FallbackToLogsOnError will use the last
+ chunk of container log output if the termination message
+ file is empty and the container exited with an error.
+ The log output is limited to 2048 bytes or 80 lines,
+ whichever is smaller. Defaults to File. Cannot be
+ updated.
type: string
tty:
- description: |-
- Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
+ description: Whether this container should allocate
+ a TTY for itself, also requires 'stdin' to be true.
Default is false.
type: boolean
volumeDevices:
@@ -14235,44 +14099,45 @@ spec:
type: object
type: array
volumeMounts:
- description: |-
- Pod volumes to mount into the container's filesystem. Subpath mounts are not allowed for ephemeral containers.
- Cannot be updated.
+ description: Pod volumes to mount into the container's
+ filesystem. Subpath mounts are not allowed for ephemeral
+ containers. Cannot be updated.
items:
description: VolumeMount describes a mounting of a
Volume within a container.
properties:
mountPath:
- description: |-
- Path within the container at which the volume should be mounted. Must
- not contain ':'.
+ description: Path within the container at which
+ the volume should be mounted. Must not contain
+ ':'.
type: string
mountPropagation:
- description: |-
- mountPropagation determines how mounts are propagated from the host
- to container and the other way around.
- When not set, MountPropagationNone is used.
- This field is beta in 1.10.
+ description: mountPropagation determines how mounts
+ are propagated from the host to container and
+ the other way around. When not set, MountPropagationNone
+ is used. This field is beta in 1.10.
type: string
name:
description: This must match the Name of a Volume.
type: string
readOnly:
- description: |-
- Mounted read-only if true, read-write otherwise (false or unspecified).
- Defaults to false.
+ description: Mounted read-only if true, read-write
+ otherwise (false or unspecified). Defaults to
+ false.
type: boolean
subPath:
- description: |-
- Path within the volume from which the container's volume should be mounted.
- Defaults to "" (volume's root).
+ description: Path within the volume from which
+ the container's volume should be mounted. Defaults
+ to "" (volume's root).
type: string
subPathExpr:
- description: |-
- Expanded path within the volume from which the container's volume should be mounted.
- Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.
- Defaults to "" (volume's root).
- SubPathExpr and SubPath are mutually exclusive.
+ description: Expanded path within the volume from
+ which the container's volume should be mounted.
+ Behaves similarly to SubPath but environment
+ variable references $(VAR_NAME) are expanded
+ using the container's environment. Defaults
+ to "" (volume's root). SubPathExpr and SubPath
+ are mutually exclusive.
type: string
required:
- mountPath
@@ -14280,11 +14145,10 @@ spec:
type: object
type: array
workingDir:
- description: |-
- Container's working directory.
- If not specified, the container runtime's default will be used, which
- might be configured in the container image.
- Cannot be updated.
+ description: Container's working directory. If not specified,
+ the container runtime's default will be used, which
+ might be configured in the container image. Cannot
+ be updated.
type: string
required:
- name
@@ -14297,35 +14161,38 @@ spec:
to run within a pod.
properties:
args:
- description: |-
- Arguments to the entrypoint.
- The container image's CMD is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Arguments to the entrypoint. The container
+ image''s CMD is used if this is not provided. Variable
+ references $(VAR_NAME) are expanded using the container''s
+ environment. If a variable cannot be resolved, the
+ reference in the input string will be unchanged. Double
+ $$ are reduced to a single $, which allows for escaping
+ the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce
+ the string literal "$(VAR_NAME)". Escaped references
+ will never be expanded, regardless of whether the
+ variable exists or not. Cannot be updated. More info:
+ https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
command:
- description: |-
- Entrypoint array. Not executed within a shell.
- The container image's ENTRYPOINT is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Entrypoint array. Not executed within
+ a shell. The container image''s ENTRYPOINT is used
+ if this is not provided. Variable references $(VAR_NAME)
+ are expanded using the container''s environment. If
+ a variable cannot be resolved, the reference in the
+ input string will be unchanged. Double $$ are reduced
+ to a single $, which allows for escaping the $(VAR_NAME)
+ syntax: i.e. "$$(VAR_NAME)" will produce the string
+ literal "$(VAR_NAME)". Escaped references will never
+ be expanded, regardless of whether the variable exists
+ or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
env:
- description: |-
- List of environment variables to set in the container.
- Cannot be updated.
+ description: List of environment variables to set in
+ the container. Cannot be updated.
items:
description: EnvVar represents an environment variable
present in a Container.
@@ -14335,16 +14202,17 @@ spec:
Must be a C_IDENTIFIER.
type: string
value:
- description: |-
- Variable references $(VAR_NAME) are expanded
- using the previously defined environment variables in the container and
- any service environment variables. If a variable cannot be resolved,
- the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
- "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
- Escaped references will never be expanded, regardless of whether the variable
- exists or not.
- Defaults to "".
+ description: 'Variable references $(VAR_NAME)
+ are expanded using the previously defined environment
+ variables in the container and any service environment
+ variables. If a variable cannot be resolved,
+ the reference in the input string will be unchanged.
+ Double $$ are reduced to a single $, which allows
+ for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)"
+ will produce the string literal "$(VAR_NAME)".
+ Escaped references will never be expanded, regardless
+ of whether the variable exists or not. Defaults
+ to "".'
type: string
valueFrom:
description: Source for the environment variable's
@@ -14357,10 +14225,10 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
@@ -14369,11 +14237,12 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
fieldRef:
- description: |-
- Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`,
- spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ description: 'Selects a field of the pod:
+ supports metadata.name, metadata.namespace,
+ `metadata.labels['''']`, `metadata.annotations['''']`,
+ spec.nodeName, spec.serviceAccountName,
+ status.hostIP, status.podIP, status.podIPs.'
properties:
apiVersion:
description: Version of the schema the
@@ -14387,11 +14256,12 @@ spec:
required:
- fieldPath
type: object
- x-kubernetes-map-type: atomic
resourceFieldRef:
- description: |-
- Selects a resource of the container: only resources limits and requests
- (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
+ description: 'Selects a resource of the container:
+ only resources limits and requests (limits.cpu,
+ limits.memory, limits.ephemeral-storage,
+ requests.cpu, requests.memory and requests.ephemeral-storage)
+ are currently supported.'
properties:
containerName:
description: 'Container name: required
@@ -14412,7 +14282,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret in
the pod's namespace
@@ -14423,10 +14292,10 @@ spec:
key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret
@@ -14435,20 +14304,20 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
required:
- name
type: object
type: array
envFrom:
- description: |-
- List of sources to populate environment variables in the container.
- The keys defined within a source must be a C_IDENTIFIER. All invalid keys
- will be reported as an event when the container is starting. When a key exists in multiple
- sources, the value associated with the last source will take precedence.
- Values defined by an Env with a duplicate key will take precedence.
- Cannot be updated.
+ description: List of sources to populate environment
+ variables in the container. The keys defined within
+ a source must be a C_IDENTIFIER. All invalid keys
+ will be reported as an event when the container is
+ starting. When a key exists in multiple sources, the
+ value associated with the last source will take precedence.
+ Values defined by an Env with a duplicate key will
+ take precedence. Cannot be updated.
items:
description: EnvFromSource represents the source of
a set of ConfigMaps
@@ -14457,17 +14326,16 @@ spec:
description: The ConfigMap to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
prefix:
description: An optional identifier to prepend
to each key in the ConfigMap. Must be a C_IDENTIFIER.
@@ -14476,56 +14344,57 @@ spec:
description: The Secret to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret must
be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
image:
- description: |-
- Container image name.
- More info: https://kubernetes.io/docs/concepts/containers/images
- This field is optional to allow higher level config management to default or override
- container images in workload controllers like Deployments and StatefulSets.
+ description: 'Container image name. More info: https://kubernetes.io/docs/concepts/containers/images
+ This field is optional to allow higher level config
+ management to default or override container images
+ in workload controllers like Deployments and StatefulSets.'
type: string
imagePullPolicy:
- description: |-
- Image pull policy.
- One of Always, Never, IfNotPresent.
- Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
+ description: 'Image pull policy. One of Always, Never,
+ IfNotPresent. Defaults to Always if :latest tag is
+ specified, or IfNotPresent otherwise. Cannot be updated.
+ More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
- description: |-
- Actions that the management system should take in response to container lifecycle events.
- Cannot be updated.
+ description: Actions that the management system should
+ take in response to container lifecycle events. Cannot
+ be updated.
properties:
postStart:
- description: |-
- PostStart is called immediately after a container is created. If the handler fails,
- the container is terminated and restarted according to its restart policy.
- Other management of the container blocks until the hook completes.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PostStart is called immediately after
+ a container is created. If the handler fails,
+ the container is terminated and restarted according
+ to its restart policy. Other management of the
+ container blocks until the hook completes. More
+ info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
@@ -14535,8 +14404,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -14547,9 +14416,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -14567,15 +14437,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -14593,10 +14462,11 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT supported
+ as a LifecycleHandler and kept for the backward
+ compatibility. There are no validation of
+ this field and lifecycle hooks will fail in
+ runtime when tcp handler is specified.
properties:
host:
description: 'Optional: Host name to connect
@@ -14606,37 +14476,44 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
preStop:
- description: |-
- PreStop is called immediately before a container is terminated due to an
- API request or management event such as liveness/startup probe failure,
- preemption, resource contention, etc. The handler is not called if the
- container crashes or exits. The Pod's termination grace period countdown begins before the
- PreStop hook is executed. Regardless of the outcome of the handler, the
- container will eventually terminate within the Pod's termination grace
- period (unless delayed by finalizers). Other management of the container blocks until the hook completes
- or until the termination grace period is reached.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PreStop is called immediately before
+ a container is terminated due to an API request
+ or management event such as liveness/startup probe
+ failure, preemption, resource contention, etc.
+ The handler is not called if the container crashes
+ or exits. The Pod''s termination grace period
+ countdown begins before the PreStop hook is executed.
+ Regardless of the outcome of the handler, the
+ container will eventually terminate within the
+ Pod''s termination grace period (unless delayed
+ by finalizers). Other management of the container
+ blocks until the hook completes or until the termination
+ grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
@@ -14646,8 +14523,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -14658,9 +14535,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -14678,15 +14556,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -14704,10 +14581,11 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT supported
+ as a LifecycleHandler and kept for the backward
+ compatibility. There are no validation of
+ this field and lifecycle hooks will fail in
+ runtime when tcp handler is specified.
properties:
host:
description: 'Optional: Host name to connect
@@ -14717,10 +14595,10 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
@@ -14728,29 +14606,30 @@ spec:
type: object
type: object
livenessProbe:
- description: |-
- Periodic probe of container liveness.
- Container will be restarted if the probe fails.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Periodic probe of container liveness.
+ Container will be restarted if the probe fails. Cannot
+ be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to
+ execute inside the container, the working
+ directory for the command is root ('/') in
+ the container's filesystem. The command is
+ simply exec'd, it is not run inside a shell,
+ so traditional shell instructions ('|', etc)
+ won't work. To use a shell, you need to explicitly
+ call out to that shell. Exit status of 0 is
+ treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
format: int32
type: integer
@@ -14764,12 +14643,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
- (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ description: "Service is the name of the service
+ to place in the gRPC HealthCheckRequest (see
+ https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
+ \n If this is not specified, the default behavior
+ is defined by gRPC."
type: string
required:
- port
@@ -14779,9 +14657,9 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
description: Custom headers to set in the request.
@@ -14791,9 +14669,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name. This
+ will be canonicalized upon output, so
+ case-variant names will be understood
+ as the same header.
type: string
value:
description: The header field value
@@ -14810,35 +14689,34 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for the
+ probe to be considered successful after having
+ failed. Defaults to 1. Must be 1 for liveness
+ and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -14853,59 +14731,61 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod
+ needs to terminate gracefully upon probe failure.
+ The grace period is the duration in seconds after
+ the processes running in the pod are sent a termination
+ signal and the time when the processes are forcibly
+ halted with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value must
+ be non-negative integer. The value zero indicates
+ stop immediately via the kill signal (no opportunity
+ to shut down). This is a beta field and requires
+ enabling ProbeTerminationGracePeriod feature gate.
+ Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which the
+ probe times out. Defaults to 1 second. Minimum
+ value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
name:
- description: |-
- Name of the container specified as a DNS_LABEL.
+ description: Name of the container specified as a DNS_LABEL.
Each container in a pod must have a unique name (DNS_LABEL).
Cannot be updated.
type: string
ports:
- description: |-
- List of ports to expose from the container. Not specifying a port here
- DOES NOT prevent that port from being exposed. Any port which is
- listening on the default "0.0.0.0" address inside a container will be
- accessible from the network.
- Modifying this array with strategic merge patch may corrupt the data.
- For more information See https://github.com/kubernetes/kubernetes/issues/108255.
+ description: List of ports to expose from the container.
+ Not specifying a port here DOES NOT prevent that port
+ from being exposed. Any port which is listening on
+ the default "0.0.0.0" address inside a container will
+ be accessible from the network. Modifying this array
+ with strategic merge patch may corrupt the data. For
+ more information See https://github.com/kubernetes/kubernetes/issues/108255.
Cannot be updated.
items:
description: ContainerPort represents a network port
in a single container.
properties:
containerPort:
- description: |-
- Number of port to expose on the pod's IP address.
- This must be a valid port number, 0 < x < 65536.
+ description: Number of port to expose on the pod's
+ IP address. This must be a valid port number,
+ 0 < x < 65536.
format: int32
type: integer
hostIP:
@@ -14913,24 +14793,23 @@ spec:
port to.
type: string
hostPort:
- description: |-
- Number of port to expose on the host.
- If specified, this must be a valid port number, 0 < x < 65536.
- If HostNetwork is specified, this must match ContainerPort.
- Most containers do not need this.
+ description: Number of port to expose on the host.
+ If specified, this must be a valid port number,
+ 0 < x < 65536. If HostNetwork is specified,
+ this must match ContainerPort. Most containers
+ do not need this.
format: int32
type: integer
name:
- description: |-
- If specified, this must be an IANA_SVC_NAME and unique within the pod. Each
- named port in a pod must have a unique name. Name for the port that can be
- referred to by services.
+ description: If specified, this must be an IANA_SVC_NAME
+ and unique within the pod. Each named port in
+ a pod must have a unique name. Name for the
+ port that can be referred to by services.
type: string
protocol:
default: TCP
- description: |-
- Protocol for port. Must be UDP, TCP, or SCTP.
- Defaults to "TCP".
+ description: Protocol for port. Must be UDP, TCP,
+ or SCTP. Defaults to "TCP".
type: string
required:
- containerPort
@@ -14941,29 +14820,30 @@ spec:
- protocol
x-kubernetes-list-type: map
readinessProbe:
- description: |-
- Periodic probe of container service readiness.
- Container will be removed from service endpoints if the probe fails.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Periodic probe of container service readiness.
+ Container will be removed from service endpoints if
+ the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to
+ execute inside the container, the working
+ directory for the command is root ('/') in
+ the container's filesystem. The command is
+ simply exec'd, it is not run inside a shell,
+ so traditional shell instructions ('|', etc)
+ won't work. To use a shell, you need to explicitly
+ call out to that shell. Exit status of 0 is
+ treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
format: int32
type: integer
@@ -14977,12 +14857,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
- (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ description: "Service is the name of the service
+ to place in the gRPC HealthCheckRequest (see
+ https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
+ \n If this is not specified, the default behavior
+ is defined by gRPC."
type: string
required:
- port
@@ -14992,9 +14871,9 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
description: Custom headers to set in the request.
@@ -15004,9 +14883,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name. This
+ will be canonicalized upon output, so
+ case-variant names will be understood
+ as the same header.
type: string
value:
description: The header field value
@@ -15023,35 +14903,34 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for the
+ probe to be considered successful after having
+ failed. Defaults to 1. Must be 1 for liveness
+ and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -15066,33 +14945,36 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod
+ needs to terminate gracefully upon probe failure.
+ The grace period is the duration in seconds after
+ the processes running in the pod are sent a termination
+ signal and the time when the processes are forcibly
+ halted with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value must
+ be non-negative integer. The value zero indicates
+ stop immediately via the kill signal (no opportunity
+ to shut down). This is a beta field and requires
+ enabling ProbeTerminationGracePeriod feature gate.
+ Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which the
+ probe times out. Defaults to 1 second. Minimum
+ value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
@@ -15103,14 +14985,14 @@ spec:
resize policy for the container.
properties:
resourceName:
- description: |-
- Name of the resource to which this resource resize policy applies.
- Supported values: cpu, memory.
+ description: 'Name of the resource to which this
+ resource resize policy applies. Supported values:
+ cpu, memory.'
type: string
restartPolicy:
- description: |-
- Restart policy to apply when specified resource is resized.
- If not specified, it defaults to NotRequired.
+ description: Restart policy to apply when specified
+ resource is resized. If not specified, it defaults
+ to NotRequired.
type: string
required:
- resourceName
@@ -15119,31 +15001,25 @@ spec:
type: array
x-kubernetes-list-type: atomic
resources:
- description: |-
- Compute Resources required by this container.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Compute Resources required by this container.
+ Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
properties:
claims:
- description: |-
- Claims lists the names of resources, defined in spec.resourceClaims,
- that are used by this container.
-
-
- This is an alpha field and requires enabling the
- DynamicResourceAllocation feature gate.
-
-
- This field is immutable. It can only be set for containers.
+ description: "Claims lists the names of resources,
+ defined in spec.resourceClaims, that are used
+ by this container. \n This is an alpha field and
+ requires enabling the DynamicResourceAllocation
+ feature gate. \n This field is immutable. It can
+ only be set for containers."
items:
description: ResourceClaim references one entry
in PodSpec.ResourceClaims.
properties:
name:
- description: |-
- Name must match the name of one entry in pod.spec.resourceClaims of
- the Pod where this field is used. It makes that resource available
- inside a container.
+ description: Name must match the name of one
+ entry in pod.spec.resourceClaims of the
+ Pod where this field is used. It makes that
+ resource available inside a container.
type: string
required:
- name
@@ -15159,9 +15035,8 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Limits describes the maximum amount of compute resources allowed.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Limits describes the maximum amount
+ of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -15170,52 +15045,57 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Requests describes the minimum amount of compute resources required.
- If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
- otherwise to an implementation-defined value. Requests cannot exceed Limits.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Requests describes the minimum amount
+ of compute resources required. If Requests is
+ omitted for a container, it defaults to Limits
+ if that is explicitly specified, otherwise to
+ an implementation-defined value. Requests cannot
+ exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
restartPolicy:
- description: |-
- RestartPolicy defines the restart behavior of individual containers in a pod.
- This field may only be set for init containers, and the only allowed value is "Always".
- For non-init containers or when this field is not specified,
- the restart behavior is defined by the Pod's restart policy and the container type.
- Setting the RestartPolicy as "Always" for the init container will have the following effect:
- this init container will be continually restarted on
- exit until all regular containers have terminated. Once all regular
- containers have completed, all init containers with restartPolicy "Always"
- will be shut down. This lifecycle differs from normal init containers and
- is often referred to as a "sidecar" container. Although this init
- container still starts in the init container sequence, it does not wait
- for the container to complete before proceeding to the next init
- container. Instead, the next init container starts immediately after this
- init container is started, or after any startupProbe has successfully
- completed.
+ description: 'RestartPolicy defines the restart behavior
+ of individual containers in a pod. This field may
+ only be set for init containers, and the only allowed
+ value is "Always". For non-init containers or when
+ this field is not specified, the restart behavior
+ is defined by the Pod''s restart policy and the container
+ type. Setting the RestartPolicy as "Always" for the
+ init container will have the following effect: this
+ init container will be continually restarted on exit
+ until all regular containers have terminated. Once
+ all regular containers have completed, all init containers
+ with restartPolicy "Always" will be shut down. This
+ lifecycle differs from normal init containers and
+ is often referred to as a "sidecar" container. Although
+ this init container still starts in the init container
+ sequence, it does not wait for the container to complete
+ before proceeding to the next init container. Instead,
+ the next init container starts immediately after this
+ init container is started, or after any startupProbe
+ has successfully completed.'
type: string
securityContext:
- description: |-
- SecurityContext defines the security options the container should be run with.
- If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
- More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
+ description: 'SecurityContext defines the security options
+ the container should be run with. If set, the fields
+ of SecurityContext override the equivalent fields
+ of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
properties:
allowPrivilegeEscalation:
- description: |-
- AllowPrivilegeEscalation controls whether a process can gain more
- privileges than its parent process. This bool directly controls if
- the no_new_privs flag will be set on the container process.
- AllowPrivilegeEscalation is true always when the container is:
- 1) run as Privileged
- 2) has CAP_SYS_ADMIN
- Note that this field cannot be set when spec.os.name is windows.
+ description: 'AllowPrivilegeEscalation controls
+ whether a process can gain more privileges than
+ its parent process. This bool directly controls
+ if the no_new_privs flag will be set on the container
+ process. AllowPrivilegeEscalation is true always
+ when the container is: 1) run as Privileged 2)
+ has CAP_SYS_ADMIN Note that this field cannot
+ be set when spec.os.name is windows.'
type: boolean
capabilities:
- description: |-
- The capabilities to add/drop when running containers.
- Defaults to the default set of capabilities granted by the container runtime.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The capabilities to add/drop when running
+ containers. Defaults to the default set of capabilities
+ granted by the container runtime. Note that this
+ field cannot be set when spec.os.name is windows.
properties:
add:
description: Added capabilities
@@ -15233,60 +15113,66 @@ spec:
type: array
type: object
privileged:
- description: |-
- Run container in privileged mode.
- Processes in privileged containers are essentially equivalent to root on the host.
- Defaults to false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Run container in privileged mode. Processes
+ in privileged containers are essentially equivalent
+ to root on the host. Defaults to false. Note that
+ this field cannot be set when spec.os.name is
+ windows.
type: boolean
procMount:
- description: |-
- procMount denotes the type of proc mount to use for the containers.
- The default is DefaultProcMount which uses the container runtime defaults for
- readonly paths and masked paths.
- This requires the ProcMountType feature flag to be enabled.
- Note that this field cannot be set when spec.os.name is windows.
+ description: procMount denotes the type of proc
+ mount to use for the containers. The default is
+ DefaultProcMount which uses the container runtime
+ defaults for readonly paths and masked paths.
+ This requires the ProcMountType feature flag to
+ be enabled. Note that this field cannot be set
+ when spec.os.name is windows.
type: string
readOnlyRootFilesystem:
- description: |-
- Whether this container has a read-only root filesystem.
- Default is false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Whether this container has a read-only
+ root filesystem. Default is false. Note that this
+ field cannot be set when spec.os.name is windows.
type: boolean
runAsGroup:
- description: |-
- The GID to run the entrypoint of the container process.
- Uses runtime default if unset.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The GID to run the entrypoint of the
+ container process. Uses runtime default if unset.
+ May also be set in PodSecurityContext. If set
+ in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence.
+ Note that this field cannot be set when spec.os.name
+ is windows.
format: int64
type: integer
runAsNonRoot:
- description: |-
- Indicates that the container must run as a non-root user.
- If true, the Kubelet will validate the image at runtime to ensure that it
- does not run as UID 0 (root) and fail to start the container if it does.
- If unset or false, no such validation will be performed.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: Indicates that the container must run
+ as a non-root user. If true, the Kubelet will
+ validate the image at runtime to ensure that it
+ does not run as UID 0 (root) and fail to start
+ the container if it does. If unset or false, no
+ such validation will be performed. May also be
+ set in PodSecurityContext. If set in both SecurityContext
+ and PodSecurityContext, the value specified in
+ SecurityContext takes precedence.
type: boolean
runAsUser:
- description: |-
- The UID to run the entrypoint of the container process.
- Defaults to user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The UID to run the entrypoint of the
+ container process. Defaults to user specified
+ in image metadata if unspecified. May also be
+ set in PodSecurityContext. If set in both SecurityContext
+ and PodSecurityContext, the value specified in
+ SecurityContext takes precedence. Note that this
+ field cannot be set when spec.os.name is windows.
format: int64
type: integer
seLinuxOptions:
- description: |-
- The SELinux context to be applied to the container.
- If unspecified, the container runtime will allocate a random SELinux context for each
- container. May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The SELinux context to be applied to
+ the container. If unspecified, the container runtime
+ will allocate a random SELinux context for each
+ container. May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence.
+ Note that this field cannot be set when spec.os.name
+ is windows.
properties:
level:
description: Level is SELinux level label that
@@ -15306,92 +15192,104 @@ spec:
type: string
type: object
seccompProfile:
- description: |-
- The seccomp options to use by this container. If seccomp options are
- provided at both the pod & container level, the container options
- override the pod options.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The seccomp options to use by this
+ container. If seccomp options are provided at
+ both the pod & container level, the container
+ options override the pod options. Note that this
+ field cannot be set when spec.os.name is windows.
properties:
localhostProfile:
- description: |-
- localhostProfile indicates a profile defined in a file on the node should be used.
- The profile must be preconfigured on the node to work.
- Must be a descending path, relative to the kubelet's configured seccomp profile location.
- Must be set if type is "Localhost". Must NOT be set for any other type.
+ description: localhostProfile indicates a profile
+ defined in a file on the node should be used.
+ The profile must be preconfigured on the node
+ to work. Must be a descending path, relative
+ to the kubelet's configured seccomp profile
+ location. Must be set if type is "Localhost".
+ Must NOT be set for any other type.
type: string
type:
- description: |-
- type indicates which kind of seccomp profile will be applied.
- Valid options are:
-
-
- Localhost - a profile defined in a file on the node should be used.
- RuntimeDefault - the container runtime default profile should be used.
- Unconfined - no profile should be applied.
+ description: "type indicates which kind of seccomp
+ profile will be applied. Valid options are:
+ \n Localhost - a profile defined in a file
+ on the node should be used. RuntimeDefault
+ - the container runtime default profile should
+ be used. Unconfined - no profile should be
+ applied."
type: string
required:
- type
type: object
windowsOptions:
- description: |-
- The Windows specific settings applied to all containers.
- If unspecified, the options from the PodSecurityContext will be used.
- If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is linux.
+ description: The Windows specific settings applied
+ to all containers. If unspecified, the options
+ from the PodSecurityContext will be used. If set
+ in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence.
+ Note that this field cannot be set when spec.os.name
+ is linux.
properties:
gmsaCredentialSpec:
- description: |-
- GMSACredentialSpec is where the GMSA admission webhook
- (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
- GMSA credential spec named by the GMSACredentialSpecName field.
+ description: GMSACredentialSpec is where the
+ GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa)
+ inlines the contents of the GMSA credential
+ spec named by the GMSACredentialSpecName field.
type: string
gmsaCredentialSpecName:
description: GMSACredentialSpecName is the name
of the GMSA credential spec to use.
type: string
hostProcess:
- description: |-
- HostProcess determines if a container should be run as a 'Host Process' container.
- All of a Pod's containers must have the same effective HostProcess value
- (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
- In addition, if HostProcess is true then HostNetwork must also be set to true.
+ description: HostProcess determines if a container
+ should be run as a 'Host Process' container.
+ All of a Pod's containers must have the same
+ effective HostProcess value (it is not allowed
+ to have a mix of HostProcess containers and
+ non-HostProcess containers). In addition,
+ if HostProcess is true then HostNetwork must
+ also be set to true.
type: boolean
runAsUserName:
- description: |-
- The UserName in Windows to run the entrypoint of the container process.
- Defaults to the user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: The UserName in Windows to run
+ the entrypoint of the container process. Defaults
+ to the user specified in image metadata if
+ unspecified. May also be set in PodSecurityContext.
+ If set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence.
type: string
type: object
type: object
startupProbe:
- description: |-
- StartupProbe indicates that the Pod has successfully initialized.
- If specified, no other probes are executed until this completes successfully.
- If this probe fails, the Pod will be restarted, just as if the livenessProbe failed.
- This can be used to provide different probe parameters at the beginning of a Pod's lifecycle,
- when it might take a long time to load data or warm a cache, than during steady-state operation.
- This cannot be updated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'StartupProbe indicates that the Pod has
+ successfully initialized. If specified, no other probes
+ are executed until this completes successfully. If
+ this probe fails, the Pod will be restarted, just
+ as if the livenessProbe failed. This can be used to
+ provide different probe parameters at the beginning
+ of a Pod''s lifecycle, when it might take a long time
+ to load data or warm a cache, than during steady-state
+ operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to
+ execute inside the container, the working
+ directory for the command is root ('/') in
+ the container's filesystem. The command is
+ simply exec'd, it is not run inside a shell,
+ so traditional shell instructions ('|', etc)
+ won't work. To use a shell, you need to explicitly
+ call out to that shell. Exit status of 0 is
+ treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
format: int32
type: integer
@@ -15405,12 +15303,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
- (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ description: "Service is the name of the service
+ to place in the gRPC HealthCheckRequest (see
+ https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
+ \n If this is not specified, the default behavior
+ is defined by gRPC."
type: string
required:
- port
@@ -15420,9 +15317,9 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
description: Custom headers to set in the request.
@@ -15432,9 +15329,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name. This
+ will be canonicalized upon output, so
+ case-variant names will be understood
+ as the same header.
type: string
value:
description: The header field value
@@ -15451,35 +15349,34 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for the
+ probe to be considered successful after having
+ failed. Defaults to 1. Must be 1 for liveness
+ and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -15494,75 +15391,83 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod
+ needs to terminate gracefully upon probe failure.
+ The grace period is the duration in seconds after
+ the processes running in the pod are sent a termination
+ signal and the time when the processes are forcibly
+ halted with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value must
+ be non-negative integer. The value zero indicates
+ stop immediately via the kill signal (no opportunity
+ to shut down). This is a beta field and requires
+ enabling ProbeTerminationGracePeriod feature gate.
+ Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which the
+ probe times out. Defaults to 1 second. Minimum
+ value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
stdin:
- description: |-
- Whether this container should allocate a buffer for stdin in the container runtime. If this
- is not set, reads from stdin in the container will always result in EOF.
- Default is false.
+ description: Whether this container should allocate
+ a buffer for stdin in the container runtime. If this
+ is not set, reads from stdin in the container will
+ always result in EOF. Default is false.
type: boolean
stdinOnce:
- description: |-
- Whether the container runtime should close the stdin channel after it has been opened by
- a single attach. When stdin is true the stdin stream will remain open across multiple attach
- sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
- first client attaches to stdin, and then remains open and accepts data until the client disconnects,
- at which time stdin is closed and remains closed until the container is restarted. If this
- flag is false, a container processes that reads from stdin will never receive an EOF.
- Default is false
+ description: Whether the container runtime should close
+ the stdin channel after it has been opened by a single
+ attach. When stdin is true the stdin stream will remain
+ open across multiple attach sessions. If stdinOnce
+ is set to true, stdin is opened on container start,
+ is empty until the first client attaches to stdin,
+ and then remains open and accepts data until the client
+ disconnects, at which time stdin is closed and remains
+ closed until the container is restarted. If this flag
+ is false, a container processes that reads from stdin
+ will never receive an EOF. Default is false
type: boolean
terminationMessagePath:
- description: |-
- Optional: Path at which the file to which the container's termination message
- will be written is mounted into the container's filesystem.
- Message written is intended to be brief final status, such as an assertion failure message.
- Will be truncated by the node if greater than 4096 bytes. The total message length across
- all containers will be limited to 12kb.
- Defaults to /dev/termination-log.
- Cannot be updated.
+ description: 'Optional: Path at which the file to which
+ the container''s termination message will be written
+ is mounted into the container''s filesystem. Message
+ written is intended to be brief final status, such
+ as an assertion failure message. Will be truncated
+ by the node if greater than 4096 bytes. The total
+ message length across all containers will be limited
+ to 12kb. Defaults to /dev/termination-log. Cannot
+ be updated.'
type: string
terminationMessagePolicy:
- description: |-
- Indicate how the termination message should be populated. File will use the contents of
- terminationMessagePath to populate the container status message on both success and failure.
- FallbackToLogsOnError will use the last chunk of container log output if the termination
- message file is empty and the container exited with an error.
- The log output is limited to 2048 bytes or 80 lines, whichever is smaller.
- Defaults to File.
- Cannot be updated.
+ description: Indicate how the termination message should
+ be populated. File will use the contents of terminationMessagePath
+ to populate the container status message on both success
+ and failure. FallbackToLogsOnError will use the last
+ chunk of container log output if the termination message
+ file is empty and the container exited with an error.
+ The log output is limited to 2048 bytes or 80 lines,
+ whichever is smaller. Defaults to File. Cannot be
+ updated.
type: string
tty:
- description: |-
- Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
+ description: Whether this container should allocate
+ a TTY for itself, also requires 'stdin' to be true.
Default is false.
type: boolean
volumeDevices:
@@ -15587,44 +15492,44 @@ spec:
type: object
type: array
volumeMounts:
- description: |-
- Pod volumes to mount into the container's filesystem.
- Cannot be updated.
+ description: Pod volumes to mount into the container's
+ filesystem. Cannot be updated.
items:
description: VolumeMount describes a mounting of a
Volume within a container.
properties:
mountPath:
- description: |-
- Path within the container at which the volume should be mounted. Must
- not contain ':'.
+ description: Path within the container at which
+ the volume should be mounted. Must not contain
+ ':'.
type: string
mountPropagation:
- description: |-
- mountPropagation determines how mounts are propagated from the host
- to container and the other way around.
- When not set, MountPropagationNone is used.
- This field is beta in 1.10.
+ description: mountPropagation determines how mounts
+ are propagated from the host to container and
+ the other way around. When not set, MountPropagationNone
+ is used. This field is beta in 1.10.
type: string
name:
description: This must match the Name of a Volume.
type: string
readOnly:
- description: |-
- Mounted read-only if true, read-write otherwise (false or unspecified).
- Defaults to false.
+ description: Mounted read-only if true, read-write
+ otherwise (false or unspecified). Defaults to
+ false.
type: boolean
subPath:
- description: |-
- Path within the volume from which the container's volume should be mounted.
- Defaults to "" (volume's root).
+ description: Path within the volume from which
+ the container's volume should be mounted. Defaults
+ to "" (volume's root).
type: string
subPathExpr:
- description: |-
- Expanded path within the volume from which the container's volume should be mounted.
- Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.
- Defaults to "" (volume's root).
- SubPathExpr and SubPath are mutually exclusive.
+ description: Expanded path within the volume from
+ which the container's volume should be mounted.
+ Behaves similarly to SubPath but environment
+ variable references $(VAR_NAME) are expanded
+ using the container's environment. Defaults
+ to "" (volume's root). SubPathExpr and SubPath
+ are mutually exclusive.
type: string
required:
- mountPath
@@ -15632,11 +15537,10 @@ spec:
type: object
type: array
workingDir:
- description: |-
- Container's working directory.
- If not specified, the container runtime's default will be used, which
- might be configured in the container image.
- Cannot be updated.
+ description: Container's working directory. If not specified,
+ the container runtime's default will be used, which
+ might be configured in the container image. Cannot
+ be updated.
type: string
required:
- name
@@ -15654,68 +15558,66 @@ spec:
description: 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.
- Note that this field cannot be set when spec.os.name is windows.
+ description: "A special supplemental group that applies
+ to all containers in a pod. Some volume types allow
+ the Kubelet to change the ownership of that volume to
+ be owned by the pod: \n 1. The owning GID will be the
+ FSGroup 2. The setgid bit is set (new files created
+ in the volume will be owned by FSGroup) 3. The permission
+ bits are OR'd with rw-rw---- \n If unset, the Kubelet
+ will not modify the ownership and permissions of any
+ volume. Note that this field cannot be set when spec.os.name
+ is windows."
format: int64
type: integer
fsGroupChangePolicy:
- description: |-
- fsGroupChangePolicy defines behavior of changing ownership and permission of the volume
- before being exposed inside Pod. This field will only apply to
- volume types which support fsGroup based ownership(and permissions).
- It will have no effect on ephemeral volume types such as: secret, configmaps
- and emptydir.
- Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used.
- Note that this field cannot be set when spec.os.name is windows.
+ description: 'fsGroupChangePolicy defines behavior of
+ changing ownership and permission of the volume before
+ being exposed inside Pod. This field will only apply
+ to volume types which support fsGroup based ownership(and
+ permissions). It will have no effect on ephemeral volume
+ types such as: secret, configmaps and emptydir. Valid
+ values are "OnRootMismatch" and "Always". If not specified,
+ "Always" is used. Note that this field cannot be set
+ when spec.os.name is windows.'
type: string
runAsGroup:
- description: |-
- The GID to run the entrypoint of the container process.
- Uses runtime default if unset.
- May also be set in SecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence
- for that container.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The GID to run the entrypoint of the container
+ process. Uses runtime default if unset. May also be
+ set in SecurityContext. If set in both SecurityContext
+ and PodSecurityContext, the value specified in SecurityContext
+ takes precedence for that container. Note that this
+ field cannot be set when spec.os.name is windows.
format: int64
type: integer
runAsNonRoot:
- description: |-
- Indicates that the container must run as a non-root user.
- If true, the Kubelet will validate the image at runtime to ensure that it
- does not run as UID 0 (root) and fail to start the container if it does.
- If unset or false, no such validation will be performed.
- May also be set in SecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: Indicates that the container must run as
+ a non-root user. If true, the Kubelet will validate
+ the image at runtime to ensure that it does not run
+ as UID 0 (root) and fail to start the container if it
+ does. If unset or false, no such validation will be
+ performed. May also be set in SecurityContext. If set
+ in both SecurityContext and PodSecurityContext, the
+ value specified in SecurityContext takes precedence.
type: boolean
runAsUser:
- description: |-
- The UID to run the entrypoint of the container process.
- Defaults to user specified in image metadata if unspecified.
- May also be set in SecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence
- for that container.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The UID to run the entrypoint of the container
+ process. Defaults to user specified in image metadata
+ if unspecified. May also be set in SecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence
+ for that container. Note that this field cannot be set
+ when spec.os.name is windows.
format: int64
type: integer
seLinuxOptions:
- description: |-
- The SELinux context to be applied to all containers.
- If unspecified, the container runtime will allocate a random SELinux context for each
- container. May also be set in SecurityContext. If set in
- both SecurityContext and PodSecurityContext, the value specified in SecurityContext
- takes precedence for that container.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The SELinux context to be applied to all
+ containers. If unspecified, the container runtime will
+ allocate a random SELinux context for each container. May
+ also be set in SecurityContext. If set in both SecurityContext
+ and PodSecurityContext, the value specified in SecurityContext
+ takes precedence for that container. Note that this
+ field cannot be set when spec.os.name is windows.
properties:
level:
description: Level is SELinux level label that applies
@@ -15735,48 +15637,50 @@ spec:
type: string
type: object
seccompProfile:
- description: |-
- The seccomp options to use by the containers in this pod.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The seccomp options to use by the containers
+ in this pod. Note that this field cannot be set when
+ spec.os.name is windows.
properties:
localhostProfile:
- description: |-
- localhostProfile indicates a profile defined in a file on the node should be used.
- The profile must be preconfigured on the node to work.
- Must be a descending path, relative to the kubelet's configured seccomp profile location.
- Must be set if type is "Localhost". Must NOT be set for any other type.
+ description: localhostProfile indicates a profile
+ defined in a file on the node should be used. The
+ profile must be preconfigured on the node to work.
+ Must be a descending path, relative to the kubelet's
+ configured seccomp profile location. Must be set
+ if type is "Localhost". Must NOT be set for any
+ other type.
type: string
type:
- description: |-
- type indicates which kind of seccomp profile will be applied.
- Valid options are:
-
-
- Localhost - a profile defined in a file on the node should be used.
- RuntimeDefault - the container runtime default profile should be used.
- Unconfined - no profile should be applied.
+ description: "type indicates which kind of seccomp
+ profile will be applied. Valid options are: \n Localhost
+ - a profile defined in a file on the node should
+ be used. RuntimeDefault - the container runtime
+ default profile should be used. Unconfined - no
+ profile should be applied."
type: string
required:
- type
type: object
supplementalGroups:
- description: |-
- A list of groups applied to the first process run in each container, in addition
- to the container's primary GID, the fsGroup (if specified), and group memberships
- defined in the container image for the uid of the container process. If unspecified,
- no additional groups are added to any container. Note that group memberships
- defined in the container image for the uid of the container process are still effective,
- even if they are not included in this list.
- Note that this field cannot be set when spec.os.name is windows.
+ description: A list of groups applied to the first process
+ run in each container, in addition to the container's
+ primary GID, the fsGroup (if specified), and group memberships
+ defined in the container image for the uid of the container
+ process. If unspecified, no additional groups are added
+ to any container. Note that group memberships defined
+ in the container image for the uid of the container
+ process are still effective, even if they are not included
+ in this list. Note that this field cannot be set when
+ spec.os.name is windows.
items:
format: int64
type: integer
type: array
sysctls:
- description: |-
- Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported
- sysctls (by the container runtime) might fail to launch.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Sysctls hold a list of namespaced sysctls
+ used for the pod. Pods with unsupported sysctls (by
+ the container runtime) might fail to launch. Note that
+ this field cannot be set when spec.os.name is windows.
items:
description: Sysctl defines a kernel parameter to be
set
@@ -15793,35 +15697,39 @@ spec:
type: object
type: array
windowsOptions:
- description: |-
- The Windows specific settings applied to all containers.
- If unspecified, the options within a container's SecurityContext will be used.
- If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is linux.
+ description: The Windows specific settings applied to
+ all containers. If unspecified, the options within a
+ container's SecurityContext will be used. If set in
+ both SecurityContext and PodSecurityContext, the value
+ specified in SecurityContext takes precedence. Note
+ that this field cannot be set when spec.os.name is linux.
properties:
gmsaCredentialSpec:
- description: |-
- GMSACredentialSpec is where the GMSA admission webhook
- (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
- GMSA credential spec named by the GMSACredentialSpecName field.
+ description: GMSACredentialSpec is where the GMSA
+ admission webhook (https://github.com/kubernetes-sigs/windows-gmsa)
+ inlines the contents of the GMSA credential spec
+ named by the GMSACredentialSpecName field.
type: string
gmsaCredentialSpecName:
description: GMSACredentialSpecName is the name of
the GMSA credential spec to use.
type: string
hostProcess:
- description: |-
- HostProcess determines if a container should be run as a 'Host Process' container.
- All of a Pod's containers must have the same effective HostProcess value
- (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
- In addition, if HostProcess is true then HostNetwork must also be set to true.
+ description: HostProcess determines if a container
+ should be run as a 'Host Process' container. All
+ of a Pod's containers must have the same effective
+ HostProcess value (it is not allowed to have a mix
+ of HostProcess containers and non-HostProcess containers).
+ In addition, if HostProcess is true then HostNetwork
+ must also be set to true.
type: boolean
runAsUserName:
- description: |-
- The UserName in Windows to run the entrypoint of the container process.
- Defaults to the user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: The UserName in Windows to run the entrypoint
+ of the container process. Defaults to the user specified
+ in image metadata if unspecified. May also be set
+ in PodSecurityContext. If set in both SecurityContext
+ and PodSecurityContext, the value specified in SecurityContext
+ takes precedence.
type: string
type: object
type: object
@@ -15836,34 +15744,35 @@ spec:
matching pods among the given topology.
properties:
labelSelector:
- description: |-
- LabelSelector is used to find matching pods.
- Pods that match this label selector are counted to determine the number of pods
- in their corresponding topology domain.
+ description: LabelSelector is used to find matching
+ pods. Pods that match this label selector are counted
+ to determine the number of pods in their corresponding
+ topology domain.
properties:
matchExpressions:
description: matchExpressions is a list of label
selector requirements. The requirements are ANDed.
items:
- description: |-
- A label selector requirement is a selector that contains values, a key, and an operator that
- relates the key and values.
+ description: A label selector requirement is a
+ selector that contains values, a key, and an
+ operator that relates the key and values.
properties:
key:
description: key is the label key that the
selector applies to.
type: string
operator:
- description: |-
- operator represents a key's relationship to a set of values.
- Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents a key's relationship
+ to a set of values. Valid operators are
+ In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: |-
- values is an array of string values. If the operator is In or NotIn,
- the values array must be non-empty. If the operator is Exists or DoesNotExist,
- the values array must be empty. This array is replaced during a strategic
- merge patch.
+ description: values is an array of string
+ values. If the operator is In or NotIn,
+ the values array must be non-empty. If the
+ operator is Exists or DoesNotExist, the
+ values array must be empty. This array is
+ replaced during a strategic merge patch.
items:
type: string
type: array
@@ -15875,134 +15784,138 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: |-
- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions, whose key field is "key", the
- operator is "In", and the values array contains only "value". The requirements are ANDed.
+ description: matchLabels is a map of {key,value}
+ pairs. A single {key,value} in the matchLabels
+ map is equivalent to an element of matchExpressions,
+ whose key field is "key", the operator is "In",
+ and the values array contains only "value". The
+ requirements are ANDed.
type: object
type: object
- x-kubernetes-map-type: atomic
matchLabelKeys:
- description: |-
- MatchLabelKeys is a set of pod label keys to select the pods over which
- spreading will be calculated. The keys are used to lookup values from the
- incoming pod labels, those key-value labels are ANDed with labelSelector
- to select the group of existing pods over which spreading will be calculated
- for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.
- MatchLabelKeys cannot be set when LabelSelector isn't set.
- Keys that don't exist in the incoming pod labels will
- be ignored. A null or empty list means only match against labelSelector.
-
-
- This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).
+ description: "MatchLabelKeys is a set of pod label keys
+ to select the pods over which spreading will be calculated.
+ The keys are used to lookup values from the incoming
+ pod labels, those key-value labels are ANDed with
+ labelSelector to select the group of existing pods
+ over which spreading will be calculated for the incoming
+ pod. The same key is forbidden to exist in both MatchLabelKeys
+ and LabelSelector. MatchLabelKeys cannot be set when
+ LabelSelector isn't set. Keys that don't exist in
+ the incoming pod labels will be ignored. A null or
+ empty list means only match against labelSelector.
+ \n This is a beta field and requires the MatchLabelKeysInPodTopologySpread
+ feature gate to be enabled (enabled by default)."
items:
type: string
type: array
x-kubernetes-list-type: atomic
maxSkew:
- description: |-
- MaxSkew describes the degree to which pods may be unevenly distributed.
- When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference
- between the number of matching pods in the target topology and the global minimum.
- The global minimum is the minimum number of matching pods in an eligible domain
- or zero if the number of eligible domains is less than MinDomains.
- For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same
- labelSelector spread as 2/2/1:
- In this case, the global minimum is 1.
- | zone1 | zone2 | zone3 |
- | P P | P P | P |
- - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2;
- scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2)
- violate MaxSkew(1).
- - if MaxSkew is 2, incoming pod can be scheduled onto any zone.
- When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence
- to topologies that satisfy it.
- It's a required field. Default value is 1 and 0 is not allowed.
+ description: 'MaxSkew describes the degree to which
+ pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`,
+ it is the maximum permitted difference between the
+ number of matching pods in the target topology and
+ the global minimum. The global minimum is the minimum
+ number of matching pods in an eligible domain or zero
+ if the number of eligible domains is less than MinDomains.
+ For example, in a 3-zone cluster, MaxSkew is set to
+ 1, and pods with the same labelSelector spread as
+ 2/2/1: In this case, the global minimum is 1. | zone1
+ | zone2 | zone3 | | P P | P P | P | - if MaxSkew
+ is 1, incoming pod can only be scheduled to zone3
+ to become 2/2/2; scheduling it onto zone1(zone2) would
+ make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1).
+ - if MaxSkew is 2, incoming pod can be scheduled onto
+ any zone. When `whenUnsatisfiable=ScheduleAnyway`,
+ it is used to give higher precedence to topologies
+ that satisfy it. It''s a required field. Default value
+ is 1 and 0 is not allowed.'
format: int32
type: integer
minDomains:
- description: |-
- MinDomains indicates a minimum number of eligible domains.
- When the number of eligible domains with matching topology keys is less than minDomains,
- Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed.
- And when the number of eligible domains with matching topology keys equals or greater than minDomains,
- this value has no effect on scheduling.
- As a result, when the number of eligible domains is less than minDomains,
- scheduler won't schedule more than maxSkew Pods to those domains.
- If value is nil, the constraint behaves as if MinDomains is equal to 1.
- Valid values are integers greater than 0.
- When value is not nil, WhenUnsatisfiable must be DoNotSchedule.
-
-
- For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same
- labelSelector spread as 2/2/2:
- | zone1 | zone2 | zone3 |
- | P P | P P | P P |
- The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0.
- In this situation, new pod with the same labelSelector cannot be scheduled,
- because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones,
- it will violate MaxSkew.
-
-
- This is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default).
+ description: "MinDomains indicates a minimum number
+ of eligible domains. When the number of eligible domains
+ with matching topology keys is less than minDomains,
+ Pod Topology Spread treats \"global minimum\" as 0,
+ and then the calculation of Skew is performed. And
+ when the number of eligible domains with matching
+ topology keys equals or greater than minDomains, this
+ value has no effect on scheduling. As a result, when
+ the number of eligible domains is less than minDomains,
+ scheduler won't schedule more than maxSkew Pods to
+ those domains. If value is nil, the constraint behaves
+ as if MinDomains is equal to 1. Valid values are integers
+ greater than 0. When value is not nil, WhenUnsatisfiable
+ must be DoNotSchedule. \n For example, in a 3-zone
+ cluster, MaxSkew is set to 2, MinDomains is set to
+ 5 and pods with the same labelSelector spread as 2/2/2:
+ | zone1 | zone2 | zone3 | | P P | P P | P P |
+ The number of domains is less than 5(MinDomains),
+ so \"global minimum\" is treated as 0. In this situation,
+ new pod with the same labelSelector cannot be scheduled,
+ because computed skew will be 3(3 - 0) if new Pod
+ is scheduled to any of the three zones, it will violate
+ MaxSkew. \n This is a beta field and requires the
+ MinDomainsInPodTopologySpread feature gate to be enabled
+ (enabled by default)."
format: int32
type: integer
nodeAffinityPolicy:
- description: |-
- NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector
- when calculating pod topology spread skew. Options are:
- - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations.
- - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.
-
-
- If this value is nil, the behavior is equivalent to the Honor policy.
- This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
+ description: "NodeAffinityPolicy indicates how we will
+ treat Pod's nodeAffinity/nodeSelector when calculating
+ pod topology spread skew. Options are: - Honor: only
+ nodes matching nodeAffinity/nodeSelector are included
+ in the calculations. - Ignore: nodeAffinity/nodeSelector
+ are ignored. All nodes are included in the calculations.
+ \n If this value is nil, the behavior is equivalent
+ to the Honor policy. This is a beta-level feature
+ default enabled by the NodeInclusionPolicyInPodTopologySpread
+ feature flag."
type: string
nodeTaintsPolicy:
- description: |-
- NodeTaintsPolicy indicates how we will treat node taints when calculating
- pod topology spread skew. Options are:
- - Honor: nodes without taints, along with tainted nodes for which the incoming pod
- has a toleration, are included.
- - Ignore: node taints are ignored. All nodes are included.
-
-
- If this value is nil, the behavior is equivalent to the Ignore policy.
- This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
+ description: "NodeTaintsPolicy indicates how we will
+ treat node taints when calculating pod topology spread
+ skew. Options are: - Honor: nodes without taints,
+ along with tainted nodes for which the incoming pod
+ has a toleration, are included. - Ignore: node taints
+ are ignored. All nodes are included. \n If this value
+ is nil, the behavior is equivalent to the Ignore policy.
+ This is a beta-level feature default enabled by the
+ NodeInclusionPolicyInPodTopologySpread feature flag."
type: string
topologyKey:
- description: |-
- TopologyKey is the key of node labels. Nodes that have a label with this key
- and identical values are considered to be in the same topology.
- We consider each as a "bucket", and try to put balanced number
- of pods into each bucket.
- We define a domain as a particular instance of a topology.
- Also, we define an eligible domain as a domain whose nodes meet the requirements of
- nodeAffinityPolicy and nodeTaintsPolicy.
- e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology.
- And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology.
- It's a required field.
+ description: TopologyKey is the key of node labels.
+ Nodes that have a label with this key and identical
+ values are considered to be in the same topology.
+ We consider each as a "bucket", and try
+ to put balanced number of pods into each bucket. We
+ define a domain as a particular instance of a topology.
+ Also, we define an eligible domain as a domain whose
+ nodes meet the requirements of nodeAffinityPolicy
+ and nodeTaintsPolicy. e.g. If TopologyKey is "kubernetes.io/hostname",
+ each Node is a domain of that topology. And, if TopologyKey
+ is "topology.kubernetes.io/zone", each zone is a domain
+ of that topology. It's a required field.
type: string
whenUnsatisfiable:
- description: |-
- WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy
- the spread constraint.
- - DoNotSchedule (default) tells the scheduler not to schedule it.
- - ScheduleAnyway tells the scheduler to schedule the pod in any location,
- but giving higher precedence to topologies that would help reduce the
- skew.
- A constraint is considered "Unsatisfiable" for an incoming pod
- if and only if every possible node assignment for that pod would violate
- "MaxSkew" on some topology.
- For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same
- labelSelector spread as 3/1/1:
- | zone1 | zone2 | zone3 |
- | P P P | P | P |
- If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled
- to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies
- MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler
- won't make it *more* imbalanced.
- It's a required field.
+ description: 'WhenUnsatisfiable indicates how to deal
+ with a pod if it doesn''t satisfy the spread constraint.
+ - DoNotSchedule (default) tells the scheduler not
+ to schedule it. - ScheduleAnyway tells the scheduler
+ to schedule the pod in any location, but giving
+ higher precedence to topologies that would help reduce
+ the skew. A constraint is considered "Unsatisfiable"
+ for an incoming pod if and only if every possible
+ node assignment for that pod would violate "MaxSkew"
+ on some topology. For example, in a 3-zone cluster,
+ MaxSkew is set to 1, and pods with the same labelSelector
+ spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P
+ | P | P | If WhenUnsatisfiable is set to DoNotSchedule,
+ incoming pod can only be scheduled to zone2(zone3)
+ to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3)
+ satisfies MaxSkew(1). In other words, the cluster
+ can still be imbalanced, but scheduler won''t make
+ it *more* imbalanced. It''s a required field.'
type: string
required:
- maxSkew
@@ -16017,36 +15930,37 @@ spec:
may be accessed by any container in the pod.
properties:
awsElasticBlockStore:
- description: |-
- awsElasticBlockStore represents an AWS Disk resource that is attached to a
- kubelet's host machine and then exposed to the pod.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ description: 'awsElasticBlockStore represents an AWS
+ Disk resource that is attached to a kubelet''s host
+ machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
properties:
fsType:
- description: |-
- fsType is the filesystem type of the volume that you want to mount.
- Tip: Ensure that the filesystem type is supported by the host operating system.
- Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
- TODO: how do we prevent errors in the filesystem from compromising the machine
+ description: 'fsType is the filesystem type of the
+ volume that you want to mount. Tip: Ensure that
+ the filesystem type is supported by the host operating
+ system. Examples: "ext4", "xfs", "ntfs". Implicitly
+ inferred to be "ext4" if unspecified. More info:
+ https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
partition:
- description: |-
- partition is the partition in the volume that you want to mount.
- If omitted, the default is to mount by volume name.
- Examples: For volume /dev/sda1, you specify the partition as "1".
- Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
+ description: 'partition is the partition in the
+ volume that you want to mount. If omitted, the
+ default is to mount by volume name. Examples:
+ For volume /dev/sda1, you specify the partition
+ as "1". Similarly, the volume partition for /dev/sda
+ is "0" (or you can leave the property empty).'
format: int32
type: integer
readOnly:
- description: |-
- readOnly value true will force the readOnly setting in VolumeMounts.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ description: 'readOnly value true will force the
+ readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
type: boolean
volumeID:
- description: |-
- volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume).
- More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ description: 'volumeID is unique ID of the persistent
+ disk resource in AWS (Amazon EBS volume). More
+ info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
type: string
required:
- volumeID
@@ -16068,10 +15982,10 @@ spec:
the blob storage
type: string
fsType:
- description: |-
- fsType is Filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: fsType is Filesystem type to mount.
+ Must be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs". Implicitly
+ inferred to be "ext4" if unspecified.
type: string
kind:
description: 'kind expected values are Shared: multiple
@@ -16081,9 +15995,9 @@ spec:
set). defaults to shared'
type: string
readOnly:
- description: |-
- readOnly Defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: readOnly Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
required:
- diskName
@@ -16094,9 +16008,9 @@ spec:
mount on the host and bind mount to the pod.
properties:
readOnly:
- description: |-
- readOnly defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: readOnly defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
secretName:
description: secretName is the name of secret that
@@ -16114,9 +16028,8 @@ spec:
host that shares a pod's lifetime
properties:
monitors:
- description: |-
- monitors is Required: Monitors is a collection of Ceph monitors
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ description: 'monitors is Required: Monitors is
+ a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
items:
type: string
type: array
@@ -16126,72 +16039,65 @@ spec:
is /'
type: string
readOnly:
- description: |-
- readOnly is Optional: Defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ description: 'readOnly is Optional: Defaults to
+ false (read/write). ReadOnly here will force the
+ ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
type: boolean
secretFile:
- description: |-
- secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ description: 'secretFile is Optional: SecretFile
+ is the path to key ring for User, default is /etc/ceph/user.secret
+ More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
type: string
secretRef:
- description: |-
- secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty.
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ description: 'secretRef is Optional: SecretRef is
+ reference to the authentication secret for User,
+ default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
user:
- description: |-
- user is optional: User is the rados user name, default is admin
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ description: 'user is optional: User is the rados
+ user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
type: string
required:
- monitors
type: object
cinder:
- description: |-
- cinder represents a cinder volume attached and mounted on kubelets host machine.
- More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ description: 'cinder represents a cinder volume attached
+ and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
properties:
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ description: 'fsType is the filesystem type to mount.
+ Must be a filesystem type supported by the host
+ operating system. Examples: "ext4", "xfs", "ntfs".
+ Implicitly inferred to be "ext4" if unspecified.
+ More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
type: string
readOnly:
- description: |-
- readOnly defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
- More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ description: 'readOnly defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
type: boolean
secretRef:
- description: |-
- secretRef is optional: points to a secret object containing parameters used to connect
- to OpenStack.
+ description: 'secretRef is optional: points to a
+ secret object containing parameters used to connect
+ to OpenStack.'
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
volumeID:
- description: |-
- volumeID used to identify the volume in cinder.
- More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ description: 'volumeID used to identify the volume
+ in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
type: string
required:
- volumeID
@@ -16201,25 +16107,30 @@ spec:
populate this volume
properties:
defaultMode:
- description: |-
- defaultMode is optional: mode bits used to set permissions on created files by default.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- Defaults to 0644.
- Directories within the path are not affected by this setting.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'defaultMode is optional: mode bits
+ used to set permissions on created files by default.
+ Must be an octal value between 0000 and 0777 or
+ a decimal value between 0 and 511. YAML accepts
+ both octal and decimal values, JSON requires decimal
+ values for mode bits. Defaults to 0644. Directories
+ within the path are not affected by this setting.
+ This might be in conflict with other options that
+ affect the file mode, like fsGroup, and the result
+ can be other mode bits set.'
format: int32
type: integer
items:
- description: |-
- items if unspecified, each key-value pair in the Data field of the referenced
- ConfigMap will be projected into the volume as a file whose name is the
- key and content is the value. If specified, the listed keys will be
- projected into the specified paths, and unlisted keys will not be
- present. If a key is specified which is not present in the ConfigMap,
- the volume setup will error unless it is marked optional. Paths must be
- relative and may not contain the '..' path or start with '..'.
+ description: items if unspecified, each key-value
+ pair in the Data field of the referenced ConfigMap
+ will be projected into the volume as a file whose
+ name is the key and content is the value. If specified,
+ the listed keys will be projected into the specified
+ paths, and unlisted keys will not be present.
+ If a key is specified which is not present in
+ the ConfigMap, the volume setup will error unless
+ it is marked optional. Paths must be relative
+ and may not contain the '..' path or start with
+ '..'.
items:
description: Maps a string key to a path within
a volume.
@@ -16228,21 +16139,25 @@ spec:
description: key is the key to project.
type: string
mode:
- description: |-
- mode is Optional: mode bits used to set permissions on this file.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'mode is Optional: mode bits
+ used to set permissions on this file. Must
+ be an octal value between 0000 and 0777
+ or a decimal value between 0 and 511. YAML
+ accepts both octal and decimal values, JSON
+ requires decimal values for mode bits. If
+ not specified, the volume defaultMode will
+ be used. This might be in conflict with
+ other options that affect the file mode,
+ like fsGroup, and the result can be other
+ mode bits set.'
format: int32
type: integer
path:
- description: |-
- path is the relative path of the file to map the key to.
- May not be an absolute path.
- May not contain the path element '..'.
- May not start with the string '..'.
+ description: path is the relative path of
+ the file to map the key to. May not be an
+ absolute path. May not contain the path
+ element '..'. May not start with the string
+ '..'.
type: string
required:
- key
@@ -16250,60 +16165,59 @@ spec:
type: object
type: array
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: optional specify whether the ConfigMap
or its keys must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
csi:
description: csi (Container Storage Interface) represents
ephemeral storage that is handled by certain external
CSI drivers (Beta feature).
properties:
driver:
- description: |-
- driver is the name of the CSI driver that handles this volume.
- Consult with your admin for the correct name as registered in the cluster.
+ description: driver is the name of the CSI driver
+ that handles this volume. Consult with your admin
+ for the correct name as registered in the cluster.
type: string
fsType:
- description: |-
- fsType to mount. Ex. "ext4", "xfs", "ntfs".
- If not provided, the empty value is passed to the associated CSI driver
- which will determine the default filesystem to apply.
+ description: fsType to mount. Ex. "ext4", "xfs",
+ "ntfs". If not provided, the empty value is passed
+ to the associated CSI driver which will determine
+ the default filesystem to apply.
type: string
nodePublishSecretRef:
- description: |-
- nodePublishSecretRef is a reference to the secret object containing
- sensitive information to pass to the CSI driver to complete the CSI
+ 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.
+ This field is optional, and may be empty if no
+ secret is required. If the secret object contains
+ more than one secret, all secret references are
+ passed.
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
readOnly:
- description: |-
- readOnly specifies a read-only configuration for the volume.
- Defaults to false (read/write).
+ description: readOnly specifies a read-only configuration
+ for the volume. Defaults to false (read/write).
type: boolean
volumeAttributes:
additionalProperties:
type: string
- description: |-
- volumeAttributes stores driver-specific properties that are passed to the CSI
- driver. Consult your driver's documentation for supported values.
+ description: volumeAttributes stores driver-specific
+ properties that are passed to the CSI driver.
+ Consult your driver's documentation for supported
+ values.
type: object
required:
- driver
@@ -16313,15 +16227,17 @@ spec:
the pod that should populate this volume
properties:
defaultMode:
- description: |-
- Optional: mode bits to use on created files by default. Must be a
- Optional: mode bits used to set permissions on created files by default.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- Defaults to 0644.
- Directories within the path are not affected by this setting.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'Optional: mode bits to use on created
+ files by default. Must be a Optional: mode bits
+ used to set permissions on created files by default.
+ Must be an octal value between 0000 and 0777 or
+ a decimal value between 0 and 511. YAML accepts
+ both octal and decimal values, JSON requires decimal
+ values for mode bits. Defaults to 0644. Directories
+ within the path are not affected by this setting.
+ This might be in conflict with other options that
+ affect the file mode, like fsGroup, and the result
+ can be other mode bits set.'
format: int32
type: integer
items:
@@ -16349,15 +16265,17 @@ spec:
required:
- fieldPath
type: object
- x-kubernetes-map-type: atomic
mode:
- description: |-
- Optional: mode bits used to set permissions on this file, must be an octal value
- between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'Optional: mode bits used to
+ set permissions on this file, must be an
+ octal value between 0000 and 0777 or a decimal
+ value between 0 and 511. YAML accepts both
+ octal and decimal values, JSON requires
+ decimal values for mode bits. If not specified,
+ the volume defaultMode will be used. This
+ might be in conflict with other options
+ that affect the file mode, like fsGroup,
+ and the result can be other mode bits set.'
format: int32
type: integer
path:
@@ -16368,9 +16286,10 @@ spec:
the relative path must not start with ''..'''
type: string
resourceFieldRef:
- description: |-
- Selects a resource of the container: only resources limits and requests
- (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
+ description: 'Selects a resource of the container:
+ only resources limits and requests (limits.cpu,
+ limits.memory, requests.cpu and requests.memory)
+ are currently supported.'
properties:
containerName:
description: 'Container name: required
@@ -16391,132 +16310,128 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
required:
- path
type: object
type: array
type: object
emptyDir:
- description: |-
- emptyDir represents a temporary directory that shares a pod's lifetime.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
+ description: 'emptyDir represents a temporary directory
+ that shares a pod''s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
properties:
medium:
- description: |-
- medium represents what type of storage medium should back this directory.
- The default is "" which means to use the node's default medium.
- Must be an empty string (default) or Memory.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
+ description: 'medium represents what type of storage
+ medium should back this directory. The default
+ is "" which means to use the node''s default medium.
+ Must be an empty string (default) or Memory. More
+ info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
type: string
sizeLimit:
anyOf:
- type: integer
- type: string
- description: |-
- sizeLimit is the total amount of local storage required for this EmptyDir volume.
- The size limit is also applicable for memory medium.
- The maximum usage on memory medium EmptyDir would be the minimum value between
- the SizeLimit specified here and the sum of memory limits of all containers in a pod.
- The default is nil which means that the limit is undefined.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
+ description: 'sizeLimit is the total amount of local
+ storage required for this EmptyDir volume. The
+ size limit is also applicable for memory medium.
+ The maximum usage on memory medium EmptyDir would
+ be the minimum value between the SizeLimit specified
+ here and the sum of memory limits of all containers
+ in a pod. The default is nil which means that
+ the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
type: object
ephemeral:
- description: |-
- ephemeral represents a volume that is handled by a cluster storage driver.
- The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts,
- and deleted when the pod is removed.
-
-
- Use this if:
- a) the volume is only needed while the pod runs,
- b) features of normal volumes like restoring from snapshot or capacity
- tracking are needed,
- c) the storage driver is specified through a storage class, and
- d) the storage driver supports dynamic volume provisioning through
- a PersistentVolumeClaim (see EphemeralVolumeSource for more
- information on the connection between this volume type
- and PersistentVolumeClaim).
-
-
+ description: "ephemeral represents a volume that is
+ handled by a cluster storage driver. The volume's
+ lifecycle is tied to the pod that defines it - it
+ will be created before the pod starts, and deleted
+ when the pod is removed. \n Use this if: a) the volume
+ is only needed while the pod runs, b) features of
+ normal volumes like restoring from snapshot or capacity
+ \ tracking are needed, c) the storage driver is
+ specified through a storage class, and d) the storage
+ driver supports dynamic volume provisioning through
+ \ a PersistentVolumeClaim (see EphemeralVolumeSource
+ for more information on the connection between
+ this volume type and PersistentVolumeClaim). \n
Use PersistentVolumeClaim or one of the vendor-specific
- APIs for volumes that persist for longer than the lifecycle
- of an individual pod.
-
-
- Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to
- be used that way - see the documentation of the driver for
- more information.
-
-
- A pod can use both types of ephemeral volumes and
- persistent volumes at the same time.
+ APIs for volumes that persist for longer than the
+ lifecycle of an individual pod. \n Use CSI for light-weight
+ local ephemeral volumes if the CSI driver is meant
+ to be used that way - see the documentation of the
+ driver for more information. \n A pod can use both
+ types of ephemeral volumes and persistent volumes
+ at the same time."
properties:
volumeClaimTemplate:
- description: |-
- Will be used to create a stand-alone PVC to provision the volume.
- The pod in which this EphemeralVolumeSource is embedded will be the
- owner of the PVC, i.e. the PVC will be deleted together with the
- pod. The name of the PVC will be `-` where
- `` is the name from the `PodSpec.Volumes` array
- entry. Pod validation will reject the pod if the concatenated name
- is not valid for a PVC (for example, too long).
-
-
- An existing PVC with that name that is not owned by the pod
- will *not* be used for the pod to avoid using an unrelated
- volume by mistake. Starting the pod is then blocked until
- the unrelated PVC is removed. If such a pre-created PVC is
- meant to be used by the pod, the PVC has to updated with an
- owner reference to the pod once the pod exists. Normally
- this should not be necessary, but it may be useful when
- manually reconstructing a broken cluster.
-
-
- This field is read-only and no changes will be made by Kubernetes
- to the PVC after it has been created.
-
-
- Required, must not be nil.
+ description: "Will be used to create a stand-alone
+ PVC to provision the volume. The pod in which
+ this EphemeralVolumeSource is embedded will be
+ the owner of the PVC, i.e. the PVC will be deleted
+ together with the pod. The name of the PVC will
+ be `-` where ``
+ is the name from the `PodSpec.Volumes` array entry.
+ Pod validation will reject the pod if the concatenated
+ name is not valid for a PVC (for example, too
+ long). \n An existing PVC with that name that
+ is not owned by the pod will *not* be used for
+ the pod to avoid using an unrelated volume by
+ mistake. Starting the pod is then blocked until
+ the unrelated PVC is removed. If such a pre-created
+ PVC is meant to be used by the pod, the PVC has
+ to updated with an owner reference to the pod
+ once the pod exists. Normally this should not
+ be necessary, but it may be useful when manually
+ reconstructing a broken cluster. \n This field
+ is read-only and no changes will be made by Kubernetes
+ to the PVC after it has been created. \n Required,
+ must not be nil."
properties:
metadata:
- description: |-
- May contain labels and annotations that will be copied into the PVC
- when creating it. No other fields are allowed and will be rejected during
- validation.
+ description: May contain labels and annotations
+ that will be copied into the PVC when creating
+ it. No other fields are allowed and will be
+ rejected during validation.
type: object
spec:
- description: |-
- The specification for the PersistentVolumeClaim. The entire content is
- copied unchanged into the PVC that gets created from this
- template. The same fields as in a PersistentVolumeClaim
+ description: The specification for the PersistentVolumeClaim.
+ The entire content is copied unchanged into
+ the PVC that gets created from this template.
+ The same fields as in a PersistentVolumeClaim
are also valid here.
properties:
accessModes:
- description: |-
- accessModes contains the desired access modes the volume should have.
- More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
+ description: 'accessModes contains the desired
+ access modes the volume should have. More
+ info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
items:
type: string
type: array
dataSource:
- description: |-
- dataSource field can be used to specify either:
- * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
+ description: 'dataSource field can be used
+ to specify either: * An existing VolumeSnapshot
+ object (snapshot.storage.k8s.io/VolumeSnapshot)
* An existing PVC (PersistentVolumeClaim)
- If the provisioner or an external controller can support the specified data source,
- it will create a new volume based on the contents of the specified data source.
- When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,
- and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.
- If the namespace is specified, then dataSourceRef will not be copied to dataSource.
+ If the provisioner or an external controller
+ can support the specified data source,
+ it will create a new volume based on the
+ contents of the specified data source.
+ When the AnyVolumeDataSource feature gate
+ is enabled, dataSource contents will be
+ copied to dataSourceRef, and dataSourceRef
+ contents will be copied to dataSource
+ when dataSourceRef.namespace is not specified.
+ If the namespace is specified, then dataSourceRef
+ will not be copied to dataSource.'
properties:
apiGroup:
- description: |-
- APIGroup is the group for the resource being referenced.
- If APIGroup is not specified, the specified Kind must be in the core API group.
- For any other third-party types, APIGroup is required.
+ description: APIGroup is the group for
+ the resource being referenced. If
+ APIGroup is not specified, the specified
+ Kind must be in the core API group.
+ For any other third-party types, APIGroup
+ is required.
type: string
kind:
description: Kind is the type of resource
@@ -16530,38 +16445,51 @@ spec:
- kind
- name
type: object
- x-kubernetes-map-type: atomic
dataSourceRef:
- description: |-
- dataSourceRef specifies the object from which to populate the volume with data, if a non-empty
- volume is desired. This may be any object from a non-empty API group (non
- core object) or a PersistentVolumeClaim object.
- When this field is specified, volume binding will only succeed if the type of
- the specified object matches some installed volume populator or dynamic
- provisioner.
- This field will replace the functionality of the dataSource field and as such
- if both fields are non-empty, they must have the same value. For backwards
- compatibility, when namespace isn't specified in dataSourceRef,
- both fields (dataSource and dataSourceRef) will be set to the same
- value automatically if one of them is empty and the other is non-empty.
- When namespace is specified in dataSourceRef,
- dataSource isn't set to the same value and must be empty.
- There are three important differences between dataSource and dataSourceRef:
- * While dataSource only allows two specific types of objects, dataSourceRef
- allows any non-core object, as well as PersistentVolumeClaim objects.
- * While dataSource ignores disallowed values (dropping them), dataSourceRef
- preserves all values, and generates an error if a disallowed value is
- specified.
- * While dataSource only allows local objects, dataSourceRef allows objects
- in any namespaces.
- (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
- (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
+ description: 'dataSourceRef specifies the
+ object from which to populate the volume
+ with data, if a non-empty volume is desired.
+ This may be any object from a non-empty
+ API group (non core object) or a PersistentVolumeClaim
+ object. When this field is specified,
+ volume binding will only succeed if the
+ type of the specified object matches some
+ installed volume populator or dynamic
+ provisioner. This field will replace the
+ functionality of the dataSource field
+ and as such if both fields are non-empty,
+ they must have the same value. For backwards
+ compatibility, when namespace isn''t specified
+ in dataSourceRef, both fields (dataSource
+ and dataSourceRef) will be set to the
+ same value automatically if one of them
+ is empty and the other is non-empty. When
+ namespace is specified in dataSourceRef,
+ dataSource isn''t set to the same value
+ and must be empty. There are three important
+ differences between dataSource and dataSourceRef:
+ * While dataSource only allows two specific
+ types of objects, dataSourceRef allows
+ any non-core object, as well as PersistentVolumeClaim
+ objects. * While dataSource ignores disallowed
+ values (dropping them), dataSourceRef preserves
+ all values, and generates an error if
+ a disallowed value is specified. * While
+ dataSource only allows local objects,
+ dataSourceRef allows objects in any
+ namespaces. (Beta) Using this field requires
+ the AnyVolumeDataSource feature gate to
+ be enabled. (Alpha) Using the namespace
+ field of dataSourceRef requires the CrossNamespaceVolumeDataSource
+ feature gate to be enabled.'
properties:
apiGroup:
- description: |-
- APIGroup is the group for the resource being referenced.
- If APIGroup is not specified, the specified Kind must be in the core API group.
- For any other third-party types, APIGroup is required.
+ description: APIGroup is the group for
+ the resource being referenced. If
+ APIGroup is not specified, the specified
+ Kind must be in the core API group.
+ For any other third-party types, APIGroup
+ is required.
type: string
kind:
description: Kind is the type of resource
@@ -16572,22 +16500,31 @@ spec:
being referenced
type: string
namespace:
- description: |-
- Namespace is the namespace of resource being referenced
- Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.
- (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
+ description: Namespace is the namespace
+ of resource being referenced Note
+ that when a namespace is specified,
+ a gateway.networking.k8s.io/ReferenceGrant
+ object is required in the referent
+ namespace to allow that namespace's
+ owner to accept the reference. See
+ the ReferenceGrant documentation for
+ details. (Alpha) This field requires
+ the CrossNamespaceVolumeDataSource
+ feature gate to be enabled.
type: string
required:
- kind
- name
type: object
resources:
- description: |-
- resources represents the minimum resources the volume should have.
- If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements
- that are lower than previous value but must still be higher than capacity recorded in the
- status field of the claim.
- More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
+ description: 'resources represents the minimum
+ resources the volume should have. If RecoverVolumeExpansionFailure
+ feature is enabled users are allowed to
+ specify resource requirements that are
+ lower than previous value but must still
+ be higher than capacity recorded in the
+ status field of the claim. More info:
+ https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
properties:
limits:
additionalProperties:
@@ -16596,9 +16533,9 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Limits describes the maximum amount of compute resources allowed.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Limits describes the maximum
+ amount of compute resources allowed.
+ More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -16607,11 +16544,14 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Requests describes the minimum amount of compute resources required.
- If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
- otherwise to an implementation-defined value. Requests cannot exceed Limits.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Requests describes the
+ minimum amount of compute resources
+ required. If Requests is omitted for
+ a container, it defaults to Limits
+ if that is explicitly specified, otherwise
+ to an implementation-defined value.
+ Requests cannot exceed Limits. More
+ info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
selector:
@@ -16623,9 +16563,10 @@ spec:
of label selector requirements. The
requirements are ANDed.
items:
- description: |-
- A label selector requirement is a selector that contains values, a key, and an operator that
- relates the key and values.
+ description: A label selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
description: key is the label
@@ -16633,16 +16574,20 @@ spec:
to.
type: string
operator:
- description: |-
- operator represents a key's relationship to a set of values.
- Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents
+ a key's relationship to a set
+ of values. Valid operators are
+ In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: |-
- values is an array of string values. If the operator is In or NotIn,
- the values array must be non-empty. If the operator is Exists or DoesNotExist,
- the values array must be empty. This array is replaced during a strategic
- merge patch.
+ description: values is an array
+ of string values. If the operator
+ is In or NotIn, the values array
+ must be non-empty. If the operator
+ is Exists or DoesNotExist, the
+ values array must be empty.
+ This array is replaced during
+ a strategic merge patch.
items:
type: string
type: array
@@ -16654,37 +16599,52 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: |-
- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions, whose key field is "key", the
- operator is "In", and the values array contains only "value". The requirements are ANDed.
+ description: matchLabels is a map of
+ {key,value} pairs. A single {key,value}
+ in the matchLabels map is equivalent
+ to an element of matchExpressions,
+ whose key field is "key", the operator
+ is "In", and the values array contains
+ only "value". The requirements are
+ ANDed.
type: object
type: object
- x-kubernetes-map-type: atomic
storageClassName:
- description: |-
- storageClassName is the name of the StorageClass required by the claim.
- More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
+ description: 'storageClassName is the name
+ of the StorageClass required by the claim.
+ More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
type: string
volumeAttributesClassName:
- description: |-
- volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.
- If specified, the CSI driver will create or update the volume with the attributes defined
- in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,
- it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass
- will be applied to the claim but it's not allowed to reset this field to empty string once it is set.
- If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass
- will be set by the persistentvolume controller if it exists.
- If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be
- set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource
- exists.
- More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass
- (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.
+ description: 'volumeAttributesClassName
+ may be used to set the VolumeAttributesClass
+ used by this claim. If specified, the
+ CSI driver will create or update the volume
+ with the attributes defined in the corresponding
+ VolumeAttributesClass. This has a different
+ purpose than storageClassName, it can
+ be changed after the claim is created.
+ An empty string value means that no VolumeAttributesClass
+ will be applied to the claim but it''s
+ not allowed to reset this field to empty
+ string once it is set. If unspecified
+ and the PersistentVolumeClaim is unbound,
+ the default VolumeAttributesClass will
+ be set by the persistentvolume controller
+ if it exists. If the resource referred
+ to by volumeAttributesClass does not exist,
+ this PersistentVolumeClaim will be set
+ to a Pending state, as reflected by the
+ modifyVolumeStatus field, until such as
+ a resource exists. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass
+ (Alpha) Using this field requires the
+ VolumeAttributesClass feature gate to
+ be enabled.'
type: string
volumeMode:
- description: |-
- volumeMode defines what type of volume is required by the claim.
- Value of Filesystem is implied when not included in claim spec.
+ description: volumeMode defines what type
+ of volume is required by the claim. Value
+ of Filesystem is implied when not included
+ in claim spec.
type: string
volumeName:
description: volumeName is the binding reference
@@ -16701,20 +16661,21 @@ spec:
exposed to the pod.
properties:
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- TODO: how do we prevent errors in the filesystem from compromising the machine
+ description: 'fsType is the filesystem type to mount.
+ Must be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs". Implicitly
+ inferred to be "ext4" if unspecified. TODO: how
+ do we prevent errors in the filesystem from compromising
+ the machine'
type: string
lun:
description: 'lun is Optional: FC target lun number'
format: int32
type: integer
readOnly:
- description: |-
- readOnly is Optional: Defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: 'readOnly is Optional: Defaults to
+ false (read/write). ReadOnly here will force the
+ ReadOnly setting in VolumeMounts.'
type: boolean
targetWWNs:
description: 'targetWWNs is Optional: FC target
@@ -16723,27 +16684,28 @@ spec:
type: string
type: array
wwids:
- description: |-
- wwids Optional: FC volume world wide identifiers (wwids)
- Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
+ description: 'wwids Optional: FC volume world wide
+ identifiers (wwids) Either wwids or combination
+ of targetWWNs and lun must be set, but not both
+ simultaneously.'
items:
type: string
type: array
type: object
flexVolume:
- description: |-
- flexVolume represents a generic volume resource that is
- provisioned/attached using an exec based plugin.
+ description: flexVolume represents a generic volume
+ resource that is provisioned/attached using an exec
+ based plugin.
properties:
driver:
description: driver is the name of the driver to
use for this volume.
type: string
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
+ description: fsType is the filesystem type to mount.
+ Must be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs". The
+ default filesystem depends on FlexVolume script.
type: string
options:
additionalProperties:
@@ -16752,26 +16714,25 @@ spec:
extra command options if any.'
type: object
readOnly:
- description: |-
- readOnly is Optional: defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: 'readOnly is Optional: defaults to
+ false (read/write). ReadOnly here will force the
+ ReadOnly setting in VolumeMounts.'
type: boolean
secretRef:
- description: |-
- secretRef is Optional: secretRef is reference to the secret object containing
- sensitive information to pass to the plugin scripts. This may be
- empty if no secret object is specified. If the secret object
- contains more than one secret, all secrets are passed to the plugin
- scripts.
+ description: 'secretRef is Optional: secretRef is
+ reference to the secret object containing sensitive
+ information to pass to the plugin scripts. This
+ may be empty if no secret object is specified.
+ If the secret object contains more than one secret,
+ all secrets are passed to the plugin scripts.'
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
required:
- driver
type: object
@@ -16781,9 +16742,9 @@ spec:
control service being running
properties:
datasetName:
- description: |-
- datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker
- should be considered as deprecated
+ description: datasetName is Name of the dataset
+ stored as metadata -> name on the dataset for
+ Flocker should be considered as deprecated
type: string
datasetUUID:
description: datasetUUID is the UUID of the dataset.
@@ -16791,55 +16752,57 @@ spec:
type: string
type: object
gcePersistentDisk:
- description: |-
- gcePersistentDisk represents a GCE Disk resource that is attached to a
- kubelet's host machine and then exposed to the pod.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ description: 'gcePersistentDisk represents a GCE Disk
+ resource that is attached to a kubelet''s host machine
+ and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
properties:
fsType:
- description: |-
- fsType is filesystem type of the volume that you want to mount.
- Tip: Ensure that the filesystem type is supported by the host operating system.
- Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
- TODO: how do we prevent errors in the filesystem from compromising the machine
+ description: 'fsType is filesystem type of the volume
+ that you want to mount. Tip: Ensure that the filesystem
+ type is supported by the host operating system.
+ Examples: "ext4", "xfs", "ntfs". Implicitly inferred
+ to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
partition:
- description: |-
- partition is the partition in the volume that you want to mount.
- If omitted, the default is to mount by volume name.
- Examples: For volume /dev/sda1, you specify the partition as "1".
- Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ description: 'partition is the partition in the
+ volume that you want to mount. If omitted, the
+ default is to mount by volume name. Examples:
+ For volume /dev/sda1, you specify the partition
+ as "1". Similarly, the volume partition for /dev/sda
+ is "0" (or you can leave the property empty).
+ More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
format: int32
type: integer
pdName:
- description: |-
- pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ description: 'pdName is unique name of the PD resource
+ in GCE. Used to identify the disk in GCE. More
+ info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
type: string
readOnly:
- description: |-
- readOnly here will force the ReadOnly setting in VolumeMounts.
- Defaults to false.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ description: 'readOnly here will force the ReadOnly
+ setting in VolumeMounts. Defaults to false. More
+ info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
type: boolean
required:
- pdName
type: object
gitRepo:
- description: |-
- gitRepo represents a git repository at a particular revision.
- DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an
- EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir
- into the Pod's container.
+ description: 'gitRepo represents a git repository at
+ a particular revision. DEPRECATED: GitRepo is deprecated.
+ To provision a container with a git repo, mount an
+ EmptyDir into an InitContainer that clones the repo
+ using git, then mount the EmptyDir into the Pod''s
+ container.'
properties:
directory:
- description: |-
- directory is the target directory name.
- Must not contain or start with '..'. If '.' is supplied, the volume directory will be the
- git repository. Otherwise, if specified, the volume will contain the git repository in
- the subdirectory with the given name.
+ description: directory is the target directory name.
+ Must not contain or start with '..'. If '.' is
+ supplied, the volume directory will be the git
+ repository. Otherwise, if specified, the volume
+ will contain the git repository in the subdirectory
+ with the given name.
type: string
repository:
description: repository is the URL
@@ -16852,61 +16815,54 @@ spec:
- repository
type: object
glusterfs:
- description: |-
- glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.
- More info: https://examples.k8s.io/volumes/glusterfs/README.md
+ description: 'glusterfs represents a Glusterfs mount
+ on the host that shares a pod''s lifetime. More info:
+ https://examples.k8s.io/volumes/glusterfs/README.md'
properties:
endpoints:
- description: |-
- endpoints is the endpoint name that details Glusterfs topology.
- More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
+ description: 'endpoints is the endpoint name that
+ details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: string
path:
- description: |-
- path is the Glusterfs volume path.
- More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
+ description: 'path is the Glusterfs volume path.
+ More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: string
readOnly:
- description: |-
- readOnly here will force the Glusterfs volume to be mounted with read-only permissions.
- Defaults to false.
- More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
+ description: 'readOnly here will force the Glusterfs
+ volume to be mounted with read-only permissions.
+ Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: boolean
required:
- endpoints
- path
type: object
hostPath:
- description: |-
- hostPath represents a pre-existing file or directory on the host
- machine that is directly exposed to the container. This is generally
- used for system agents or other privileged things that are allowed
- to see the host machine. Most containers will NOT need this.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
- ---
- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not
- mount host directories as read/write.
+ description: 'hostPath represents a pre-existing file
+ or directory on the host machine that is directly
+ exposed to the container. This is generally used for
+ system agents or other privileged things that are
+ allowed to see the host machine. Most containers will
+ NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
+ --- TODO(jonesdl) We need to restrict who can use
+ host directory mounts and who can/can not mount host
+ directories as read/write.'
properties:
path:
- description: |-
- path of the directory on the host.
- If the path is a symlink, it will follow the link to the real path.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
+ description: 'path of the directory on the host.
+ If the path is a symlink, it will follow the link
+ to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
type: string
type:
- description: |-
- type for HostPath Volume
- Defaults to ""
- More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
+ description: 'type for HostPath Volume Defaults
+ to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
type: string
required:
- path
type: object
iscsi:
- description: |-
- iscsi represents an ISCSI Disk resource that is attached to a
- kubelet's host machine and then exposed to the pod.
- More info: https://examples.k8s.io/volumes/iscsi/README.md
+ description: 'iscsi represents an ISCSI Disk resource
+ that is attached to a kubelet''s host machine and
+ then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md'
properties:
chapAuthDiscovery:
description: chapAuthDiscovery defines whether support
@@ -16917,59 +16873,61 @@ spec:
iSCSI Session CHAP authentication
type: boolean
fsType:
- description: |-
- fsType is the filesystem type of the volume that you want to mount.
- Tip: Ensure that the filesystem type is supported by the host operating system.
- Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
- TODO: how do we prevent errors in the filesystem from compromising the machine
+ description: 'fsType is the filesystem type of the
+ volume that you want to mount. Tip: Ensure that
+ the filesystem type is supported by the host operating
+ system. Examples: "ext4", "xfs", "ntfs". Implicitly
+ inferred to be "ext4" if unspecified. More info:
+ https://kubernetes.io/docs/concepts/storage/volumes#iscsi
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
initiatorName:
- description: |-
- initiatorName is the custom iSCSI Initiator Name.
- If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface
- : will be created for the connection.
+ description: initiatorName is the custom iSCSI Initiator
+ Name. If initiatorName is specified with iscsiInterface
+ simultaneously, new iSCSI interface : will be created for the connection.
type: string
iqn:
description: iqn is the target iSCSI Qualified Name.
type: string
iscsiInterface:
- description: |-
- iscsiInterface is the interface Name that uses an iSCSI transport.
- Defaults to 'default' (tcp).
+ description: iscsiInterface is the interface Name
+ that uses an iSCSI transport. Defaults to 'default'
+ (tcp).
type: string
lun:
description: lun represents iSCSI Target Lun number.
format: int32
type: integer
portals:
- description: |-
- portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port
- is other than default (typically TCP ports 860 and 3260).
+ description: portals is the iSCSI Target Portal
+ List. The portal is either an IP or ip_addr:port
+ if the port is other than default (typically TCP
+ ports 860 and 3260).
items:
type: string
type: array
readOnly:
- description: |-
- readOnly here will force the ReadOnly setting in VolumeMounts.
- Defaults to false.
+ description: readOnly here will force the ReadOnly
+ setting in VolumeMounts. Defaults to false.
type: boolean
secretRef:
description: secretRef is the CHAP Secret for iSCSI
target and initiator authentication
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
targetPortal:
- description: |-
- targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port
- is other than default (typically TCP ports 860 and 3260).
+ description: targetPortal is iSCSI Target Portal.
+ The Portal is either an IP or ip_addr:port if
+ the port is other than default (typically TCP
+ ports 860 and 3260).
type: string
required:
- iqn
@@ -16977,51 +16935,43 @@ spec:
- targetPortal
type: object
name:
- description: |-
- name of the volume.
- Must be a DNS_LABEL and unique within the pod.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ description: 'name of the volume. Must be a DNS_LABEL
+ and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
type: string
nfs:
- description: |-
- nfs represents an NFS mount on the host that shares a pod's lifetime
- More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ description: 'nfs represents an NFS mount on the host
+ that shares a pod''s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
properties:
path:
- description: |-
- path that is exported by the NFS server.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ description: 'path that is exported by the NFS server.
+ More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: string
readOnly:
- description: |-
- readOnly here will force the NFS export to be mounted with read-only permissions.
- Defaults to false.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ description: 'readOnly here will force the NFS export
+ to be mounted with read-only permissions. Defaults
+ to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: boolean
server:
- description: |-
- server is the hostname or IP address of the NFS server.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ description: 'server is the hostname or IP address
+ of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: string
required:
- path
- server
type: object
persistentVolumeClaim:
- description: |-
- persistentVolumeClaimVolumeSource represents a reference to a
- PersistentVolumeClaim in the same namespace.
- More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
+ description: 'persistentVolumeClaimVolumeSource represents
+ a reference to a PersistentVolumeClaim in the same
+ namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
properties:
claimName:
- description: |-
- claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.
- More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
+ description: 'claimName is the name of a PersistentVolumeClaim
+ in the same namespace as the pod using this volume.
+ More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
type: string
readOnly:
- description: |-
- readOnly Will force the ReadOnly setting in VolumeMounts.
- Default false.
+ description: readOnly Will force the ReadOnly setting
+ in VolumeMounts. Default false.
type: boolean
required:
- claimName
@@ -17032,10 +16982,10 @@ spec:
machine
properties:
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: fsType is the filesystem type to mount.
+ Must be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs". Implicitly
+ inferred to be "ext4" if unspecified.
type: string
pdID:
description: pdID is the ID that identifies Photon
@@ -17049,15 +16999,15 @@ spec:
attached and mounted on kubelets host machine
properties:
fsType:
- description: |-
- fSType represents the filesystem type to mount
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
+ description: fSType represents the filesystem type
+ to mount Must be a filesystem type supported by
+ the host operating system. Ex. "ext4", "xfs".
+ Implicitly inferred to be "ext4" if unspecified.
type: string
readOnly:
- description: |-
- readOnly defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: readOnly defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
volumeID:
description: volumeID uniquely identifies a Portworx
@@ -17071,13 +17021,16 @@ spec:
secrets, configmaps, and downward API
properties:
defaultMode:
- description: |-
- defaultMode are the mode bits used to set permissions on created files by default.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- Directories within the path are not affected by this setting.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: defaultMode are the mode bits used
+ to set permissions on created files by default.
+ Must be an octal value between 0000 and 0777 or
+ a decimal value between 0 and 511. YAML accepts
+ both octal and decimal values, JSON requires decimal
+ values for mode bits. Directories within the path
+ are not affected by this setting. This might be
+ in conflict with other options that affect the
+ file mode, like fsGroup, and the result can be
+ other mode bits set.
format: int32
type: integer
sources:
@@ -17087,39 +17040,39 @@ spec:
along with other supported volume types
properties:
clusterTrustBundle:
- description: |-
- ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field
- of ClusterTrustBundle objects in an auto-updating file.
-
-
- Alpha, gated by the ClusterTrustBundleProjection feature gate.
-
-
- ClusterTrustBundle objects can either be selected by name, or by the
+ description: "ClusterTrustBundle allows a
+ pod to access the `.spec.trustBundle` field
+ of ClusterTrustBundle objects in an auto-updating
+ file. \n Alpha, gated by the ClusterTrustBundleProjection
+ feature gate. \n ClusterTrustBundle objects
+ can either be selected by name, or by the
combination of signer name and a label selector.
-
-
- Kubelet performs aggressive normalization of the PEM contents written
- into the pod filesystem. Esoteric PEM features such as inter-block
- comments and block headers are stripped. Certificates are deduplicated.
- The ordering of certificates within the file is arbitrary, and Kubelet
- may change the order over time.
+ \n Kubelet performs aggressive normalization
+ of the PEM contents written into the pod
+ filesystem. Esoteric PEM features such
+ as inter-block comments and block headers
+ are stripped. Certificates are deduplicated.
+ The ordering of certificates within the
+ file is arbitrary, and Kubelet may change
+ the order over time."
properties:
labelSelector:
- description: |-
- Select all ClusterTrustBundles that match this label selector. Only has
- effect if signerName is set. Mutually-exclusive with name. If unset,
- interpreted as "match nothing". If set but empty, interpreted as "match
- everything".
+ description: Select all ClusterTrustBundles
+ that match this label selector. Only
+ has effect if signerName is set. Mutually-exclusive
+ with name. If unset, interpreted as
+ "match nothing". If set but empty,
+ interpreted as "match everything".
properties:
matchExpressions:
description: matchExpressions is a
list of label selector requirements.
The requirements are ANDed.
items:
- description: |-
- A label selector requirement is a selector that contains values, a key, and an operator that
- relates the key and values.
+ description: A label selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
description: key is the label
@@ -17127,15 +17080,21 @@ spec:
to.
type: string
operator:
- description: |-
- operator represents a key's relationship to a set of values.
- Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents
+ a key's relationship to a
+ set of values. Valid operators
+ are In, NotIn, Exists and
+ DoesNotExist.
type: string
values:
- description: |-
- values is an array of string values. If the operator is In or NotIn,
- the values array must be non-empty. If the operator is Exists or DoesNotExist,
- the values array must be empty. This array is replaced during a strategic
+ description: values is an array
+ of string values. If the operator
+ is In or NotIn, the values
+ array must be non-empty. If
+ the operator is Exists or
+ DoesNotExist, the values array
+ must be empty. This array
+ is replaced during a strategic
merge patch.
items:
type: string
@@ -17148,24 +17107,29 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: |-
- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions, whose key field is "key", the
- operator is "In", and the values array contains only "value". The requirements are ANDed.
+ description: matchLabels is a map
+ of {key,value} pairs. A single {key,value}
+ in the matchLabels map is equivalent
+ to an element of matchExpressions,
+ whose key field is "key", the operator
+ is "In", and the values array contains
+ only "value". The requirements are
+ ANDed.
type: object
type: object
- x-kubernetes-map-type: atomic
name:
- description: |-
- Select a single ClusterTrustBundle by object name. Mutually-exclusive
+ description: Select a single ClusterTrustBundle
+ by object name. Mutually-exclusive
with signerName and labelSelector.
type: string
optional:
- description: |-
- If true, don't block pod startup if the referenced ClusterTrustBundle(s)
- aren't available. If using name, then the named ClusterTrustBundle is
- allowed not to exist. If using signerName, then the combination of
- signerName and labelSelector is allowed to match zero
+ description: If true, don't block pod
+ startup if the referenced ClusterTrustBundle(s)
+ aren't available. If using name, then
+ the named ClusterTrustBundle is allowed
+ not to exist. If using signerName,
+ then the combination of signerName and
+ labelSelector is allowed to match zero
ClusterTrustBundles.
type: boolean
path:
@@ -17173,10 +17137,11 @@ spec:
root to write the bundle.
type: string
signerName:
- description: |-
- Select all ClusterTrustBundles that match this signer name.
- Mutually-exclusive with name. The contents of all selected
- ClusterTrustBundles will be unified and deduplicated.
+ description: Select all ClusterTrustBundles
+ that match this signer name. Mutually-exclusive
+ with name. The contents of all selected
+ ClusterTrustBundles will be unified
+ and deduplicated.
type: string
required:
- path
@@ -17186,14 +17151,19 @@ spec:
configMap data to project
properties:
items:
- description: |-
- items if unspecified, each key-value pair in the Data field of the referenced
- ConfigMap will be projected into the volume as a file whose name is the
- key and content is the value. If specified, the listed keys will be
- projected into the specified paths, and unlisted keys will not be
- present. If a key is specified which is not present in the ConfigMap,
- the volume setup will error unless it is marked optional. Paths must be
- relative and may not contain the '..' path or start with '..'.
+ description: items if unspecified, each
+ key-value pair in the Data field of
+ the referenced ConfigMap will be projected
+ into the volume as a file whose name
+ is the key and content is the value.
+ If specified, the listed keys will be
+ projected into the specified paths,
+ and unlisted keys will not be present.
+ If a key is specified which is not present
+ in the ConfigMap, the volume setup will
+ error unless it is marked optional.
+ Paths must be relative and may not contain
+ the '..' path or start with '..'.
items:
description: Maps a string key to a
path within a volume.
@@ -17202,21 +17172,29 @@ spec:
description: key is the key to project.
type: string
mode:
- description: |-
- mode is Optional: mode bits used to set permissions on this file.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'mode is Optional:
+ mode bits used to set permissions
+ on this file. Must be an octal
+ value between 0000 and 0777 or
+ a decimal value between 0 and
+ 511. YAML accepts both octal and
+ decimal values, JSON requires
+ decimal values for mode bits.
+ If not specified, the volume defaultMode
+ will be used. This might be in
+ conflict with other options that
+ affect the file mode, like fsGroup,
+ and the result can be other mode
+ bits set.'
format: int32
type: integer
path:
- description: |-
- path is the relative path of the file to map the key to.
- May not be an absolute path.
- May not contain the path element '..'.
- May not start with the string '..'.
+ description: path is the relative
+ path of the file to map the key
+ to. May not be an absolute path.
+ May not contain the path element
+ '..'. May not start with the string
+ '..'.
type: string
required:
- key
@@ -17224,17 +17202,16 @@ spec:
type: object
type: array
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: optional specify whether
the ConfigMap or its keys must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
downwardAPI:
description: downwardAPI information about
the downwardAPI data to project
@@ -17266,15 +17243,21 @@ spec:
required:
- fieldPath
type: object
- x-kubernetes-map-type: atomic
mode:
- description: |-
- Optional: mode bits used to set permissions on this file, must be an octal value
- between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'Optional: mode bits
+ used to set permissions on this
+ file, must be an octal value between
+ 0000 and 0777 or a decimal value
+ between 0 and 511. YAML accepts
+ both octal and decimal values,
+ JSON requires decimal values for
+ mode bits. If not specified, the
+ volume defaultMode will be used.
+ This might be in conflict with
+ other options that affect the
+ file mode, like fsGroup, and the
+ result can be other mode bits
+ set.'
format: int32
type: integer
path:
@@ -17287,9 +17270,12 @@ spec:
start with ''..'''
type: string
resourceFieldRef:
- description: |-
- Selects a resource of the container: only resources limits and requests
- (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
+ description: 'Selects a resource
+ of the container: only resources
+ limits and requests (limits.cpu,
+ limits.memory, requests.cpu and
+ requests.memory) are currently
+ supported.'
properties:
containerName:
description: 'Container name:
@@ -17312,7 +17298,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
required:
- path
type: object
@@ -17323,14 +17308,19 @@ spec:
secret data to project
properties:
items:
- description: |-
- items if unspecified, each key-value pair in the Data field of the referenced
- Secret will be projected into the volume as a file whose name is the
- key and content is the value. If specified, the listed keys will be
- projected into the specified paths, and unlisted keys will not be
- present. If a key is specified which is not present in the Secret,
- the volume setup will error unless it is marked optional. Paths must be
- relative and may not contain the '..' path or start with '..'.
+ description: items if unspecified, each
+ key-value pair in the Data field of
+ the referenced Secret will be projected
+ into the volume as a file whose name
+ is the key and content is the value.
+ If specified, the listed keys will be
+ projected into the specified paths,
+ and unlisted keys will not be present.
+ If a key is specified which is not present
+ in the Secret, the volume setup will
+ error unless it is marked optional.
+ Paths must be relative and may not contain
+ the '..' path or start with '..'.
items:
description: Maps a string key to a
path within a volume.
@@ -17339,21 +17329,29 @@ spec:
description: key is the key to project.
type: string
mode:
- description: |-
- mode is Optional: mode bits used to set permissions on this file.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'mode is Optional:
+ mode bits used to set permissions
+ on this file. Must be an octal
+ value between 0000 and 0777 or
+ a decimal value between 0 and
+ 511. YAML accepts both octal and
+ decimal values, JSON requires
+ decimal values for mode bits.
+ If not specified, the volume defaultMode
+ will be used. This might be in
+ conflict with other options that
+ affect the file mode, like fsGroup,
+ and the result can be other mode
+ bits set.'
format: int32
type: integer
path:
- description: |-
- path is the relative path of the file to map the key to.
- May not be an absolute path.
- May not contain the path element '..'.
- May not start with the string '..'.
+ description: path is the relative
+ path of the file to map the key
+ to. May not be an absolute path.
+ May not contain the path element
+ '..'. May not start with the string
+ '..'.
type: string
required:
- key
@@ -17361,42 +17359,47 @@ spec:
type: object
type: array
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: optional field specify whether
the Secret or its key must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
serviceAccountToken:
description: serviceAccountToken is information
about the serviceAccountToken data to project
properties:
audience:
- description: |-
- audience is the intended audience of the token. A recipient of a token
- must identify itself with an identifier specified in the audience of the
- token, and otherwise should reject the token. The audience defaults to the
- identifier of the apiserver.
+ description: audience is the intended
+ audience of the token. A recipient of
+ a token must identify itself with an
+ identifier specified in the audience
+ of the token, and otherwise should reject
+ the token. The audience defaults to
+ the identifier of the apiserver.
type: string
expirationSeconds:
- description: |-
- expirationSeconds is the requested duration of validity of the service
- account token. As the token approaches expiration, the kubelet volume
- plugin will proactively rotate the service account token. The kubelet will
- start trying to rotate the token if the token is older than 80 percent of
- its time to live or if the token is older than 24 hours.Defaults to 1 hour
- and must be at least 10 minutes.
+ description: expirationSeconds is the
+ requested duration of validity of the
+ service account token. As the token
+ approaches expiration, the kubelet volume
+ plugin will proactively rotate the service
+ account token. The kubelet will start
+ trying to rotate the token if the token
+ is older than 80 percent of its time
+ to live or if the token is older than
+ 24 hours.Defaults to 1 hour and must
+ be at least 10 minutes.
format: int64
type: integer
path:
- description: |-
- path is the path relative to the mount point of the file to project the
- token into.
+ description: path is the path relative
+ to the mount point of the file to project
+ the token into.
type: string
required:
- path
@@ -17409,30 +17412,29 @@ spec:
host that shares a pod's lifetime
properties:
group:
- description: |-
- group to map volume access to
- Default is no group
+ description: group to map volume access to Default
+ is no group
type: string
readOnly:
- description: |-
- readOnly here will force the Quobyte volume to be mounted with read-only permissions.
+ description: readOnly here will force the Quobyte
+ volume to be mounted with read-only permissions.
Defaults to false.
type: boolean
registry:
- description: |-
- registry represents a single or multiple Quobyte Registry services
- specified as a string as host:port pair (multiple entries are separated with commas)
- which acts as the central registry for volumes
+ description: registry represents a single or multiple
+ Quobyte Registry services specified as a string
+ as host:port pair (multiple entries are separated
+ with commas) which acts as the central registry
+ for volumes
type: string
tenant:
- description: |-
- tenant owning the given Quobyte volume in the Backend
- Used with dynamically provisioned Quobyte volumes, value is set by the plugin
+ description: tenant owning the given Quobyte volume
+ in the Backend Used with dynamically provisioned
+ Quobyte volumes, value is set by the plugin
type: string
user:
- description: |-
- user to map volume access to
- Defaults to serivceaccount user
+ description: user to map volume access to Defaults
+ to serivceaccount user
type: string
volume:
description: volume is a string that references
@@ -17443,68 +17445,59 @@ spec:
- volume
type: object
rbd:
- description: |-
- rbd represents a Rados Block Device mount on the host that shares a pod's lifetime.
- More info: https://examples.k8s.io/volumes/rbd/README.md
+ description: 'rbd represents a Rados Block Device mount
+ on the host that shares a pod''s lifetime. More info:
+ https://examples.k8s.io/volumes/rbd/README.md'
properties:
fsType:
- description: |-
- fsType is the filesystem type of the volume that you want to mount.
- Tip: Ensure that the filesystem type is supported by the host operating system.
- Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd
- TODO: how do we prevent errors in the filesystem from compromising the machine
+ description: 'fsType is the filesystem type of the
+ volume that you want to mount. Tip: Ensure that
+ the filesystem type is supported by the host operating
+ system. Examples: "ext4", "xfs", "ntfs". Implicitly
+ inferred to be "ext4" if unspecified. More info:
+ https://kubernetes.io/docs/concepts/storage/volumes#rbd
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
image:
- description: |-
- image is the rados image name.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'image is the rados image name. More
+ info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
keyring:
- description: |-
- keyring is the path to key ring for RBDUser.
- Default is /etc/ceph/keyring.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'keyring is the path to key ring for
+ RBDUser. Default is /etc/ceph/keyring. More info:
+ https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
monitors:
- description: |-
- monitors is a collection of Ceph monitors.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'monitors is a collection of Ceph monitors.
+ More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
items:
type: string
type: array
pool:
- description: |-
- pool is the rados pool name.
- Default is rbd.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'pool is the rados pool name. Default
+ is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
readOnly:
- description: |-
- readOnly here will force the ReadOnly setting in VolumeMounts.
- Defaults to false.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'readOnly here will force the ReadOnly
+ setting in VolumeMounts. Defaults to false. More
+ info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: boolean
secretRef:
- description: |-
- secretRef is name of the authentication secret for RBDUser. If provided
- overrides keyring.
- Default is nil.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'secretRef is name of the authentication
+ secret for RBDUser. If provided overrides keyring.
+ Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
user:
- description: |-
- user is the rados user name.
- Default is admin.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'user is the rados user name. Default
+ is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
required:
- image
@@ -17515,11 +17508,10 @@ spec:
volume attached and mounted on Kubernetes nodes.
properties:
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs".
- Default is "xfs".
+ description: fsType is the filesystem type to mount.
+ Must be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs". Default
+ is "xfs".
type: string
gateway:
description: gateway is the host address of the
@@ -17530,30 +17522,30 @@ spec:
ScaleIO Protection Domain for the configured storage.
type: string
readOnly:
- description: |-
- readOnly Defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: readOnly Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
secretRef:
- description: |-
- secretRef references to the secret for ScaleIO user and other
- sensitive information. If this is not provided, Login operation will fail.
+ description: secretRef references to the secret
+ for ScaleIO user and other sensitive information.
+ If this is not provided, Login operation will
+ fail.
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
sslEnabled:
description: sslEnabled Flag enable/disable SSL
communication with Gateway, default false
type: boolean
storageMode:
- description: |-
- storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.
+ description: storageMode indicates whether the storage
+ for a volume should be ThickProvisioned or ThinProvisioned.
Default is ThinProvisioned.
type: string
storagePool:
@@ -17565,9 +17557,9 @@ spec:
as configured in ScaleIO.
type: string
volumeName:
- description: |-
- volumeName is the name of a volume already created in the ScaleIO system
- that is associated with this volume source.
+ description: volumeName is the name of a volume
+ already created in the ScaleIO system that is
+ associated with this volume source.
type: string
required:
- gateway
@@ -17575,30 +17567,34 @@ spec:
- system
type: object
secret:
- description: |-
- secret represents a secret that should populate this volume.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
+ description: 'secret represents a secret that should
+ populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
properties:
defaultMode:
- description: |-
- defaultMode is Optional: mode bits used to set permissions on created files by default.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values
- for mode bits. Defaults to 0644.
- Directories within the path are not affected by this setting.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'defaultMode is Optional: mode bits
+ used to set permissions on created files by default.
+ Must be an octal value between 0000 and 0777 or
+ a decimal value between 0 and 511. YAML accepts
+ both octal and decimal values, JSON requires decimal
+ values for mode bits. Defaults to 0644. Directories
+ within the path are not affected by this setting.
+ This might be in conflict with other options that
+ affect the file mode, like fsGroup, and the result
+ can be other mode bits set.'
format: int32
type: integer
items:
- description: |-
- items If unspecified, each key-value pair in the Data field of the referenced
- Secret will be projected into the volume as a file whose name is the
- key and content is the value. If specified, the listed keys will be
- projected into the specified paths, and unlisted keys will not be
- present. If a key is specified which is not present in the Secret,
- the volume setup will error unless it is marked optional. Paths must be
- relative and may not contain the '..' path or start with '..'.
+ description: items If unspecified, each key-value
+ pair in the Data field of the referenced Secret
+ will be projected into the volume as a file whose
+ name is the key and content is the value. If specified,
+ the listed keys will be projected into the specified
+ paths, and unlisted keys will not be present.
+ If a key is specified which is not present in
+ the Secret, the volume setup will error unless
+ it is marked optional. Paths must be relative
+ and may not contain the '..' path or start with
+ '..'.
items:
description: Maps a string key to a path within
a volume.
@@ -17607,21 +17603,25 @@ spec:
description: key is the key to project.
type: string
mode:
- description: |-
- mode is Optional: mode bits used to set permissions on this file.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'mode is Optional: mode bits
+ used to set permissions on this file. Must
+ be an octal value between 0000 and 0777
+ or a decimal value between 0 and 511. YAML
+ accepts both octal and decimal values, JSON
+ requires decimal values for mode bits. If
+ not specified, the volume defaultMode will
+ be used. This might be in conflict with
+ other options that affect the file mode,
+ like fsGroup, and the result can be other
+ mode bits set.'
format: int32
type: integer
path:
- description: |-
- path is the relative path of the file to map the key to.
- May not be an absolute path.
- May not contain the path element '..'.
- May not start with the string '..'.
+ description: path is the relative path of
+ the file to map the key to. May not be an
+ absolute path. May not contain the path
+ element '..'. May not start with the string
+ '..'.
type: string
required:
- key
@@ -17633,9 +17633,8 @@ spec:
Secret or its keys must be defined
type: boolean
secretName:
- description: |-
- secretName is the name of the secret in the pod's namespace to use.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
+ description: 'secretName is the name of the secret
+ in the pod''s namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
type: string
type: object
storageos:
@@ -17643,42 +17642,43 @@ spec:
attached and mounted on Kubernetes nodes.
properties:
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: fsType is the filesystem type to mount.
+ Must be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs". Implicitly
+ inferred to be "ext4" if unspecified.
type: string
readOnly:
- description: |-
- readOnly defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: readOnly defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
secretRef:
- description: |-
- secretRef specifies the secret to use for obtaining the StorageOS API
- credentials. If not specified, default values will be attempted.
+ description: secretRef specifies the secret to use
+ for obtaining the StorageOS API credentials. If
+ not specified, default values will be attempted.
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
volumeName:
- description: |-
- volumeName is the human-readable name of the StorageOS volume. Volume
- names are only unique within a namespace.
+ description: volumeName is the human-readable name
+ of the StorageOS volume. Volume names are only
+ unique within a namespace.
type: string
volumeNamespace:
- description: |-
- volumeNamespace specifies the scope of the volume within StorageOS. If no
- namespace is specified then the Pod's namespace will be used. This allows the
- Kubernetes name scoping to be mirrored within StorageOS for tighter integration.
- Set VolumeName to any name to override the default behaviour.
- Set to "default" if you are not using namespaces within StorageOS.
- Namespaces that do not pre-exist within StorageOS will be created.
+ description: volumeNamespace specifies the scope
+ of the volume within StorageOS. If no namespace
+ is specified then the Pod's namespace will be
+ used. This allows the Kubernetes name scoping
+ to be mirrored within StorageOS for tighter integration.
+ Set VolumeName to any name to override the default
+ behaviour. Set to "default" if you are not using
+ namespaces within StorageOS. Namespaces that do
+ not pre-exist within StorageOS will be created.
type: string
type: object
vsphereVolume:
@@ -17686,10 +17686,10 @@ spec:
attached and mounted on kubelets host machine
properties:
fsType:
- description: |-
- fsType is filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: fsType is filesystem type to mount.
+ Must be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs". Implicitly
+ inferred to be "ext4" if unspecified.
type: string
storagePolicyID:
description: storagePolicyID is the storage Policy
@@ -17740,9 +17740,8 @@ spec:
description: The configuration of Affinity trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -17761,9 +17760,9 @@ spec:
in the same node (default `false`).
type: boolean
podAffinityLabels:
- description: |-
- Defines a set of pods (namely those matching the label selector, relative to the given namespace) that the
- integration pod(s) should be co-located with.
+ description: Defines a set of pods (namely those matching
+ the label selector, relative to the given namespace) that
+ the integration pod(s) should be co-located with.
items:
type: string
type: array
@@ -17772,9 +17771,9 @@ spec:
in the same node (default `false`).
type: boolean
podAntiAffinityLabels:
- description: |-
- Defines a set of pods (namely those matching the label selector, relative to the given namespace) that the
- integration pod(s) should not be co-located with.
+ description: Defines a set of pods (namely those matching
+ the label selector, relative to the given namespace) that
+ the integration pod(s) should not be co-located with.
items:
type: string
type: array
@@ -17789,14 +17788,13 @@ spec:
for the builder pod.
type: object
baseImage:
- description: |-
- Specify a base image. In order to have the application working properly it must be a container image which has a Java JDK
- installed and ready to use on path (ie `/usr/bin/java`).
+ description: Specify a base image. In order to have the application
+ working properly it must be a container image which has
+ a Java JDK installed and ready to use on path (ie `/usr/bin/java`).
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -17807,21 +17805,27 @@ spec:
existing containers (default `true`)
type: boolean
limitCPU:
- description: |-
- When using `pod` strategy, the maximum amount of CPU required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the maximum amount
+ of CPU required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
limitMemory:
- description: |-
- When using `pod` strategy, the maximum amount of memory required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the maximum amount
+ of memory required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
mavenProfiles:
- description: |-
- A list of references pointing to configmaps/secrets that contains a maven profile.
- This configmap/secret is a resource of the IntegrationKit created, therefore it needs to be present in the namespace where the operator is going to create the IntegrationKit.
- The content of the maven profile is expected to be a text containing a valid maven profile starting with `` and ending with `` that will be integrated as an inline profile in the POM.
- Syntax: [configmap|secret]:name[/key], where name represents the resource name, key optionally represents the resource key to be filtered (default key value = profile.xml).
+ description: 'A list of references pointing to configmaps/secrets
+ that contains a maven profile. This configmap/secret is
+ a resource of the IntegrationKit created, therefore it needs
+ to be present in the namespace where the operator is going
+ to create the IntegrationKit. The content of the maven profile
+ is expected to be a text containing a valid maven profile
+ starting with `` and ending with `` that
+ will be integrated as an inline profile in the POM. Syntax:
+ [configmap|secret]:name[/key], where name represents the
+ resource name, key optionally represents the resource key
+ to be filtered (default key value = profile.xml).'
items:
type: string
type: array
@@ -17852,14 +17856,14 @@ spec:
type: string
type: array
requestCPU:
- description: |-
- When using `pod` strategy, the minimum amount of CPU required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the minimum amount
+ of CPU required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
requestMemory:
- description: |-
- When using `pod` strategy, the minimum amount of memory required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the minimum amount
+ of memory required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
strategy:
description: The strategy to use, either `pod` or `routine`
@@ -17875,10 +17879,11 @@ spec:
type: string
type: array
tasksFilter:
- description: |-
- A list of tasks sorted by the order of execution in a csv format, ie, `,,...`.
- Mind that you must include also the operator tasks (`builder`, `quarkus-native`, `package`, `jib`, `s2i`)
- if you need to execute them. Useful only with `pod` strategy.
+ description: A list of tasks sorted by the order of execution
+ in a csv format, ie, `,,...`. Mind
+ that you must include also the operator tasks (`builder`,
+ `quarkus-native`, `package`, `jib`, `s2i`) if you need to
+ execute them. Useful only with `pod` strategy.
type: string
tasksLimitCPU:
description: A list of limit cpu configuration for the specific
@@ -17905,18 +17910,17 @@ spec:
type: string
type: array
verbose:
- description: |-
- Enable verbose logging on build components that support it (e.g. Kaniko build pod).
- Deprecated no longer in use
+ description: Enable verbose logging on build components that
+ support it (e.g. Kaniko build pod). Deprecated no longer
+ in use
type: boolean
type: object
camel:
description: The configuration of Camel trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -17929,10 +17933,12 @@ spec:
type: string
type: array
runtimeVersion:
- description: |-
- The camel-k-runtime version to use for the integration. It overrides the default version set in the Integration Platform.
- You can use a fixed version (for example "3.2.3") or a semantic version (for example "3.x") which will try to resolve
- to the best matching Catalog existing on the cluster.
+ description: The camel-k-runtime version to use for the integration.
+ It overrides the default version set in the Integration
+ Platform. You can use a fixed version (for example "3.2.3")
+ or a semantic version (for example "3.x") which will try
+ to resolve to the best matching Catalog existing on the
+ cluster.
type: string
type: object
container:
@@ -17960,9 +17966,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -17973,10 +17978,13 @@ spec:
Service.
type: boolean
image:
- description: |-
- The main container image to use for the Integration. When using this parameter the operator will create a synthetic IntegrationKit which
- won't be able to execute traits requiring CamelCatalog. If the container image you're using is coming from an IntegrationKit, use instead
- Integration `.spec.integrationKit` parameter. If you're moving the Integration across environments, you will also need to create an "external" IntegrationKit.
+ description: The main container image to use for the Integration.
+ When using this parameter the operator will create a synthetic
+ IntegrationKit which won't be able to execute traits requiring
+ CamelCatalog. If the container image you're using is coming
+ from an IntegrationKit, use instead Integration `.spec.integrationKit`
+ parameter. If you're moving the Integration across environments,
+ you will also need to create an "external" IntegrationKit.
type: string
imagePullPolicy:
description: 'The pull policy: Always|Never|IfNotPresent'
@@ -18044,52 +18052,50 @@ spec:
description: The configuration of Cron trait
properties:
activeDeadlineSeconds:
- description: |-
- Specifies the duration in seconds, relative to the start time, that the job
- may be continuously active before it is considered to be failed.
- It defaults to 60s.
+ description: Specifies the duration in seconds, relative to
+ the start time, that the job may be continuously active
+ before it is considered to be failed. It defaults to 60s.
format: int64
type: integer
auto:
- description: |-
- Automatically deploy the integration as CronJob when all routes are
- either starting from a periodic consumer (only `cron`, `timer` and `quartz` are supported) or a passive consumer (e.g. `direct` is a passive consumer).
-
-
- It's required that all periodic consumers have the same period, and it can be expressed as cron schedule (e.g. `1m` can be expressed as `0/1 * * * *`,
- while `35m` or `50s` cannot).
+ description: "Automatically deploy the integration as CronJob
+ when all routes are either starting from a periodic consumer
+ (only `cron`, `timer` and `quartz` are supported) or a passive
+ consumer (e.g. `direct` is a passive consumer). \n It's
+ required that all periodic consumers have the same period,
+ and it can be expressed as cron schedule (e.g. `1m` can
+ be expressed as `0/1 * * * *`, while `35m` or `50s` cannot)."
type: boolean
backoffLimit:
- description: |-
- Specifies the number of retries before marking the job failed.
- It defaults to 2.
+ description: Specifies the number of retries before marking
+ the job failed. It defaults to 2.
format: int32
type: integer
components:
- description: |-
- A comma separated list of the Camel components that need to be customized in order for them to work when the schedule is triggered externally by Kubernetes.
- A specific customizer is activated for each specified component. E.g. for the `timer` component, the `cron-timer` customizer is
- activated (it's present in the `org.apache.camel.k:camel-k-cron` library).
-
-
- Supported components are currently: `cron`, `timer` and `quartz`.
+ description: "A comma separated list of the Camel components
+ that need to be customized in order for them to work when
+ the schedule is triggered externally by Kubernetes. A specific
+ customizer is activated for each specified component. E.g.
+ for the `timer` component, the `cron-timer` customizer is
+ activated (it's present in the `org.apache.camel.k:camel-k-cron`
+ library). \n Supported components are currently: `cron`,
+ `timer` and `quartz`."
type: string
concurrencyPolicy:
- description: |-
- Specifies how to treat concurrent executions of a Job.
- Valid values are:
- - "Allow": allows CronJobs to run concurrently;
- - "Forbid" (default): forbids concurrent runs, skipping next run if previous run hasn't finished yet;
- - "Replace": cancels currently running job and replaces it with a new one
+ description: 'Specifies how to treat concurrent executions
+ of a Job. Valid values are: - "Allow": allows CronJobs to
+ run concurrently; - "Forbid" (default): forbids concurrent
+ runs, skipping next run if previous run hasn''t finished
+ yet; - "Replace": cancels currently running job and replaces
+ it with a new one'
enum:
- Allow
- Forbid
- Replace
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -18097,19 +18103,19 @@ spec:
traits share this common property.
type: boolean
fallback:
- description: |-
- Use the default Camel implementation of the `cron` endpoint (`quartz`) instead of trying to materialize the integration
- as Kubernetes CronJob.
+ description: Use the default Camel implementation of the `cron`
+ endpoint (`quartz`) instead of trying to materialize the
+ integration as Kubernetes CronJob.
type: boolean
schedule:
- description: |-
- The CronJob schedule for the whole integration. If multiple routes are declared, they must have the same schedule for this
- mechanism to work correctly.
+ description: The CronJob schedule for the whole integration.
+ If multiple routes are declared, they must have the same
+ schedule for this mechanism to work correctly.
type: string
startingDeadlineSeconds:
- description: |-
- Optional deadline in seconds for starting the job if it misses scheduled
- time for any reason. Missed jobs executions will be counted as failed ones.
+ description: Optional deadline in seconds for starting the
+ job if it misses scheduled time for any reason. Missed
+ jobs executions will be counted as failed ones.
format: int64
type: integer
timeZone:
@@ -18120,9 +18126,8 @@ spec:
description: The configuration of Dependencies trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -18133,9 +18138,8 @@ spec:
description: The configuration of Deployer trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -18151,51 +18155,49 @@ spec:
- knative-service
type: string
useSSA:
- description: |-
- Use server-side apply to update the owned resources (default `true`).
- Note that it automatically falls back to client-side patching, if SSA is not available, e.g., on old Kubernetes clusters.
+ description: Use server-side apply to update the owned resources
+ (default `true`). Note that it automatically falls back
+ to client-side patching, if SSA is not available, e.g.,
+ on old Kubernetes clusters.
type: boolean
type: object
deployment:
description: The configuration of Deployment trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
description: 'Deprecated: no longer in use.'
type: boolean
progressDeadlineSeconds:
- description: |-
- The maximum time in seconds for the deployment to make progress before it
- is considered to be failed. It defaults to `60s`.
+ description: The maximum time in seconds for the deployment
+ to make progress before it is considered to be failed. It
+ defaults to `60s`.
format: int32
type: integer
rollingUpdateMaxSurge:
anyOf:
- type: integer
- type: string
- description: |-
- The maximum number of pods that can be scheduled above the desired number of
- pods.
- Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
- This can not be 0 if MaxUnavailable is 0.
- Absolute number is calculated from percentage by rounding up.
- Defaults to `25%`.
+ description: 'The maximum number of pods that can be scheduled
+ above the desired number of pods. Value can be an absolute
+ number (ex: 5) or a percentage of desired pods (ex: 10%).
+ This can not be 0 if MaxUnavailable is 0. Absolute number
+ is calculated from percentage by rounding up. Defaults to
+ `25%`.'
x-kubernetes-int-or-string: true
rollingUpdateMaxUnavailable:
anyOf:
- type: integer
- type: string
- description: |-
- The maximum number of pods that can be unavailable during the update.
- Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
- Absolute number is calculated from percentage by rounding down.
- This can not be 0 if MaxSurge is 0.
- Defaults to `25%`.
+ description: 'The maximum number of pods that can be unavailable
+ during the update. Value can be an absolute number (ex:
+ 5) or a percentage of desired pods (ex: 10%). Absolute number
+ is calculated from percentage by rounding down. This can
+ not be 0 if MaxSurge is 0. Defaults to `25%`.'
x-kubernetes-int-or-string: true
strategy:
description: The deployment strategy to use to replace existing
@@ -18209,9 +18211,8 @@ spec:
description: The configuration of Environment trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
containerMeta:
@@ -18226,11 +18227,12 @@ spec:
`NO_PROXY` environment variables (default `true`)
type: boolean
vars:
- description: |-
- A list of environment variables to be added to the integration container.
- The syntax is either VAR=VALUE or VAR=[configmap|secret]:name/key, where name represents the resource name,
- and key represents the resource key to be mapped as and environment variable.
- These take precedence over any previously defined environment variables.
+ description: A list of environment variables to be added to
+ the integration container. The syntax is either VAR=VALUE
+ or VAR=[configmap|secret]:name/key, where name represents
+ the resource name, and key represents the resource key to
+ be mapped as and environment variable. These take precedence
+ over any previously defined environment variables.
items:
type: string
type: array
@@ -18239,9 +18241,8 @@ spec:
description: The configuration of Error Handler trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -18256,15 +18257,14 @@ spec:
description: The configuration of GC trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
discoveryCache:
- description: |-
- Discovery client cache to be used, either `disabled`, `disk` or `memory` (default `memory`).
- Deprecated: to be removed from trait configuration.
+ description: 'Discovery client cache to be used, either `disabled`,
+ `disk` or `memory` (default `memory`). Deprecated: to be
+ removed from trait configuration.'
enum:
- disabled
- disk
@@ -18279,9 +18279,8 @@ spec:
description: The configuration of Health trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -18403,19 +18402,17 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to the ingress.
- This can be used to set controller specific annotations, e.g., when using the NGINX Ingress controller:
- See https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md
+ description: 'The annotations added to the ingress. This can
+ be used to set controller specific annotations, e.g., when
+ using the NGINX Ingress controller: See https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md'
type: object
auto:
description: To automatically add an ingress whenever the
integration uses an HTTP endpoint consumer.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -18425,14 +18422,18 @@ spec:
host:
description: To configure the host exposed by the ingress.
type: string
+ ingressClassName:
+ description: The Ingress class name as defined by the Ingress
+ spec See https://kubernetes.io/docs/concepts/services-networking/ingress/
+ type: string
path:
description: To configure the path exposed by the ingress
(default `/`).
type: string
pathType:
- description: |-
- To configure the path type exposed by the ingress.
- One of `Exact`, `Prefix`, `ImplementationSpecific` (default to `Prefix`).
+ description: To configure the path type exposed by the ingress.
+ One of `Exact`, `Prefix`, `ImplementationSpecific` (default
+ to `Prefix`).
enum:
- Exact
- Prefix
@@ -18456,9 +18457,8 @@ spec:
by default).
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -18475,23 +18475,25 @@ spec:
description: The configuration of Jolokia trait
properties:
CACert:
- description: |-
- The PEM encoded CA certification file path, used to verify client certificates,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt` for OpenShift).
+ description: The PEM encoded CA certification file path, used
+ to verify client certificates, applicable when `protocol`
+ is `https` and `use-ssl-client-authentication` is `true`
+ (default `/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt`
+ for OpenShift).
type: string
clientPrincipal:
- description: |-
- The principal(s) which must be given in a client certificate to allow access to the Jolokia endpoint,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `clientPrincipal=cn=system:master-proxy`, `cn=hawtio-online.hawtio.svc` and `cn=fuse-console.fuse.svc` for OpenShift).
+ description: The principal(s) which must be given in a client
+ certificate to allow access to the Jolokia endpoint, applicable
+ when `protocol` is `https` and `use-ssl-client-authentication`
+ is `true` (default `clientPrincipal=cn=system:master-proxy`,
+ `cn=hawtio-online.hawtio.svc` and `cn=fuse-console.fuse.svc`
+ for OpenShift).
items:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
discoveryEnabled:
@@ -18502,20 +18504,20 @@ spec:
traits share this common property.
type: boolean
extendedClientCheck:
- description: |-
- Mandate the client certificate contains a client flag in the extended key usage section,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `true` for OpenShift).
+ description: Mandate the client certificate contains a client
+ flag in the extended key usage section, applicable when
+ `protocol` is `https` and `use-ssl-client-authentication`
+ is `true` (default `true` for OpenShift).
type: boolean
host:
- description: |-
- The Host address to which the Jolokia agent should bind to. If `"\*"` or `"0.0.0.0"` is given,
- the servers binds to every network interface (default `"*"`).
+ description: The Host address to which the Jolokia agent should
+ bind to. If `"\*"` or `"0.0.0.0"` is given, the servers
+ binds to every network interface (default `"*"`).
type: string
options:
- description: |-
- A list of additional Jolokia options as defined
- in https://jolokia.org/reference/html/agents.html#agent-jvm-config[JVM agent configuration options]
+ description: A list of additional Jolokia options as defined
+ in https://jolokia.org/reference/html/agents.html#agent-jvm-config[JVM
+ agent configuration options]
items:
type: string
type: array
@@ -18546,9 +18548,8 @@ spec:
separator)
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
debug:
@@ -18577,9 +18578,9 @@ spec:
type: string
type: array
printCommand:
- description: |-
- Prints the command used the start the JVM in the container logs (default `true`)
- Deprecated: no longer in use.
+ description: 'Prints the command used the start the JVM in
+ the container logs (default `true`) Deprecated: no longer
+ in use.'
type: boolean
type: object
kamelets:
@@ -18590,9 +18591,8 @@ spec:
and their default configuration (enabled by default)
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -18625,16 +18625,14 @@ spec:
description: Enable automatic discovery of all trait properties.
type: boolean
channelSinks:
- description: |-
- List of channels used as destination of integration routes.
- Can contain simple channel names or full Camel URIs.
+ description: List of channels used as destination of integration
+ routes. Can contain simple channel names or full Camel URIs.
items:
type: string
type: array
channelSources:
- description: |-
- List of channels used as source of integration routes.
- Can contain simple channel names or full Camel URIs.
+ description: List of channels used as source of integration
+ routes. Can contain simple channel names or full Camel URIs.
items:
type: string
type: array
@@ -18643,9 +18641,8 @@ spec:
in JSON format.
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -18653,9 +18650,9 @@ spec:
traits share this common property.
type: boolean
endpointSinks:
- description: |-
- List of endpoints used as destination of integration routes.
- Can contain simple endpoint names or full Camel URIs.
+ description: List of endpoints used as destination of integration
+ routes. Can contain simple endpoint names or full Camel
+ URIs.
items:
type: string
type: array
@@ -18666,50 +18663,54 @@ spec:
type: string
type: array
eventSinks:
- description: |-
- List of event types that the integration will produce.
- Can contain simple event types or full Camel URIs (to use a specific broker).
+ description: List of event types that the integration will
+ produce. Can contain simple event types or full Camel URIs
+ (to use a specific broker).
items:
type: string
type: array
eventSources:
- description: |-
- List of event types that the integration will be subscribed to.
- Can contain simple event types or full Camel URIs (to use a specific broker different from "default").
+ description: List of event types that the integration will
+ be subscribed to. Can contain simple event types or full
+ Camel URIs (to use a specific broker different from "default").
items:
type: string
type: array
filterEventType:
- description: |-
- Enables the default filtering for the Knative trigger using the event type
- If this is true, the created Knative trigger uses the event type as a filter on the event stream when no other filter criteria is given. (default: true)
+ description: 'Enables the default filtering for the Knative
+ trigger using the event type If this is true, the created
+ Knative trigger uses the event type as a filter on the event
+ stream when no other filter criteria is given. (default:
+ true)'
type: boolean
filterSourceChannels:
- description: |-
- Enables filtering on events based on the header "ce-knativehistory". Since this header has been removed in newer versions of
- Knative, filtering is disabled by default.
+ description: Enables filtering on events based on the header
+ "ce-knativehistory". Since this header has been removed
+ in newer versions of Knative, filtering is disabled by default.
type: boolean
filters:
- description: |-
- Sets filter attributes on the event stream (such as event type, source, subject and so on).
- A list of key-value pairs that represent filter attributes and its values.
- The syntax is KEY=VALUE, e.g., `source="my.source"`.
- Filter attributes get set on the Knative trigger that is being created as part of this integration.
+ description: Sets filter attributes on the event stream (such
+ as event type, source, subject and so on). A list of key-value
+ pairs that represent filter attributes and its values. The
+ syntax is KEY=VALUE, e.g., `source="my.source"`. Filter
+ attributes get set on the Knative trigger that is being
+ created as part of this integration.
items:
type: string
type: array
namespaceLabel:
- description: |-
- Enables the camel-k-operator to set the "bindings.knative.dev/include=true" label to the namespace
- As Knative requires this label to perform injection of K_SINK URL into the service.
- If this is false, the integration pod may start and fail, read the SinkBinding Knative documentation. (default: true)
+ description: 'Enables the camel-k-operator to set the "bindings.knative.dev/include=true"
+ label to the namespace As Knative requires this label to
+ perform injection of K_SINK URL into the service. If this
+ is false, the integration pod may start and fail, read the
+ SinkBinding Knative documentation. (default: true)'
type: boolean
sinkBinding:
- description: |-
- Allows binding the integration to a sink via a Knative SinkBinding resource.
- This can be used when the integration targets a single sink.
- It's enabled by default when the integration targets a single sink
- (except when the integration is owned by a Knative source).
+ description: Allows binding the integration to a sink via
+ a Knative SinkBinding resource. This can be used when the
+ integration targets a single sink. It's enabled by default
+ when the integration targets a single sink (except when
+ the integration is owned by a Knative source).
type: boolean
type: object
knative-service:
@@ -18718,47 +18719,39 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to route.
- This can be used to set knative service specific annotations
- CLI usage example: -t "knative-service.annotations.'haproxy.router.openshift.io/balance'=true"
+ description: 'The annotations added to route. This can be
+ used to set knative service specific annotations CLI usage
+ example: -t "knative-service.annotations.''haproxy.router.openshift.io/balance''=true"'
type: object
auto:
- description: |-
- Automatically deploy the integration as Knative service when all conditions hold:
-
-
- * Integration is using the Knative profile
- * All routes are either starting from an HTTP based consumer or a passive consumer (e.g. `direct` is a passive consumer)
+ description: "Automatically deploy the integration as Knative
+ service when all conditions hold: \n * Integration is using
+ the Knative profile * All routes are either starting from
+ an HTTP based consumer or a passive consumer (e.g. `direct`
+ is a passive consumer)"
type: boolean
autoscalingMetric:
- description: |-
- Configures the Knative autoscaling metric property (e.g. to set `concurrency` based or `cpu` based autoscaling).
-
-
- Refer to the Knative documentation for more information.
+ description: "Configures the Knative autoscaling metric property
+ (e.g. to set `concurrency` based or `cpu` based autoscaling).
+ \n Refer to the Knative documentation for more information."
type: string
autoscalingTarget:
- description: |-
- Sets the allowed concurrency level or CPU percentage (depending on the autoscaling metric) for each Pod.
-
-
- Refer to the Knative documentation for more information.
+ description: "Sets the allowed concurrency level or CPU percentage
+ (depending on the autoscaling metric) for each Pod. \n Refer
+ to the Knative documentation for more information."
type: integer
class:
- description: |-
- Configures the Knative autoscaling class property (e.g. to set `hpa.autoscaling.knative.dev` or `kpa.autoscaling.knative.dev` autoscaling).
-
-
- Refer to the Knative documentation for more information.
+ description: "Configures the Knative autoscaling class property
+ (e.g. to set `hpa.autoscaling.knative.dev` or `kpa.autoscaling.knative.dev`
+ autoscaling). \n Refer to the Knative documentation for
+ more information."
enum:
- kpa.autoscaling.knative.dev
- hpa.autoscaling.knative.dev
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -18766,43 +18759,36 @@ spec:
traits share this common property.
type: boolean
maxScale:
- description: |-
- An upper bound for the number of Pods that can be running in parallel for the integration.
- Knative has its own cap value that depends on the installation.
-
-
- Refer to the Knative documentation for more information.
+ description: "An upper bound for the number of Pods that can
+ be running in parallel for the integration. Knative has
+ its own cap value that depends on the installation. \n Refer
+ to the Knative documentation for more information."
type: integer
minScale:
- description: |-
- The minimum number of Pods that should be running at any time for the integration. It's **zero** by default, meaning that
- the integration is scaled down to zero when not used for a configured amount of time.
-
-
- Refer to the Knative documentation for more information.
+ description: "The minimum number of Pods that should be running
+ at any time for the integration. It's **zero** by default,
+ meaning that the integration is scaled down to zero when
+ not used for a configured amount of time. \n Refer to the
+ Knative documentation for more information."
type: integer
rolloutDuration:
- description: |-
- Enables to gradually shift traffic to the latest Revision and sets the rollout duration.
- It's disabled by default and must be expressed as a Golang `time.Duration` string representation,
- rounded to a second precision.
+ description: Enables to gradually shift traffic to the latest
+ Revision and sets the rollout duration. It's disabled by
+ default and must be expressed as a Golang `time.Duration`
+ string representation, rounded to a second precision.
type: string
timeoutSeconds:
- description: |-
- The maximum duration in seconds that the request instance is allowed to respond to a request.
- This field propagates to the integration pod's terminationGracePeriodSeconds
-
-
- Refer to the Knative documentation for more information.
+ description: "The maximum duration in seconds that the request
+ instance is allowed to respond to a request. This field
+ propagates to the integration pod's terminationGracePeriodSeconds
+ \n Refer to the Knative documentation for more information."
format: int64
type: integer
visibility:
- description: |-
- Setting `cluster-local`, Knative service becomes a private service.
- Specifically, this option applies the `networking.knative.dev/visibility` label to Knative service.
-
-
- Refer to the Knative documentation for more information.
+ description: "Setting `cluster-local`, Knative service becomes
+ a private service. Specifically, this option applies the
+ `networking.knative.dev/visibility` label to Knative service.
+ \n Refer to the Knative documentation for more information."
enum:
- cluster-local
type: string
@@ -18814,9 +18800,8 @@ spec:
description: Colorize the log output
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -18856,18 +18841,20 @@ spec:
description: The configuration of Mount trait
properties:
configs:
- description: |-
- A list of configuration pointing to configmap/secret.
- The configuration are expected to be UTF-8 resources as they are processed by runtime Camel Context and tried to be parsed as property files.
- They are also made available on the classpath in order to ease their usage directly from the Route.
- Syntax: [configmap|secret]:name[/key], where name represents the resource name and key optionally represents the resource key to be filtered
+ description: 'A list of configuration pointing to configmap/secret.
+ The configuration are expected to be UTF-8 resources as
+ they are processed by runtime Camel Context and tried to
+ be parsed as property files. They are also made available
+ on the classpath in order to ease their usage directly from
+ the Route. Syntax: [configmap|secret]:name[/key], where
+ name represents the resource name and key optionally represents
+ the resource key to be filtered'
items:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
emptyDirs:
@@ -18880,17 +18867,21 @@ spec:
description: 'Deprecated: no longer in use.'
type: boolean
hotReload:
- description: |-
- Enable "hot reload" when a secret/configmap mounted is edited (default `false`). The configmap/secret must be
- marked with `camel.apache.org/integration` label to be taken in account. The resource will be watched for any kind change, also for
- changes in metadata.
+ description: Enable "hot reload" when a secret/configmap mounted
+ is edited (default `false`). The configmap/secret must be
+ marked with `camel.apache.org/integration` label to be taken
+ in account. The resource will be watched for any kind change,
+ also for changes in metadata.
type: boolean
resources:
- description: |-
- A list of resources (text or binary content) pointing to configmap/secret.
- The resources are expected to be any resource type (text or binary content).
- The destination path can be either a default location or any path specified by the user.
- Syntax: [configmap|secret]:name[/key][@path], where name represents the resource name, key optionally represents the resource key to be filtered and path represents the destination path
+ description: 'A list of resources (text or binary content)
+ pointing to configmap/secret. The resources are expected
+ to be any resource type (text or binary content). The destination
+ path can be either a default location or any path specified
+ by the user. Syntax: [configmap|secret]:name[/key][@path],
+ where name represents the resource name, key optionally
+ represents the resource key to be filtered and path represents
+ the destination path'
items:
type: string
type: array
@@ -18915,9 +18906,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -18928,9 +18918,8 @@ spec:
description: The configuration of Owner trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -18952,9 +18941,8 @@ spec:
description: The configuration of PDB trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -18962,53 +18950,56 @@ spec:
traits share this common property.
type: boolean
maxUnavailable:
- description: |-
- The number of pods for the Integration that can be unavailable after an eviction.
- It can be either an absolute number or a percentage (default `1` if `min-available` is also not set).
- Only one of `max-unavailable` and `min-available` can be specified.
+ description: The number of pods for the Integration that can
+ be unavailable after an eviction. It can be either an absolute
+ number or a percentage (default `1` if `min-available` is
+ also not set). Only one of `max-unavailable` and `min-available`
+ can be specified.
type: string
minAvailable:
- description: |-
- The number of pods for the Integration that must still be available after an eviction.
- It can be either an absolute number or a percentage.
- Only one of `min-available` and `max-unavailable` can be specified.
+ description: The number of pods for the Integration that must
+ still be available after an eviction. It can be either an
+ absolute number or a percentage. Only one of `min-available`
+ and `max-unavailable` can be specified.
type: string
type: object
platform:
description: The configuration of Platform trait
properties:
auto:
- description: |-
- To automatically detect from the environment if a default platform can be created (it will be created on OpenShift or when a registry address is set).
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'To automatically detect from the environment
+ if a default platform can be created (it will be created
+ on OpenShift or when a registry address is set). Deprecated:
+ Platform is auto generated by the operator install procedure
+ - maintained for backward compatibility'
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
createDefault:
- description: |-
- To create a default (empty) platform when the platform is missing.
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'To create a default (empty) platform when the
+ platform is missing. Deprecated: Platform is auto generated
+ by the operator install procedure - maintained for backward
+ compatibility'
type: boolean
enabled:
description: 'Deprecated: no longer in use.'
type: boolean
global:
- description: |-
- Indicates if the platform should be created globally in the case of global operator (default true).
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'Indicates if the platform should be created
+ globally in the case of global operator (default true).
+ Deprecated: Platform is auto generated by the operator install
+ procedure - maintained for backward compatibility'
type: boolean
type: object
pod:
description: The configuration of Pod trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -19020,9 +19011,8 @@ spec:
description: The configuration of Prometheus trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -19048,9 +19038,8 @@ spec:
secret on the pod if it is of type `kubernetes.io/dockerconfigjson`.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -19073,10 +19062,10 @@ spec:
description: The configuration of Quarkus trait
properties:
buildMode:
- description: |-
- The Quarkus mode to run: either `jvm` or `native` (default `jvm`).
- In case both `jvm` and `native` are specified, two `IntegrationKit` resources are created,
- with the `native` kit having precedence over the `jvm` one once ready.
+ description: 'The Quarkus mode to run: either `jvm` or `native`
+ (default `jvm`). In case both `jvm` and `native` are specified,
+ two `IntegrationKit` resources are created, with the `native`
+ kit having precedence over the `jvm` one once ready.'
items:
description: QuarkusMode is the type of Quarkus build packaging.
enum:
@@ -19085,9 +19074,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -19103,18 +19091,18 @@ spec:
in the runtime catalog)
type: string
packageTypes:
- description: |-
- The Quarkus package types, `fast-jar` or `native` (default `fast-jar`).
- In case both `fast-jar` and `native` are specified, two `IntegrationKit` resources are created,
- with the native kit having precedence over the `fast-jar` one once ready.
- The order influences the resolution of the current kit for the integration.
- The kit corresponding to the first package type will be assigned to the
- integration in case no existing kit that matches the integration exists.
- Deprecated: use `build-mode` instead.
+ description: 'The Quarkus package types, `fast-jar` or `native`
+ (default `fast-jar`). In case both `fast-jar` and `native`
+ are specified, two `IntegrationKit` resources are created,
+ with the native kit having precedence over the `fast-jar`
+ one once ready. The order influences the resolution of the
+ current kit for the integration. The kit corresponding to
+ the first package type will be assigned to the integration
+ in case no existing kit that matches the integration exists.
+ Deprecated: use `build-mode` instead.'
items:
- description: |-
- QuarkusPackageType is the type of Quarkus build packaging.
- Deprecated: use `QuarkusMode` instead.
+ description: 'QuarkusPackageType is the type of Quarkus
+ build packaging. Deprecated: use `QuarkusMode` instead.'
enum:
- fast-jar
- native
@@ -19122,14 +19110,12 @@ spec:
type: array
type: object
registry:
- description: |-
- The configuration of Registry trait (support removed since version 2.5.0).
- Deprecated: use jvm trait or read documentation.
+ description: 'The configuration of Registry trait (support removed
+ since version 2.5.0). Deprecated: use jvm trait or read documentation.'
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -19143,16 +19129,14 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to route.
- This can be used to set route specific annotations
- For annotations options see https://docs.openshift.com/container-platform/3.11/architecture/networking/routes.html#route-specific-annotations
- CLI usage example: -t "route.annotations.'haproxy.router.openshift.io/balance'=true"
+ description: 'The annotations added to route. This can be
+ used to set route specific annotations For annotations options
+ see https://docs.openshift.com/container-platform/3.11/architecture/networking/routes.html#route-specific-annotations
+ CLI usage example: -t "route.annotations.''haproxy.router.openshift.io/balance''=true"'
type: object
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -19163,82 +19147,74 @@ spec:
description: To configure the host exposed by the route.
type: string
tlsCACertificate:
- description: |-
- The TLS CA certificate contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS CA certificate contents. \n Refer to
+ the OpenShift route documentation for additional information."
type: string
tlsCACertificateSecret:
- description: |-
- The secret name and key reference to the TLS CA certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the TLS
+ CA certificate. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only one
+ key in the secret it will be read, otherwise you can set
+ a key name separated with a \"/\". \n Refer to the OpenShift
+ route documentation for additional information."
type: string
tlsCertificate:
- description: |-
- The TLS certificate contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS certificate contents. \n Refer to the
+ OpenShift route documentation for additional information."
type: string
tlsCertificateSecret:
- description: |-
- The secret name and key reference to the TLS certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the TLS
+ certificate. The format is \"secret-name[/key-name]\", the
+ value represents the secret name, if there is only one key
+ in the secret it will be read, otherwise you can set a key
+ name separated with a \"/\". \n Refer to the OpenShift route
+ documentation for additional information."
type: string
tlsDestinationCACertificate:
- description: |-
- The destination CA certificate provides the contents of the ca certificate of the final destination. When using reencrypt
- termination this file should be provided in order to have routers use it for health checks on the secure connection.
- If this field is not specified, the router may provide its own destination CA and perform hostname validation using
- the short service name (service.namespace.svc), which allows infrastructure generated certificates to automatically
- verify.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The destination CA certificate provides the
+ contents of the ca certificate of the final destination.
+ \ When using reencrypt termination this file should be provided
+ in order to have routers use it for health checks on the
+ secure connection. If this field is not specified, the router
+ may provide its own destination CA and perform hostname
+ validation using the short service name (service.namespace.svc),
+ which allows infrastructure generated certificates to automatically
+ verify. \n Refer to the OpenShift route documentation for
+ additional information."
type: string
tlsDestinationCACertificateSecret:
- description: |-
- The secret name and key reference to the destination CA certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the destination
+ CA certificate. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only one
+ key in the secret it will be read, otherwise you can set
+ a key name separated with a \"/\". \n Refer to the OpenShift
+ route documentation for additional information."
type: string
tlsInsecureEdgeTerminationPolicy:
- description: |-
- To configure how to deal with insecure traffic, e.g. `Allow`, `Disable` or `Redirect` traffic.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "To configure how to deal with insecure traffic,
+ e.g. `Allow`, `Disable` or `Redirect` traffic. \n Refer
+ to the OpenShift route documentation for additional information."
enum:
- None
- Allow
- Redirect
type: string
tlsKey:
- description: |-
- The TLS certificate key contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS certificate key contents. \n Refer to
+ the OpenShift route documentation for additional information."
type: string
tlsKeySecret:
- description: |-
- The secret name and key reference to the TLS certificate key. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the TLS
+ certificate key. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only one
+ key in the secret it will be read, otherwise you can set
+ a key name separated with a \"/\". \n Refer to the OpenShift
+ route documentation for additional information."
type: string
tlsTermination:
- description: |-
- The TLS termination type, like `edge`, `passthrough` or `reencrypt`.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS termination type, like `edge`, `passthrough`
+ or `reencrypt`. \n Refer to the OpenShift route documentation
+ for additional information."
enum:
- edge
- reencrypt
@@ -19249,9 +19225,8 @@ spec:
description: The configuration of Security Context trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -19283,9 +19258,8 @@ spec:
needs to be created.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -19293,9 +19267,8 @@ spec:
traits share this common property.
type: boolean
nodePort:
- description: |-
- Enable Service to be exposed as NodePort (default `false`).
- Deprecated: Use service type instead.
+ description: 'Enable Service to be exposed as NodePort (default
+ `false`). Deprecated: Use service type instead.'
type: boolean
type:
description: The type of service to be used, either 'ClusterIP',
@@ -19310,9 +19283,8 @@ spec:
description: The configuration of Service Binding trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -19339,9 +19311,8 @@ spec:
description: The configuration of Toleration trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -19425,15 +19396,12 @@ spec:
the condition's last transition.
type: string
status:
- description: |-
- Status is the status of the condition.
- Can be True, False, Unknown.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
+ description: 'Status is the status of the condition.
+ Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions'
type: string
type:
- description: |-
- Type is the type of the condition.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
+ description: 'Type is the type of the condition. More
+ info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions'
type: string
required:
- status
@@ -19443,10 +19411,10 @@ spec:
items:
properties:
data:
- description: |-
- RawMessage is a raw encoded JSON value.
+ description: RawMessage is a raw encoded JSON value.
It implements Marshaler and Unmarshaler and can
- be used to delay JSON decoding or precompute a JSON encoding.
+ be used to delay JSON decoding or precompute a
+ JSON encoding.
x-kubernetes-preserve-unknown-fields: true
name:
type: string
@@ -19475,9 +19443,7 @@ spec:
type: object
type: array
configuration:
- description: |-
- Deprecated:
- a list of configuration specification
+ description: 'Deprecated: a list of configuration specification'
items:
description: ConfigurationSpec represents a generic configuration
specification.
@@ -19528,8 +19494,7 @@ spec:
description: True if the spec is generated from a Kamelet
type: boolean
interceptors:
- description: |-
- Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
+ description: Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
uses to pre/post process sources
items:
type: string
@@ -19539,9 +19504,8 @@ spec:
to interpret this source code
type: string
loader:
- description: |-
- Loader is an optional id of the org.apache.camel.k.RoutesLoader that will
- interpret this source at runtime
+ description: Loader is an optional id of the org.apache.camel.k.RoutesLoader
+ that will interpret this source at runtime
type: string
name:
description: the name of the specification
@@ -19576,43 +19540,35 @@ spec:
description: API version of the referent.
type: string
fieldPath:
- description: |-
- If referring to a piece of an object instead of an entire object, this string
- should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
- For example, if the object reference is to a container within a pod, this would take on a value like:
- "spec.containers{name}" (where "name" refers to the name of the container that triggered
- the event) or if no container name is specified "spec.containers[2]" (container with
- index 2 in this pod). This syntax is chosen only to have some well-defined way of
- referencing a part of an object.
- TODO: this design is not final and this field is subject to change in the future.
+ description: 'If referring to a piece of an object instead of
+ an entire object, this string should contain a valid JSON/Go
+ field access statement, such as desiredState.manifest.containers[2].
+ For example, if the object reference is to a container within
+ a pod, this would take on a value like: "spec.containers{name}"
+ (where "name" refers to the name of the container that triggered
+ the event) or if no container name is specified "spec.containers[2]"
+ (container with index 2 in this pod). This syntax is chosen
+ only to have some well-defined way of referencing a part of
+ an object. TODO: this design is not final and this field is
+ subject to change in the future.'
type: string
kind:
- description: |-
- Kind of the referent.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ 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: 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'
type: string
namespace:
- description: |-
- Namespace of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
+ description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type: string
resourceVersion:
- description: |-
- Specific resourceVersion to which this reference is made, if any.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
+ description: 'Specific resourceVersion to which this reference
+ is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
type: string
uid:
- description: |-
- UID of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
+ description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
type: string
type: object
- x-kubernetes-map-type: atomic
lastInitTimestamp:
description: the timestamp representing the last time when this integration
was initialized.
@@ -19658,12 +19614,19 @@ spec:
specReplicasPath: .spec.replicas
statusReplicasPath: .status.replicas
status: {}
+status:
+ acceptedNames:
+ kind: ""
+ plural: ""
+ conditions: []
+ storedVersions: []
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
- controller-gen.kubebuilder.io/version: v0.15.0
+ controller-gen.kubebuilder.io/version: v0.6.1
+ creationTimestamp: null
labels:
app: camel-k
name: kameletbindings.camel.apache.org
@@ -19699,19 +19662,14 @@ spec:
description: KameletBinding is the Schema for the kamelets binding API.
properties:
apiVersion:
- description: |-
- APIVersion defines the versioned schema of this representation of an object.
- Servers should convert recognized schemas to the latest internal value, and
- may reject unrecognized values.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+ description: 'APIVersion defines the versioned schema of this representation
+ of an object. Servers should convert recognized schemas to the latest
+ internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: |-
- Kind is a string value representing the REST resource this object represents.
- Servers may infer this from the endpoint the client submits requests to.
- Cannot be updated.
- In CamelCase.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ description: 'Kind is a string value representing the REST resource this
+ object represents. Servers may infer this from the endpoint the client
+ submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
@@ -19728,12 +19686,10 @@ spec:
custom parameters
properties:
configuration:
- description: |-
- Deprecated:
- Use camel trait (camel.properties) to manage properties
- Use mount trait (mount.configs) to manage configs
- Use mount trait (mount.resources) to manage resources
- Use mount trait (mount.volumes) to manage volumes
+ description: 'Deprecated: Use camel trait (camel.properties) to
+ manage properties Use mount trait (mount.configs) to manage
+ configs Use mount trait (mount.resources) to manage resources
+ Use mount trait (mount.volumes) to manage volumes'
items:
description: ConfigurationSpec represents a generic configuration
specification.
@@ -19774,43 +19730,35 @@ spec:
description: API version of the referent.
type: string
fieldPath:
- description: |-
- If referring to a piece of an object instead of an entire object, this string
- should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
- For example, if the object reference is to a container within a pod, this would take on a value like:
- "spec.containers{name}" (where "name" refers to the name of the container that triggered
- the event) or if no container name is specified "spec.containers[2]" (container with
- index 2 in this pod). This syntax is chosen only to have some well-defined way of
- referencing a part of an object.
- TODO: this design is not final and this field is subject to change in the future.
+ description: 'If referring to a piece of an object instead
+ of an entire object, this string should contain a valid
+ JSON/Go field access statement, such as desiredState.manifest.containers[2].
+ For example, if the object reference is to a container within
+ a pod, this would take on a value like: "spec.containers{name}"
+ (where "name" refers to the name of the container that triggered
+ the event) or if no container name is specified "spec.containers[2]"
+ (container with index 2 in this pod). This syntax is chosen
+ only to have some well-defined way of referencing a part
+ of an object. TODO: this design is not final and this field
+ is subject to change in the future.'
type: string
kind:
- description: |-
- Kind of the referent.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ 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: 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'
type: string
namespace:
- description: |-
- Namespace of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
+ description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type: string
resourceVersion:
- description: |-
- Specific resourceVersion to which this reference is made, if any.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
+ description: 'Specific resourceVersion to which this reference
+ is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
type: string
uid:
- description: |-
- UID of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
+ description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
type: string
type: object
- x-kubernetes-map-type: atomic
profile:
description: the profile needed to run this Integration
type: string
@@ -19851,8 +19799,7 @@ spec:
description: True if the spec is generated from a Kamelet
type: boolean
interceptors:
- description: |-
- Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
+ description: Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
uses to pre/post process sources
items:
type: string
@@ -19862,9 +19809,8 @@ spec:
to interpret this source code
type: string
loader:
- description: |-
- Loader is an optional id of the org.apache.camel.k.RoutesLoader that will
- interpret this source at runtime
+ description: Loader is an optional id of the org.apache.camel.k.RoutesLoader
+ that will interpret this source at runtime
type: string
name:
description: the name of the specification
@@ -19908,35 +19854,39 @@ spec:
want to run within a pod.
properties:
args:
- description: |-
- Arguments to the entrypoint.
- The container image's CMD is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Arguments to the entrypoint. The container
+ image''s CMD is used if this is not provided.
+ Variable references $(VAR_NAME) are expanded using
+ the container''s environment. If a variable cannot
+ be resolved, the reference in the input string
+ will be unchanged. Double $$ are reduced to a
+ single $, which allows for escaping the $(VAR_NAME)
+ syntax: i.e. "$$(VAR_NAME)" will produce the string
+ literal "$(VAR_NAME)". Escaped references will
+ never be expanded, regardless of whether the variable
+ exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
command:
- description: |-
- Entrypoint array. Not executed within a shell.
- The container image's ENTRYPOINT is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Entrypoint array. Not executed within
+ a shell. The container image''s ENTRYPOINT is
+ used if this is not provided. Variable references
+ $(VAR_NAME) are expanded using the container''s
+ environment. If a variable cannot be resolved,
+ the reference in the input string will be unchanged.
+ Double $$ are reduced to a single $, which allows
+ for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)"
+ will produce the string literal "$(VAR_NAME)".
+ Escaped references will never be expanded, regardless
+ of whether the variable exists or not. Cannot
+ be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
env:
- description: |-
- List of environment variables to set in the container.
- Cannot be updated.
+ description: List of environment variables to set
+ in the container. Cannot be updated.
items:
description: EnvVar represents an environment
variable present in a Container.
@@ -19946,16 +19896,18 @@ spec:
Must be a C_IDENTIFIER.
type: string
value:
- description: |-
- Variable references $(VAR_NAME) are expanded
- using the previously defined environment variables in the container and
- any service environment variables. If a variable cannot be resolved,
- the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
- "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
- Escaped references will never be expanded, regardless of whether the variable
- exists or not.
- Defaults to "".
+ description: 'Variable references $(VAR_NAME)
+ are expanded using the previously defined
+ environment variables in the container and
+ any service environment variables. If a
+ variable cannot be resolved, the reference
+ in the input string will be unchanged. Double
+ $$ are reduced to a single $, which allows
+ for escaping the $(VAR_NAME) syntax: i.e.
+ "$$(VAR_NAME)" will produce the string literal
+ "$(VAR_NAME)". Escaped references will never
+ be expanded, regardless of whether the variable
+ exists or not. Defaults to "".'
type: string
valueFrom:
description: Source for the environment variable's
@@ -19968,10 +19920,10 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
+ description: 'Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
@@ -19980,11 +19932,12 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
fieldRef:
- description: |-
- Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`,
- spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ description: 'Selects a field of the pod:
+ supports metadata.name, metadata.namespace,
+ `metadata.labels['''']`, `metadata.annotations['''']`,
+ spec.nodeName, spec.serviceAccountName,
+ status.hostIP, status.podIP, status.podIPs.'
properties:
apiVersion:
description: Version of the schema
@@ -19998,11 +19951,13 @@ spec:
required:
- fieldPath
type: object
- x-kubernetes-map-type: atomic
resourceFieldRef:
- description: |-
- Selects a resource of the container: only resources limits and requests
- (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
+ description: 'Selects a resource of the
+ container: only resources limits and
+ requests (limits.cpu, limits.memory,
+ limits.ephemeral-storage, requests.cpu,
+ requests.memory and requests.ephemeral-storage)
+ are currently supported.'
properties:
containerName:
description: 'Container name: required
@@ -20024,7 +19979,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret
in the pod's namespace
@@ -20035,10 +19989,10 @@ spec:
secret key.
type: string
name:
- description: |-
- Name of the referent.
+ description: 'Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret
@@ -20047,20 +20001,21 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
required:
- name
type: object
type: array
envFrom:
- description: |-
- List of sources to populate environment variables in the container.
- The keys defined within a source must be a C_IDENTIFIER. All invalid keys
- will be reported as an event when the container is starting. When a key exists in multiple
- sources, the value associated with the last source will take precedence.
- Values defined by an Env with a duplicate key will take precedence.
- Cannot be updated.
+ description: List of sources to populate environment
+ variables in the container. The keys defined within
+ a source must be a C_IDENTIFIER. All invalid keys
+ will be reported as an event when the container
+ is starting. When a key exists in multiple sources,
+ the value associated with the last source will
+ take precedence. Values defined by an Env with
+ a duplicate key will take precedence. Cannot be
+ updated.
items:
description: EnvFromSource represents the source
of a set of ConfigMaps
@@ -20069,17 +20024,16 @@ spec:
description: The ConfigMap to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
prefix:
description: An optional identifier to prepend
to each key in the ConfigMap. Must be a
@@ -20089,57 +20043,59 @@ spec:
description: The Secret to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret
must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
image:
- description: |-
- Container image name.
- More info: https://kubernetes.io/docs/concepts/containers/images
- This field is optional to allow higher level config management to default or override
- container images in workload controllers like Deployments and StatefulSets.
+ description: 'Container image name. More info: https://kubernetes.io/docs/concepts/containers/images
+ This field is optional to allow higher level config
+ management to default or override container images
+ in workload controllers like Deployments and StatefulSets.'
type: string
imagePullPolicy:
- description: |-
- Image pull policy.
- One of Always, Never, IfNotPresent.
- Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
+ description: 'Image pull policy. One of Always,
+ Never, IfNotPresent. Defaults to Always if :latest
+ tag is specified, or IfNotPresent otherwise. Cannot
+ be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
- description: |-
- Actions that the management system should take in response to container lifecycle events.
- Cannot be updated.
+ description: Actions that the management system
+ should take in response to container lifecycle
+ events. Cannot be updated.
properties:
postStart:
- description: |-
- PostStart is called immediately after a container is created. If the handler fails,
- the container is terminated and restarted according to its restart policy.
- Other management of the container blocks until the hook completes.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PostStart is called immediately
+ after a container is created. If the handler
+ fails, the container is terminated and restarted
+ according to its restart policy. Other management
+ of the container blocks until the hook completes.
+ More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to
take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command
+ line to execute inside the container,
+ the working directory for the command is
+ root ('/') in the container's filesystem.
+ The command is simply exec'd, it is
+ not run inside a shell, so traditional
+ shell instructions ('|', etc) won't
+ work. To use a shell, you need to
+ explicitly call out to that shell.
+ Exit status of 0 is treated as live/healthy
+ and non-zero is unhealthy.
items:
type: string
type: array
@@ -20149,9 +20105,10 @@ spec:
request to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to,
+ defaults to the pod IP. You probably
+ want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
description: Custom headers to set in
@@ -20163,9 +20120,11 @@ spec:
probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field
+ name. This will be canonicalized
+ upon output, so case-variant
+ names will be understood as
+ the same header.
type: string
value:
description: The header field
@@ -20184,15 +20143,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -20211,10 +20169,12 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT
+ supported as a LifecycleHandler and kept
+ for the backward compatibility. There
+ are no validation of this field and lifecycle
+ hooks will fail in runtime when tcp handler
+ is specified.
properties:
host:
description: 'Optional: Host name to
@@ -20224,38 +20184,47 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
preStop:
- description: |-
- PreStop is called immediately before a container is terminated due to an
- API request or management event such as liveness/startup probe failure,
- preemption, resource contention, etc. The handler is not called if the
- container crashes or exits. The Pod's termination grace period countdown begins before the
- PreStop hook is executed. Regardless of the outcome of the handler, the
- container will eventually terminate within the Pod's termination grace
- period (unless delayed by finalizers). Other management of the container blocks until the hook completes
- or until the termination grace period is reached.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PreStop is called immediately
+ before a container is terminated due to an
+ API request or management event such as liveness/startup
+ probe failure, preemption, resource contention,
+ etc. The handler is not called if the container
+ crashes or exits. The Pod''s termination grace
+ period countdown begins before the PreStop
+ hook is executed. Regardless of the outcome
+ of the handler, the container will eventually
+ terminate within the Pod''s termination grace
+ period (unless delayed by finalizers). Other
+ management of the container blocks until the
+ hook completes or until the termination grace
+ period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to
take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command
+ line to execute inside the container,
+ the working directory for the command is
+ root ('/') in the container's filesystem.
+ The command is simply exec'd, it is
+ not run inside a shell, so traditional
+ shell instructions ('|', etc) won't
+ work. To use a shell, you need to
+ explicitly call out to that shell.
+ Exit status of 0 is treated as live/healthy
+ and non-zero is unhealthy.
items:
type: string
type: array
@@ -20265,9 +20234,10 @@ spec:
request to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to,
+ defaults to the pod IP. You probably
+ want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
description: Custom headers to set in
@@ -20279,9 +20249,11 @@ spec:
probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field
+ name. This will be canonicalized
+ upon output, so case-variant
+ names will be understood as
+ the same header.
type: string
value:
description: The header field
@@ -20300,15 +20272,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -20327,10 +20298,12 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT
+ supported as a LifecycleHandler and kept
+ for the backward compatibility. There
+ are no validation of this field and lifecycle
+ hooks will fail in runtime when tcp handler
+ is specified.
properties:
host:
description: 'Optional: Host name to
@@ -20340,10 +20313,10 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
@@ -20351,30 +20324,33 @@ spec:
type: object
type: object
livenessProbe:
- description: |-
- Periodic probe of container liveness.
+ 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
+ Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -20387,12 +20363,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -20402,8 +20377,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -20414,9 +20389,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -20434,35 +20410,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -20477,59 +20453,63 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
name:
- description: |-
- Name of the container specified as a DNS_LABEL.
- Each container in a pod must have a unique name (DNS_LABEL).
- Cannot be updated.
+ description: Name of the container specified as
+ a DNS_LABEL. Each container in a pod must have
+ a unique name (DNS_LABEL). Cannot be updated.
type: string
ports:
- description: |-
- List of ports to expose from the container. Not specifying a port here
- DOES NOT prevent that port from being exposed. Any port which is
- listening on the default "0.0.0.0" address inside a container will be
- accessible from the network.
- Modifying this array with strategic merge patch may corrupt the data.
- For more information See https://github.com/kubernetes/kubernetes/issues/108255.
+ description: List of ports to expose from the container.
+ Not specifying a port here DOES NOT prevent that
+ port from being exposed. Any port which is listening
+ on the default "0.0.0.0" address inside a container
+ will be accessible from the network. Modifying
+ this array with strategic merge patch may corrupt
+ the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255.
Cannot be updated.
items:
description: ContainerPort represents a network
port in a single container.
properties:
containerPort:
- description: |-
- Number of port to expose on the pod's IP address.
- This must be a valid port number, 0 < x < 65536.
+ description: Number of port to expose on the
+ pod's IP address. This must be a valid port
+ number, 0 < x < 65536.
format: int32
type: integer
hostIP:
@@ -20537,24 +20517,24 @@ spec:
port to.
type: string
hostPort:
- description: |-
- Number of port to expose on the host.
- If specified, this must be a valid port number, 0 < x < 65536.
- If HostNetwork is specified, this must match ContainerPort.
+ description: Number of port to expose on the
+ host. If specified, this must be a valid
+ port number, 0 < x < 65536. If HostNetwork
+ is specified, this must match ContainerPort.
Most containers do not need this.
format: int32
type: integer
name:
- description: |-
- If specified, this must be an IANA_SVC_NAME and unique within the pod. Each
- named port in a pod must have a unique name. Name for the port that can be
- referred to by services.
+ description: If specified, this must be an
+ IANA_SVC_NAME and unique within the pod.
+ Each named port in a pod must have a unique
+ name. Name for the port that can be referred
+ to by services.
type: string
protocol:
default: TCP
- description: |-
- Protocol for port. Must be UDP, TCP, or SCTP.
- Defaults to "TCP".
+ description: Protocol for port. Must be UDP,
+ TCP, or SCTP. Defaults to "TCP".
type: string
required:
- containerPort
@@ -20565,30 +20545,34 @@ spec:
- protocol
x-kubernetes-list-type: map
readinessProbe:
- description: |-
- Periodic probe of container service readiness.
- Container will be removed from service endpoints if the probe fails.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Periodic probe of container service
+ readiness. Container will be removed from service
+ endpoints if the probe fails. Cannot be updated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -20601,12 +20585,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -20616,8 +20599,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -20628,9 +20611,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -20648,35 +20632,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -20691,33 +20675,38 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
@@ -20728,14 +20717,14 @@ spec:
resource resize policy for the container.
properties:
resourceName:
- description: |-
- Name of the resource to which this resource resize policy applies.
- Supported values: cpu, memory.
+ description: 'Name of the resource to which
+ this resource resize policy applies. Supported
+ values: cpu, memory.'
type: string
restartPolicy:
- description: |-
- Restart policy to apply when specified resource is resized.
- If not specified, it defaults to NotRequired.
+ description: Restart policy to apply when
+ specified resource is resized. If not specified,
+ it defaults to NotRequired.
type: string
required:
- resourceName
@@ -20744,31 +20733,26 @@ spec:
type: array
x-kubernetes-list-type: atomic
resources:
- description: |-
- Compute Resources required by this container.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Compute Resources required by this
+ container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
properties:
claims:
- description: |-
- Claims lists the names of resources, defined in spec.resourceClaims,
- that are used by this container.
-
-
- This is an alpha field and requires enabling the
- DynamicResourceAllocation feature gate.
-
-
- This field is immutable. It can only be set for containers.
+ description: "Claims lists the names of resources,
+ defined in spec.resourceClaims, that are used
+ by this container. \n This is an alpha field
+ and requires enabling the DynamicResourceAllocation
+ feature gate. \n This field is immutable.
+ It can only be set for containers."
items:
description: ResourceClaim references one
entry in PodSpec.ResourceClaims.
properties:
name:
- description: |-
- Name must match the name of one entry in pod.spec.resourceClaims of
- the Pod where this field is used. It makes that resource available
- inside a container.
+ description: Name must match the name
+ of one entry in pod.spec.resourceClaims
+ of the Pod where this field is used.
+ It makes that resource available inside
+ a container.
type: string
required:
- name
@@ -20784,9 +20768,8 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Limits describes the maximum amount of compute resources allowed.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Limits describes the maximum amount
+ of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -20795,52 +20778,61 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Requests describes the minimum amount of compute resources required.
- If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
- otherwise to an implementation-defined value. Requests cannot exceed Limits.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Requests describes the minimum
+ amount of compute resources required. If Requests
+ is omitted for a container, it defaults to
+ Limits if that is explicitly specified, otherwise
+ to an implementation-defined value. Requests
+ cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
restartPolicy:
- description: |-
- RestartPolicy defines the restart behavior of individual containers in a pod.
- This field may only be set for init containers, and the only allowed value is "Always".
- For non-init containers or when this field is not specified,
- the restart behavior is defined by the Pod's restart policy and the container type.
- Setting the RestartPolicy as "Always" for the init container will have the following effect:
- this init container will be continually restarted on
- exit until all regular containers have terminated. Once all regular
- containers have completed, all init containers with restartPolicy "Always"
- will be shut down. This lifecycle differs from normal init containers and
- is often referred to as a "sidecar" container. Although this init
- container still starts in the init container sequence, it does not wait
- for the container to complete before proceeding to the next init
- container. Instead, the next init container starts immediately after this
- init container is started, or after any startupProbe has successfully
- completed.
+ description: 'RestartPolicy defines the restart
+ behavior of individual containers in a pod. This
+ field may only be set for init containers, and
+ the only allowed value is "Always". For non-init
+ containers or when this field is not specified,
+ the restart behavior is defined by the Pod''s
+ restart policy and the container type. Setting
+ the RestartPolicy as "Always" for the init container
+ will have the following effect: this init container
+ will be continually restarted on exit until all
+ regular containers have terminated. Once all regular
+ containers have completed, all init containers
+ with restartPolicy "Always" will be shut down.
+ This lifecycle differs from normal init containers
+ and is often referred to as a "sidecar" container.
+ Although this init container still starts in the
+ init container sequence, it does not wait for
+ the container to complete before proceeding to
+ the next init container. Instead, the next init
+ container starts immediately after this init container
+ is started, or after any startupProbe has successfully
+ completed.'
type: string
securityContext:
- description: |-
- SecurityContext defines the security options the container should be run with.
- If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
- More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
+ description: 'SecurityContext defines the security
+ options the container should be run with. If set,
+ the fields of SecurityContext override the equivalent
+ fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
properties:
allowPrivilegeEscalation:
- description: |-
- AllowPrivilegeEscalation controls whether a process can gain more
- privileges than its parent process. This bool directly controls if
- the no_new_privs flag will be set on the container process.
- AllowPrivilegeEscalation is true always when the container is:
- 1) run as Privileged
- 2) has CAP_SYS_ADMIN
- Note that this field cannot be set when spec.os.name is windows.
+ description: 'AllowPrivilegeEscalation controls
+ whether a process can gain more privileges
+ than its parent process. This bool directly
+ controls if the no_new_privs flag will be
+ set on the container process. AllowPrivilegeEscalation
+ is true always when the container is: 1) run
+ as Privileged 2) has CAP_SYS_ADMIN Note that
+ this field cannot be set when spec.os.name
+ is windows.'
type: boolean
capabilities:
- description: |-
- The capabilities to add/drop when running containers.
- Defaults to the default set of capabilities granted by the container runtime.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The capabilities to add/drop when
+ running containers. Defaults to the default
+ set of capabilities granted by the container
+ runtime. Note that this field cannot be set
+ when spec.os.name is windows.
properties:
add:
description: Added capabilities
@@ -20858,60 +20850,69 @@ spec:
type: array
type: object
privileged:
- description: |-
- Run container in privileged mode.
- Processes in privileged containers are essentially equivalent to root on the host.
- Defaults to false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Run container in privileged mode.
+ Processes in privileged containers are essentially
+ equivalent to root on the host. Defaults to
+ false. Note that this field cannot be set
+ when spec.os.name is windows.
type: boolean
procMount:
- description: |-
- procMount denotes the type of proc mount to use for the containers.
- The default is DefaultProcMount which uses the container runtime defaults for
- readonly paths and masked paths.
- This requires the ProcMountType feature flag to be enabled.
- Note that this field cannot be set when spec.os.name is windows.
+ description: procMount denotes the type of proc
+ mount to use for the containers. The default
+ is DefaultProcMount which uses the container
+ runtime defaults for readonly paths and masked
+ paths. This requires the ProcMountType feature
+ flag to be enabled. Note that this field cannot
+ be set when spec.os.name is windows.
type: string
readOnlyRootFilesystem:
- description: |-
- Whether this container has a read-only root filesystem.
- Default is false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Whether this container has a read-only
+ root filesystem. Default is false. Note that
+ this field cannot be set when spec.os.name
+ is windows.
type: boolean
runAsGroup:
- description: |-
- The GID to run the entrypoint of the container process.
- Uses runtime default if unset.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The GID to run the entrypoint of
+ the container process. Uses runtime default
+ if unset. May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is windows.
format: int64
type: integer
runAsNonRoot:
- description: |-
- Indicates that the container must run as a non-root user.
- If true, the Kubelet will validate the image at runtime to ensure that it
- does not run as UID 0 (root) and fail to start the container if it does.
- If unset or false, no such validation will be performed.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: Indicates that the container must
+ run as a non-root user. If true, the Kubelet
+ will validate the image at runtime to ensure
+ that it does not run as UID 0 (root) and fail
+ to start the container if it does. If unset
+ or false, no such validation will be performed.
+ May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence.
type: boolean
runAsUser:
- description: |-
- The UID to run the entrypoint of the container process.
- Defaults to user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The UID to run the entrypoint of
+ the container process. Defaults to user specified
+ in image metadata if unspecified. May also
+ be set in PodSecurityContext. If set in both
+ SecurityContext and PodSecurityContext, the
+ value specified in SecurityContext takes precedence.
+ Note that this field cannot be set when spec.os.name
+ is windows.
format: int64
type: integer
seLinuxOptions:
- description: |-
- The SELinux context to be applied to the container.
- If unspecified, the container runtime will allocate a random SELinux context for each
- container. May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The SELinux context to be applied
+ to the container. If unspecified, the container
+ runtime will allocate a random SELinux context
+ for each container. May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is windows.
properties:
level:
description: Level is SELinux level label
@@ -20931,93 +20932,112 @@ spec:
type: string
type: object
seccompProfile:
- description: |-
- The seccomp options to use by this container. If seccomp options are
- provided at both the pod & container level, the container options
- override the pod options.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The seccomp options to use by this
+ container. If seccomp options are provided
+ at both the pod & container level, the container
+ options override the pod options. Note that
+ this field cannot be set when spec.os.name
+ is windows.
properties:
localhostProfile:
- description: |-
- localhostProfile indicates a profile defined in a file on the node should be used.
- The profile must be preconfigured on the node to work.
- Must be a descending path, relative to the kubelet's configured seccomp profile location.
- Must be set if type is "Localhost". Must NOT be set for any other type.
+ description: localhostProfile indicates
+ a profile defined in a file on the node
+ should be used. The profile must be preconfigured
+ on the node to work. Must be a descending
+ path, relative to the kubelet's configured
+ seccomp profile location. Must be set
+ if type is "Localhost". Must NOT be set
+ for any other type.
type: string
type:
- description: |-
- type indicates which kind of seccomp profile will be applied.
- Valid options are:
-
-
- Localhost - a profile defined in a file on the node should be used.
- RuntimeDefault - the container runtime default profile should be used.
- Unconfined - no profile should be applied.
+ description: "type indicates which kind
+ of seccomp profile will be applied. Valid
+ options are: \n Localhost - a profile
+ defined in a file on the node should be
+ used. RuntimeDefault - the container runtime
+ default profile should be used. Unconfined
+ - no profile should be applied."
type: string
required:
- type
type: object
windowsOptions:
- description: |-
- The Windows specific settings applied to all containers.
- If unspecified, the options from the PodSecurityContext will be used.
- If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is linux.
+ description: The Windows specific settings applied
+ to all containers. If unspecified, the options
+ from the PodSecurityContext will be used.
+ If set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is linux.
properties:
gmsaCredentialSpec:
- description: |-
- GMSACredentialSpec is where the GMSA admission webhook
- (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
- GMSA credential spec named by the GMSACredentialSpecName field.
+ description: GMSACredentialSpec is where
+ the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa)
+ inlines the contents of the GMSA credential
+ spec named by the GMSACredentialSpecName
+ field.
type: string
gmsaCredentialSpecName:
description: GMSACredentialSpecName is the
name of the GMSA credential spec to use.
type: string
hostProcess:
- description: |-
- HostProcess determines if a container should be run as a 'Host Process' container.
- All of a Pod's containers must have the same effective HostProcess value
- (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
- In addition, if HostProcess is true then HostNetwork must also be set to true.
+ description: HostProcess determines if a
+ container should be run as a 'Host Process'
+ container. All of a Pod's containers must
+ have the same effective HostProcess value
+ (it is not allowed to have a mix of HostProcess
+ containers and non-HostProcess containers).
+ In addition, if HostProcess is true then
+ HostNetwork must also be set to true.
type: boolean
runAsUserName:
- description: |-
- The UserName in Windows to run the entrypoint of the container process.
- Defaults to the user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: The UserName in Windows to
+ run the entrypoint of the container process.
+ Defaults to the user specified in image
+ metadata if unspecified. May also be set
+ in PodSecurityContext. If set in both
+ SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext
+ takes precedence.
type: string
type: object
type: object
startupProbe:
- description: |-
- StartupProbe indicates that the Pod has successfully initialized.
- If specified, no other probes are executed until this completes successfully.
- If this probe fails, the Pod will be restarted, just as if the livenessProbe failed.
- This can be used to provide different probe parameters at the beginning of a Pod's lifecycle,
- when it might take a long time to load data or warm a cache, than during steady-state operation.
- This cannot be updated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'StartupProbe indicates that the Pod
+ has successfully initialized. If specified, no
+ other probes are executed until this completes
+ successfully. If this probe fails, the Pod will
+ be restarted, just as if the livenessProbe failed.
+ This can be used to provide different probe parameters
+ at the beginning of a Pod''s lifecycle, when it
+ might take a long time to load data or warm a
+ cache, than during steady-state operation. This
+ cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -21030,12 +21050,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -21045,8 +21064,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -21057,9 +21076,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -21077,35 +21097,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -21120,76 +21140,87 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
stdin:
- description: |-
- Whether this container should allocate a buffer for stdin in the container runtime. If this
- is not set, reads from stdin in the container will always result in EOF.
- Default is false.
+ description: Whether this container should allocate
+ a buffer for stdin in the container runtime. If
+ this is not set, reads from stdin in the container
+ will always result in EOF. Default is false.
type: boolean
stdinOnce:
- description: |-
- Whether the container runtime should close the stdin channel after it has been opened by
- a single attach. When stdin is true the stdin stream will remain open across multiple attach
- sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
- first client attaches to stdin, and then remains open and accepts data until the client disconnects,
- at which time stdin is closed and remains closed until the container is restarted. If this
- flag is false, a container processes that reads from stdin will never receive an EOF.
- Default is false
+ description: Whether the container runtime should
+ close the stdin channel after it has been opened
+ by a single attach. When stdin is true the stdin
+ stream will remain open across multiple attach
+ sessions. If stdinOnce is set to true, stdin is
+ opened on container start, is empty until the
+ first client attaches to stdin, and then remains
+ open and accepts data until the client disconnects,
+ at which time stdin is closed and remains closed
+ until the container is restarted. If this flag
+ is false, a container processes that reads from
+ stdin will never receive an EOF. Default is false
type: boolean
terminationMessagePath:
- description: |-
- Optional: Path at which the file to which the container's termination message
- will be written is mounted into the container's filesystem.
- Message written is intended to be brief final status, such as an assertion failure message.
- Will be truncated by the node if greater than 4096 bytes. The total message length across
- all containers will be limited to 12kb.
- Defaults to /dev/termination-log.
- Cannot be updated.
+ description: 'Optional: Path at which the file to
+ which the container''s termination message will
+ be written is mounted into the container''s filesystem.
+ Message written is intended to be brief final
+ status, such as an assertion failure message.
+ Will be truncated by the node if greater than
+ 4096 bytes. The total message length across all
+ containers will be limited to 12kb. Defaults to
+ /dev/termination-log. Cannot be updated.'
type: string
terminationMessagePolicy:
- description: |-
- Indicate how the termination message should be populated. File will use the contents of
- terminationMessagePath to populate the container status message on both success and failure.
- FallbackToLogsOnError will use the last chunk of container log output if the termination
- message file is empty and the container exited with an error.
- The log output is limited to 2048 bytes or 80 lines, whichever is smaller.
- Defaults to File.
- Cannot be updated.
+ description: Indicate how the termination message
+ should be populated. File will use the contents
+ of terminationMessagePath to populate the container
+ status message on both success and failure. FallbackToLogsOnError
+ will use the last chunk of container log output
+ if the termination message file is empty and the
+ container exited with an error. The log output
+ is limited to 2048 bytes or 80 lines, whichever
+ is smaller. Defaults to File. Cannot be updated.
type: string
tty:
- description: |-
- Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
- Default is false.
+ description: Whether this container should allocate
+ a TTY for itself, also requires 'stdin' to be
+ true. Default is false.
type: boolean
volumeDevices:
description: volumeDevices is the list of block
@@ -21213,45 +21244,46 @@ spec:
type: object
type: array
volumeMounts:
- description: |-
- Pod volumes to mount into the container's filesystem.
- Cannot be updated.
+ description: Pod volumes to mount into the container's
+ filesystem. Cannot be updated.
items:
description: VolumeMount describes a mounting
of a Volume within a container.
properties:
mountPath:
- description: |-
- Path within the container at which the volume should be mounted. Must
+ description: Path within the container at
+ which the volume should be mounted. Must
not contain ':'.
type: string
mountPropagation:
- description: |-
- mountPropagation determines how mounts are propagated from the host
- to container and the other way around.
- When not set, MountPropagationNone is used.
- This field is beta in 1.10.
+ description: mountPropagation determines how
+ mounts are propagated from the host to container
+ and the other way around. When not set,
+ MountPropagationNone is used. This field
+ is beta in 1.10.
type: string
name:
description: This must match the Name of a
Volume.
type: string
readOnly:
- description: |-
- Mounted read-only if true, read-write otherwise (false or unspecified).
- Defaults to false.
+ description: Mounted read-only if true, read-write
+ otherwise (false or unspecified). Defaults
+ to false.
type: boolean
subPath:
- description: |-
- Path within the volume from which the container's volume should be mounted.
+ description: Path within the volume from which
+ the container's volume should be mounted.
Defaults to "" (volume's root).
type: string
subPathExpr:
- description: |-
- Expanded path within the volume from which the container's volume should be mounted.
- Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.
- Defaults to "" (volume's root).
- SubPathExpr and SubPath are mutually exclusive.
+ description: Expanded path within the volume
+ from which the container's volume should
+ be mounted. Behaves similarly to SubPath
+ but environment variable references $(VAR_NAME)
+ are expanded using the container's environment.
+ Defaults to "" (volume's root). SubPathExpr
+ and SubPath are mutually exclusive.
type: string
required:
- mountPath
@@ -21259,11 +21291,10 @@ spec:
type: object
type: array
workingDir:
- description: |-
- Container's working directory.
- If not specified, the container runtime's default will be used, which
- might be configured in the container image.
- Cannot be updated.
+ description: Container's working directory. If not
+ specified, the container runtime's default will
+ be used, which might be configured in the container
+ image. Cannot be updated.
type: string
required:
- name
@@ -21275,47 +21306,51 @@ spec:
ephemeralContainers:
description: EphemeralContainers
items:
- description: |-
- An EphemeralContainer is a temporary container that you may add to an existing Pod for
- user-initiated activities such as debugging. Ephemeral containers have no resource or
- scheduling guarantees, and they will not be restarted when they exit or when a Pod is
- removed or restarted. The kubelet may evict a Pod if an ephemeral container causes the
- Pod to exceed its resource allocation.
-
-
- To add an ephemeral container, use the ephemeralcontainers subresource of an existing
- Pod. Ephemeral containers may not be removed or restarted.
+ description: "An EphemeralContainer is a temporary container
+ that you may add to an existing Pod for user-initiated
+ activities such as debugging. Ephemeral containers
+ have no resource or scheduling guarantees, and they
+ will not be restarted when they exit or when a Pod
+ is removed or restarted. The kubelet may evict a Pod
+ if an ephemeral container causes the Pod to exceed
+ its resource allocation. \n To add an ephemeral container,
+ use the ephemeralcontainers subresource of an existing
+ Pod. Ephemeral containers may not be removed or restarted."
properties:
args:
- description: |-
- Arguments to the entrypoint.
- The image's CMD is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Arguments to the entrypoint. The image''s
+ CMD is used if this is not provided. Variable
+ references $(VAR_NAME) are expanded using the
+ container''s environment. If a variable cannot
+ be resolved, the reference in the input string
+ will be unchanged. Double $$ are reduced to a
+ single $, which allows for escaping the $(VAR_NAME)
+ syntax: i.e. "$$(VAR_NAME)" will produce the string
+ literal "$(VAR_NAME)". Escaped references will
+ never be expanded, regardless of whether the variable
+ exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
command:
- description: |-
- Entrypoint array. Not executed within a shell.
- The image's ENTRYPOINT is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Entrypoint array. Not executed within
+ a shell. The image''s ENTRYPOINT is used if this
+ is not provided. Variable references $(VAR_NAME)
+ are expanded using the container''s environment.
+ If a variable cannot be resolved, the reference
+ in the input string will be unchanged. Double
+ $$ are reduced to a single $, which allows for
+ escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)"
+ will produce the string literal "$(VAR_NAME)".
+ Escaped references will never be expanded, regardless
+ of whether the variable exists or not. Cannot
+ be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
env:
- description: |-
- List of environment variables to set in the container.
- Cannot be updated.
+ description: List of environment variables to set
+ in the container. Cannot be updated.
items:
description: EnvVar represents an environment
variable present in a Container.
@@ -21325,16 +21360,18 @@ spec:
Must be a C_IDENTIFIER.
type: string
value:
- description: |-
- Variable references $(VAR_NAME) are expanded
- using the previously defined environment variables in the container and
- any service environment variables. If a variable cannot be resolved,
- the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
- "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
- Escaped references will never be expanded, regardless of whether the variable
- exists or not.
- Defaults to "".
+ description: 'Variable references $(VAR_NAME)
+ are expanded using the previously defined
+ environment variables in the container and
+ any service environment variables. If a
+ variable cannot be resolved, the reference
+ in the input string will be unchanged. Double
+ $$ are reduced to a single $, which allows
+ for escaping the $(VAR_NAME) syntax: i.e.
+ "$$(VAR_NAME)" will produce the string literal
+ "$(VAR_NAME)". Escaped references will never
+ be expanded, regardless of whether the variable
+ exists or not. Defaults to "".'
type: string
valueFrom:
description: Source for the environment variable's
@@ -21347,10 +21384,10 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
+ description: 'Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
@@ -21359,11 +21396,12 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
fieldRef:
- description: |-
- Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`,
- spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ description: 'Selects a field of the pod:
+ supports metadata.name, metadata.namespace,
+ `metadata.labels['''']`, `metadata.annotations['''']`,
+ spec.nodeName, spec.serviceAccountName,
+ status.hostIP, status.podIP, status.podIPs.'
properties:
apiVersion:
description: Version of the schema
@@ -21377,11 +21415,13 @@ spec:
required:
- fieldPath
type: object
- x-kubernetes-map-type: atomic
resourceFieldRef:
- description: |-
- Selects a resource of the container: only resources limits and requests
- (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
+ description: 'Selects a resource of the
+ container: only resources limits and
+ requests (limits.cpu, limits.memory,
+ limits.ephemeral-storage, requests.cpu,
+ requests.memory and requests.ephemeral-storage)
+ are currently supported.'
properties:
containerName:
description: 'Container name: required
@@ -21403,7 +21443,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret
in the pod's namespace
@@ -21414,10 +21453,10 @@ spec:
secret key.
type: string
name:
- description: |-
- Name of the referent.
+ description: 'Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret
@@ -21426,20 +21465,21 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
required:
- name
type: object
type: array
envFrom:
- description: |-
- List of sources to populate environment variables in the container.
- The keys defined within a source must be a C_IDENTIFIER. All invalid keys
- will be reported as an event when the container is starting. When a key exists in multiple
- sources, the value associated with the last source will take precedence.
- Values defined by an Env with a duplicate key will take precedence.
- Cannot be updated.
+ description: List of sources to populate environment
+ variables in the container. The keys defined within
+ a source must be a C_IDENTIFIER. All invalid keys
+ will be reported as an event when the container
+ is starting. When a key exists in multiple sources,
+ the value associated with the last source will
+ take precedence. Values defined by an Env with
+ a duplicate key will take precedence. Cannot be
+ updated.
items:
description: EnvFromSource represents the source
of a set of ConfigMaps
@@ -21448,17 +21488,16 @@ spec:
description: The ConfigMap to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
prefix:
description: An optional identifier to prepend
to each key in the ConfigMap. Must be a
@@ -21468,54 +21507,55 @@ spec:
description: The Secret to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret
must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
image:
- description: |-
- Container image name.
- More info: https://kubernetes.io/docs/concepts/containers/images
+ description: 'Container image name. More info: https://kubernetes.io/docs/concepts/containers/images'
type: string
imagePullPolicy:
- description: |-
- Image pull policy.
- One of Always, Never, IfNotPresent.
- Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
+ description: 'Image pull policy. One of Always,
+ Never, IfNotPresent. Defaults to Always if :latest
+ tag is specified, or IfNotPresent otherwise. Cannot
+ be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
description: Lifecycle is not allowed for ephemeral
containers.
properties:
postStart:
- description: |-
- PostStart is called immediately after a container is created. If the handler fails,
- the container is terminated and restarted according to its restart policy.
- Other management of the container blocks until the hook completes.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PostStart is called immediately
+ after a container is created. If the handler
+ fails, the container is terminated and restarted
+ according to its restart policy. Other management
+ of the container blocks until the hook completes.
+ More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to
take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command
+ line to execute inside the container,
+ the working directory for the command is
+ root ('/') in the container's filesystem.
+ The command is simply exec'd, it is
+ not run inside a shell, so traditional
+ shell instructions ('|', etc) won't
+ work. To use a shell, you need to
+ explicitly call out to that shell.
+ Exit status of 0 is treated as live/healthy
+ and non-zero is unhealthy.
items:
type: string
type: array
@@ -21525,9 +21565,10 @@ spec:
request to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to,
+ defaults to the pod IP. You probably
+ want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
description: Custom headers to set in
@@ -21539,9 +21580,11 @@ spec:
probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field
+ name. This will be canonicalized
+ upon output, so case-variant
+ names will be understood as
+ the same header.
type: string
value:
description: The header field
@@ -21560,15 +21603,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -21587,10 +21629,12 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT
+ supported as a LifecycleHandler and kept
+ for the backward compatibility. There
+ are no validation of this field and lifecycle
+ hooks will fail in runtime when tcp handler
+ is specified.
properties:
host:
description: 'Optional: Host name to
@@ -21600,38 +21644,47 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
preStop:
- description: |-
- PreStop is called immediately before a container is terminated due to an
- API request or management event such as liveness/startup probe failure,
- preemption, resource contention, etc. The handler is not called if the
- container crashes or exits. The Pod's termination grace period countdown begins before the
- PreStop hook is executed. Regardless of the outcome of the handler, the
- container will eventually terminate within the Pod's termination grace
- period (unless delayed by finalizers). Other management of the container blocks until the hook completes
- or until the termination grace period is reached.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PreStop is called immediately
+ before a container is terminated due to an
+ API request or management event such as liveness/startup
+ probe failure, preemption, resource contention,
+ etc. The handler is not called if the container
+ crashes or exits. The Pod''s termination grace
+ period countdown begins before the PreStop
+ hook is executed. Regardless of the outcome
+ of the handler, the container will eventually
+ terminate within the Pod''s termination grace
+ period (unless delayed by finalizers). Other
+ management of the container blocks until the
+ hook completes or until the termination grace
+ period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to
take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command
+ line to execute inside the container,
+ the working directory for the command is
+ root ('/') in the container's filesystem.
+ The command is simply exec'd, it is
+ not run inside a shell, so traditional
+ shell instructions ('|', etc) won't
+ work. To use a shell, you need to
+ explicitly call out to that shell.
+ Exit status of 0 is treated as live/healthy
+ and non-zero is unhealthy.
items:
type: string
type: array
@@ -21641,9 +21694,10 @@ spec:
request to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to,
+ defaults to the pod IP. You probably
+ want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
description: Custom headers to set in
@@ -21655,9 +21709,11 @@ spec:
probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field
+ name. This will be canonicalized
+ upon output, so case-variant
+ names will be understood as
+ the same header.
type: string
value:
description: The header field
@@ -21676,15 +21732,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -21703,10 +21758,12 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT
+ supported as a LifecycleHandler and kept
+ for the backward compatibility. There
+ are no validation of this field and lifecycle
+ hooks will fail in runtime when tcp handler
+ is specified.
properties:
host:
description: 'Optional: Host name to
@@ -21716,10 +21773,10 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
@@ -21734,20 +21791,25 @@ spec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -21760,12 +21822,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -21775,8 +21836,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -21787,9 +21848,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -21807,35 +21869,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -21850,40 +21912,46 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
name:
- description: |-
- Name of the ephemeral container specified as a DNS_LABEL.
- This name must be unique among all containers, init containers and ephemeral containers.
+ description: Name of the ephemeral container specified
+ as a DNS_LABEL. This name must be unique among
+ all containers, init containers and ephemeral
+ containers.
type: string
ports:
description: Ports are not allowed for ephemeral
@@ -21893,9 +21961,9 @@ spec:
port in a single container.
properties:
containerPort:
- description: |-
- Number of port to expose on the pod's IP address.
- This must be a valid port number, 0 < x < 65536.
+ description: Number of port to expose on the
+ pod's IP address. This must be a valid port
+ number, 0 < x < 65536.
format: int32
type: integer
hostIP:
@@ -21903,24 +21971,24 @@ spec:
port to.
type: string
hostPort:
- description: |-
- Number of port to expose on the host.
- If specified, this must be a valid port number, 0 < x < 65536.
- If HostNetwork is specified, this must match ContainerPort.
+ description: Number of port to expose on the
+ host. If specified, this must be a valid
+ port number, 0 < x < 65536. If HostNetwork
+ is specified, this must match ContainerPort.
Most containers do not need this.
format: int32
type: integer
name:
- description: |-
- If specified, this must be an IANA_SVC_NAME and unique within the pod. Each
- named port in a pod must have a unique name. Name for the port that can be
- referred to by services.
+ description: If specified, this must be an
+ IANA_SVC_NAME and unique within the pod.
+ Each named port in a pod must have a unique
+ name. Name for the port that can be referred
+ to by services.
type: string
protocol:
default: TCP
- description: |-
- Protocol for port. Must be UDP, TCP, or SCTP.
- Defaults to "TCP".
+ description: Protocol for port. Must be UDP,
+ TCP, or SCTP. Defaults to "TCP".
type: string
required:
- containerPort
@@ -21938,20 +22006,25 @@ spec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -21964,12 +22037,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -21979,8 +22051,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -21991,9 +22063,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -22011,35 +22084,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -22054,33 +22127,38 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
@@ -22091,14 +22169,14 @@ spec:
resource resize policy for the container.
properties:
resourceName:
- description: |-
- Name of the resource to which this resource resize policy applies.
- Supported values: cpu, memory.
+ description: 'Name of the resource to which
+ this resource resize policy applies. Supported
+ values: cpu, memory.'
type: string
restartPolicy:
- description: |-
- Restart policy to apply when specified resource is resized.
- If not specified, it defaults to NotRequired.
+ description: Restart policy to apply when
+ specified resource is resized. If not specified,
+ it defaults to NotRequired.
type: string
required:
- resourceName
@@ -22107,30 +22185,27 @@ spec:
type: array
x-kubernetes-list-type: atomic
resources:
- description: |-
- Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources
+ description: Resources are not allowed for ephemeral
+ containers. Ephemeral containers use spare resources
already allocated to the pod.
properties:
claims:
- description: |-
- Claims lists the names of resources, defined in spec.resourceClaims,
- that are used by this container.
-
-
- This is an alpha field and requires enabling the
- DynamicResourceAllocation feature gate.
-
-
- This field is immutable. It can only be set for containers.
+ description: "Claims lists the names of resources,
+ defined in spec.resourceClaims, that are used
+ by this container. \n This is an alpha field
+ and requires enabling the DynamicResourceAllocation
+ feature gate. \n This field is immutable.
+ It can only be set for containers."
items:
description: ResourceClaim references one
entry in PodSpec.ResourceClaims.
properties:
name:
- description: |-
- Name must match the name of one entry in pod.spec.resourceClaims of
- the Pod where this field is used. It makes that resource available
- inside a container.
+ description: Name must match the name
+ of one entry in pod.spec.resourceClaims
+ of the Pod where this field is used.
+ It makes that resource available inside
+ a container.
type: string
required:
- name
@@ -22146,9 +22221,8 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Limits describes the maximum amount of compute resources allowed.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Limits describes the maximum amount
+ of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -22157,40 +22231,43 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Requests describes the minimum amount of compute resources required.
- If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
- otherwise to an implementation-defined value. Requests cannot exceed Limits.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Requests describes the minimum
+ amount of compute resources required. If Requests
+ is omitted for a container, it defaults to
+ Limits if that is explicitly specified, otherwise
+ to an implementation-defined value. Requests
+ cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
restartPolicy:
- description: |-
- Restart policy for the container to manage the restart behavior of each
- container within a pod.
- This may only be set for init containers. You cannot set this field on
- ephemeral containers.
+ description: Restart policy for the container to
+ manage the restart behavior of each container
+ within a pod. This may only be set for init containers.
+ You cannot set this field on ephemeral containers.
type: string
securityContext:
- description: |-
- Optional: SecurityContext defines the security options the ephemeral container should be run with.
- If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
+ description: 'Optional: SecurityContext defines
+ the security options the ephemeral container should
+ be run with. If set, the fields of SecurityContext
+ override the equivalent fields of PodSecurityContext.'
properties:
allowPrivilegeEscalation:
- description: |-
- AllowPrivilegeEscalation controls whether a process can gain more
- privileges than its parent process. This bool directly controls if
- the no_new_privs flag will be set on the container process.
- AllowPrivilegeEscalation is true always when the container is:
- 1) run as Privileged
- 2) has CAP_SYS_ADMIN
- Note that this field cannot be set when spec.os.name is windows.
+ description: 'AllowPrivilegeEscalation controls
+ whether a process can gain more privileges
+ than its parent process. This bool directly
+ controls if the no_new_privs flag will be
+ set on the container process. AllowPrivilegeEscalation
+ is true always when the container is: 1) run
+ as Privileged 2) has CAP_SYS_ADMIN Note that
+ this field cannot be set when spec.os.name
+ is windows.'
type: boolean
capabilities:
- description: |-
- The capabilities to add/drop when running containers.
- Defaults to the default set of capabilities granted by the container runtime.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The capabilities to add/drop when
+ running containers. Defaults to the default
+ set of capabilities granted by the container
+ runtime. Note that this field cannot be set
+ when spec.os.name is windows.
properties:
add:
description: Added capabilities
@@ -22208,60 +22285,69 @@ spec:
type: array
type: object
privileged:
- description: |-
- Run container in privileged mode.
- Processes in privileged containers are essentially equivalent to root on the host.
- Defaults to false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Run container in privileged mode.
+ Processes in privileged containers are essentially
+ equivalent to root on the host. Defaults to
+ false. Note that this field cannot be set
+ when spec.os.name is windows.
type: boolean
procMount:
- description: |-
- procMount denotes the type of proc mount to use for the containers.
- The default is DefaultProcMount which uses the container runtime defaults for
- readonly paths and masked paths.
- This requires the ProcMountType feature flag to be enabled.
- Note that this field cannot be set when spec.os.name is windows.
+ description: procMount denotes the type of proc
+ mount to use for the containers. The default
+ is DefaultProcMount which uses the container
+ runtime defaults for readonly paths and masked
+ paths. This requires the ProcMountType feature
+ flag to be enabled. Note that this field cannot
+ be set when spec.os.name is windows.
type: string
readOnlyRootFilesystem:
- description: |-
- Whether this container has a read-only root filesystem.
- Default is false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Whether this container has a read-only
+ root filesystem. Default is false. Note that
+ this field cannot be set when spec.os.name
+ is windows.
type: boolean
runAsGroup:
- description: |-
- The GID to run the entrypoint of the container process.
- Uses runtime default if unset.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The GID to run the entrypoint of
+ the container process. Uses runtime default
+ if unset. May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is windows.
format: int64
type: integer
runAsNonRoot:
- description: |-
- Indicates that the container must run as a non-root user.
- If true, the Kubelet will validate the image at runtime to ensure that it
- does not run as UID 0 (root) and fail to start the container if it does.
- If unset or false, no such validation will be performed.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: Indicates that the container must
+ run as a non-root user. If true, the Kubelet
+ will validate the image at runtime to ensure
+ that it does not run as UID 0 (root) and fail
+ to start the container if it does. If unset
+ or false, no such validation will be performed.
+ May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence.
type: boolean
runAsUser:
- description: |-
- The UID to run the entrypoint of the container process.
- Defaults to user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The UID to run the entrypoint of
+ the container process. Defaults to user specified
+ in image metadata if unspecified. May also
+ be set in PodSecurityContext. If set in both
+ SecurityContext and PodSecurityContext, the
+ value specified in SecurityContext takes precedence.
+ Note that this field cannot be set when spec.os.name
+ is windows.
format: int64
type: integer
seLinuxOptions:
- description: |-
- The SELinux context to be applied to the container.
- If unspecified, the container runtime will allocate a random SELinux context for each
- container. May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The SELinux context to be applied
+ to the container. If unspecified, the container
+ runtime will allocate a random SELinux context
+ for each container. May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is windows.
properties:
level:
description: Level is SELinux level label
@@ -22281,62 +22367,74 @@ spec:
type: string
type: object
seccompProfile:
- description: |-
- The seccomp options to use by this container. If seccomp options are
- provided at both the pod & container level, the container options
- override the pod options.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The seccomp options to use by this
+ container. If seccomp options are provided
+ at both the pod & container level, the container
+ options override the pod options. Note that
+ this field cannot be set when spec.os.name
+ is windows.
properties:
localhostProfile:
- description: |-
- localhostProfile indicates a profile defined in a file on the node should be used.
- The profile must be preconfigured on the node to work.
- Must be a descending path, relative to the kubelet's configured seccomp profile location.
- Must be set if type is "Localhost". Must NOT be set for any other type.
+ description: localhostProfile indicates
+ a profile defined in a file on the node
+ should be used. The profile must be preconfigured
+ on the node to work. Must be a descending
+ path, relative to the kubelet's configured
+ seccomp profile location. Must be set
+ if type is "Localhost". Must NOT be set
+ for any other type.
type: string
type:
- description: |-
- type indicates which kind of seccomp profile will be applied.
- Valid options are:
-
-
- Localhost - a profile defined in a file on the node should be used.
- RuntimeDefault - the container runtime default profile should be used.
- Unconfined - no profile should be applied.
+ description: "type indicates which kind
+ of seccomp profile will be applied. Valid
+ options are: \n Localhost - a profile
+ defined in a file on the node should be
+ used. RuntimeDefault - the container runtime
+ default profile should be used. Unconfined
+ - no profile should be applied."
type: string
required:
- type
type: object
windowsOptions:
- description: |-
- The Windows specific settings applied to all containers.
- If unspecified, the options from the PodSecurityContext will be used.
- If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is linux.
+ description: The Windows specific settings applied
+ to all containers. If unspecified, the options
+ from the PodSecurityContext will be used.
+ If set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is linux.
properties:
gmsaCredentialSpec:
- description: |-
- GMSACredentialSpec is where the GMSA admission webhook
- (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
- GMSA credential spec named by the GMSACredentialSpecName field.
+ description: GMSACredentialSpec is where
+ the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa)
+ inlines the contents of the GMSA credential
+ spec named by the GMSACredentialSpecName
+ field.
type: string
gmsaCredentialSpecName:
description: GMSACredentialSpecName is the
name of the GMSA credential spec to use.
type: string
hostProcess:
- description: |-
- HostProcess determines if a container should be run as a 'Host Process' container.
- All of a Pod's containers must have the same effective HostProcess value
- (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
- In addition, if HostProcess is true then HostNetwork must also be set to true.
+ description: HostProcess determines if a
+ container should be run as a 'Host Process'
+ container. All of a Pod's containers must
+ have the same effective HostProcess value
+ (it is not allowed to have a mix of HostProcess
+ containers and non-HostProcess containers).
+ In addition, if HostProcess is true then
+ HostNetwork must also be set to true.
type: boolean
runAsUserName:
- description: |-
- The UserName in Windows to run the entrypoint of the container process.
- Defaults to the user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: The UserName in Windows to
+ run the entrypoint of the container process.
+ Defaults to the user specified in image
+ metadata if unspecified. May also be set
+ in PodSecurityContext. If set in both
+ SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext
+ takes precedence.
type: string
type: object
type: object
@@ -22348,20 +22446,25 @@ spec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -22374,12 +22477,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -22389,8 +22491,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -22401,9 +22503,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -22421,35 +22524,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -22464,86 +22567,98 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
stdin:
- description: |-
- Whether this container should allocate a buffer for stdin in the container runtime. If this
- is not set, reads from stdin in the container will always result in EOF.
- Default is false.
+ description: Whether this container should allocate
+ a buffer for stdin in the container runtime. If
+ this is not set, reads from stdin in the container
+ will always result in EOF. Default is false.
type: boolean
stdinOnce:
- description: |-
- Whether the container runtime should close the stdin channel after it has been opened by
- a single attach. When stdin is true the stdin stream will remain open across multiple attach
- sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
- first client attaches to stdin, and then remains open and accepts data until the client disconnects,
- at which time stdin is closed and remains closed until the container is restarted. If this
- flag is false, a container processes that reads from stdin will never receive an EOF.
- Default is false
+ description: Whether the container runtime should
+ close the stdin channel after it has been opened
+ by a single attach. When stdin is true the stdin
+ stream will remain open across multiple attach
+ sessions. If stdinOnce is set to true, stdin is
+ opened on container start, is empty until the
+ first client attaches to stdin, and then remains
+ open and accepts data until the client disconnects,
+ at which time stdin is closed and remains closed
+ until the container is restarted. If this flag
+ is false, a container processes that reads from
+ stdin will never receive an EOF. Default is false
type: boolean
targetContainerName:
- description: |-
- If set, the name of the container from PodSpec that this ephemeral container targets.
- The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container.
- If not set then the ephemeral container uses the namespaces configured in the Pod spec.
-
-
- The container runtime must implement support for this feature. If the runtime does not
- support namespace targeting then the result of setting this field is undefined.
+ description: "If set, the name of the container
+ from PodSpec that this ephemeral container targets.
+ The ephemeral container will be run in the namespaces
+ (IPC, PID, etc) of this container. If not set
+ then the ephemeral container uses the namespaces
+ configured in the Pod spec. \n The container runtime
+ must implement support for this feature. If the
+ runtime does not support namespace targeting then
+ the result of setting this field is undefined."
type: string
terminationMessagePath:
- description: |-
- Optional: Path at which the file to which the container's termination message
- will be written is mounted into the container's filesystem.
- Message written is intended to be brief final status, such as an assertion failure message.
- Will be truncated by the node if greater than 4096 bytes. The total message length across
- all containers will be limited to 12kb.
- Defaults to /dev/termination-log.
- Cannot be updated.
+ description: 'Optional: Path at which the file to
+ which the container''s termination message will
+ be written is mounted into the container''s filesystem.
+ Message written is intended to be brief final
+ status, such as an assertion failure message.
+ Will be truncated by the node if greater than
+ 4096 bytes. The total message length across all
+ containers will be limited to 12kb. Defaults to
+ /dev/termination-log. Cannot be updated.'
type: string
terminationMessagePolicy:
- description: |-
- Indicate how the termination message should be populated. File will use the contents of
- terminationMessagePath to populate the container status message on both success and failure.
- FallbackToLogsOnError will use the last chunk of container log output if the termination
- message file is empty and the container exited with an error.
- The log output is limited to 2048 bytes or 80 lines, whichever is smaller.
- Defaults to File.
- Cannot be updated.
+ description: Indicate how the termination message
+ should be populated. File will use the contents
+ of terminationMessagePath to populate the container
+ status message on both success and failure. FallbackToLogsOnError
+ will use the last chunk of container log output
+ if the termination message file is empty and the
+ container exited with an error. The log output
+ is limited to 2048 bytes or 80 lines, whichever
+ is smaller. Defaults to File. Cannot be updated.
type: string
tty:
- description: |-
- Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
- Default is false.
+ description: Whether this container should allocate
+ a TTY for itself, also requires 'stdin' to be
+ true. Default is false.
type: boolean
volumeDevices:
description: volumeDevices is the list of block
@@ -22567,45 +22682,47 @@ spec:
type: object
type: array
volumeMounts:
- description: |-
- Pod volumes to mount into the container's filesystem. Subpath mounts are not allowed for ephemeral containers.
- Cannot be updated.
+ description: Pod volumes to mount into the container's
+ filesystem. Subpath mounts are not allowed for
+ ephemeral containers. Cannot be updated.
items:
description: VolumeMount describes a mounting
of a Volume within a container.
properties:
mountPath:
- description: |-
- Path within the container at which the volume should be mounted. Must
+ description: Path within the container at
+ which the volume should be mounted. Must
not contain ':'.
type: string
mountPropagation:
- description: |-
- mountPropagation determines how mounts are propagated from the host
- to container and the other way around.
- When not set, MountPropagationNone is used.
- This field is beta in 1.10.
+ description: mountPropagation determines how
+ mounts are propagated from the host to container
+ and the other way around. When not set,
+ MountPropagationNone is used. This field
+ is beta in 1.10.
type: string
name:
description: This must match the Name of a
Volume.
type: string
readOnly:
- description: |-
- Mounted read-only if true, read-write otherwise (false or unspecified).
- Defaults to false.
+ description: Mounted read-only if true, read-write
+ otherwise (false or unspecified). Defaults
+ to false.
type: boolean
subPath:
- description: |-
- Path within the volume from which the container's volume should be mounted.
+ description: Path within the volume from which
+ the container's volume should be mounted.
Defaults to "" (volume's root).
type: string
subPathExpr:
- description: |-
- Expanded path within the volume from which the container's volume should be mounted.
- Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.
- Defaults to "" (volume's root).
- SubPathExpr and SubPath are mutually exclusive.
+ description: Expanded path within the volume
+ from which the container's volume should
+ be mounted. Behaves similarly to SubPath
+ but environment variable references $(VAR_NAME)
+ are expanded using the container's environment.
+ Defaults to "" (volume's root). SubPathExpr
+ and SubPath are mutually exclusive.
type: string
required:
- mountPath
@@ -22613,11 +22730,10 @@ spec:
type: object
type: array
workingDir:
- description: |-
- Container's working directory.
- If not specified, the container runtime's default will be used, which
- might be configured in the container image.
- Cannot be updated.
+ description: Container's working directory. If not
+ specified, the container runtime's default will
+ be used, which might be configured in the container
+ image. Cannot be updated.
type: string
required:
- name
@@ -22630,35 +22746,39 @@ spec:
want to run within a pod.
properties:
args:
- description: |-
- Arguments to the entrypoint.
- The container image's CMD is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Arguments to the entrypoint. The container
+ image''s CMD is used if this is not provided.
+ Variable references $(VAR_NAME) are expanded using
+ the container''s environment. If a variable cannot
+ be resolved, the reference in the input string
+ will be unchanged. Double $$ are reduced to a
+ single $, which allows for escaping the $(VAR_NAME)
+ syntax: i.e. "$$(VAR_NAME)" will produce the string
+ literal "$(VAR_NAME)". Escaped references will
+ never be expanded, regardless of whether the variable
+ exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
command:
- description: |-
- Entrypoint array. Not executed within a shell.
- The container image's ENTRYPOINT is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Entrypoint array. Not executed within
+ a shell. The container image''s ENTRYPOINT is
+ used if this is not provided. Variable references
+ $(VAR_NAME) are expanded using the container''s
+ environment. If a variable cannot be resolved,
+ the reference in the input string will be unchanged.
+ Double $$ are reduced to a single $, which allows
+ for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)"
+ will produce the string literal "$(VAR_NAME)".
+ Escaped references will never be expanded, regardless
+ of whether the variable exists or not. Cannot
+ be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
env:
- description: |-
- List of environment variables to set in the container.
- Cannot be updated.
+ description: List of environment variables to set
+ in the container. Cannot be updated.
items:
description: EnvVar represents an environment
variable present in a Container.
@@ -22668,16 +22788,18 @@ spec:
Must be a C_IDENTIFIER.
type: string
value:
- description: |-
- Variable references $(VAR_NAME) are expanded
- using the previously defined environment variables in the container and
- any service environment variables. If a variable cannot be resolved,
- the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
- "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
- Escaped references will never be expanded, regardless of whether the variable
- exists or not.
- Defaults to "".
+ description: 'Variable references $(VAR_NAME)
+ are expanded using the previously defined
+ environment variables in the container and
+ any service environment variables. If a
+ variable cannot be resolved, the reference
+ in the input string will be unchanged. Double
+ $$ are reduced to a single $, which allows
+ for escaping the $(VAR_NAME) syntax: i.e.
+ "$$(VAR_NAME)" will produce the string literal
+ "$(VAR_NAME)". Escaped references will never
+ be expanded, regardless of whether the variable
+ exists or not. Defaults to "".'
type: string
valueFrom:
description: Source for the environment variable's
@@ -22690,10 +22812,10 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
+ description: 'Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
@@ -22702,11 +22824,12 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
fieldRef:
- description: |-
- Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`,
- spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ description: 'Selects a field of the pod:
+ supports metadata.name, metadata.namespace,
+ `metadata.labels['''']`, `metadata.annotations['''']`,
+ spec.nodeName, spec.serviceAccountName,
+ status.hostIP, status.podIP, status.podIPs.'
properties:
apiVersion:
description: Version of the schema
@@ -22720,11 +22843,13 @@ spec:
required:
- fieldPath
type: object
- x-kubernetes-map-type: atomic
resourceFieldRef:
- description: |-
- Selects a resource of the container: only resources limits and requests
- (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
+ description: 'Selects a resource of the
+ container: only resources limits and
+ requests (limits.cpu, limits.memory,
+ limits.ephemeral-storage, requests.cpu,
+ requests.memory and requests.ephemeral-storage)
+ are currently supported.'
properties:
containerName:
description: 'Container name: required
@@ -22746,7 +22871,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret
in the pod's namespace
@@ -22757,10 +22881,10 @@ spec:
secret key.
type: string
name:
- description: |-
- Name of the referent.
+ description: 'Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret
@@ -22769,20 +22893,21 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
required:
- name
type: object
type: array
envFrom:
- description: |-
- List of sources to populate environment variables in the container.
- The keys defined within a source must be a C_IDENTIFIER. All invalid keys
- will be reported as an event when the container is starting. When a key exists in multiple
- sources, the value associated with the last source will take precedence.
- Values defined by an Env with a duplicate key will take precedence.
- Cannot be updated.
+ description: List of sources to populate environment
+ variables in the container. The keys defined within
+ a source must be a C_IDENTIFIER. All invalid keys
+ will be reported as an event when the container
+ is starting. When a key exists in multiple sources,
+ the value associated with the last source will
+ take precedence. Values defined by an Env with
+ a duplicate key will take precedence. Cannot be
+ updated.
items:
description: EnvFromSource represents the source
of a set of ConfigMaps
@@ -22791,17 +22916,16 @@ spec:
description: The ConfigMap to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
prefix:
description: An optional identifier to prepend
to each key in the ConfigMap. Must be a
@@ -22811,57 +22935,59 @@ spec:
description: The Secret to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret
must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
image:
- description: |-
- Container image name.
- More info: https://kubernetes.io/docs/concepts/containers/images
- This field is optional to allow higher level config management to default or override
- container images in workload controllers like Deployments and StatefulSets.
+ description: 'Container image name. More info: https://kubernetes.io/docs/concepts/containers/images
+ This field is optional to allow higher level config
+ management to default or override container images
+ in workload controllers like Deployments and StatefulSets.'
type: string
imagePullPolicy:
- description: |-
- Image pull policy.
- One of Always, Never, IfNotPresent.
- Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
+ description: 'Image pull policy. One of Always,
+ Never, IfNotPresent. Defaults to Always if :latest
+ tag is specified, or IfNotPresent otherwise. Cannot
+ be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
- description: |-
- Actions that the management system should take in response to container lifecycle events.
- Cannot be updated.
+ description: Actions that the management system
+ should take in response to container lifecycle
+ events. Cannot be updated.
properties:
postStart:
- description: |-
- PostStart is called immediately after a container is created. If the handler fails,
- the container is terminated and restarted according to its restart policy.
- Other management of the container blocks until the hook completes.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PostStart is called immediately
+ after a container is created. If the handler
+ fails, the container is terminated and restarted
+ according to its restart policy. Other management
+ of the container blocks until the hook completes.
+ More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to
take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command
+ line to execute inside the container,
+ the working directory for the command is
+ root ('/') in the container's filesystem.
+ The command is simply exec'd, it is
+ not run inside a shell, so traditional
+ shell instructions ('|', etc) won't
+ work. To use a shell, you need to
+ explicitly call out to that shell.
+ Exit status of 0 is treated as live/healthy
+ and non-zero is unhealthy.
items:
type: string
type: array
@@ -22871,9 +22997,10 @@ spec:
request to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to,
+ defaults to the pod IP. You probably
+ want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
description: Custom headers to set in
@@ -22885,9 +23012,11 @@ spec:
probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field
+ name. This will be canonicalized
+ upon output, so case-variant
+ names will be understood as
+ the same header.
type: string
value:
description: The header field
@@ -22906,15 +23035,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -22933,10 +23061,12 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT
+ supported as a LifecycleHandler and kept
+ for the backward compatibility. There
+ are no validation of this field and lifecycle
+ hooks will fail in runtime when tcp handler
+ is specified.
properties:
host:
description: 'Optional: Host name to
@@ -22946,38 +23076,47 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
preStop:
- description: |-
- PreStop is called immediately before a container is terminated due to an
- API request or management event such as liveness/startup probe failure,
- preemption, resource contention, etc. The handler is not called if the
- container crashes or exits. The Pod's termination grace period countdown begins before the
- PreStop hook is executed. Regardless of the outcome of the handler, the
- container will eventually terminate within the Pod's termination grace
- period (unless delayed by finalizers). Other management of the container blocks until the hook completes
- or until the termination grace period is reached.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PreStop is called immediately
+ before a container is terminated due to an
+ API request or management event such as liveness/startup
+ probe failure, preemption, resource contention,
+ etc. The handler is not called if the container
+ crashes or exits. The Pod''s termination grace
+ period countdown begins before the PreStop
+ hook is executed. Regardless of the outcome
+ of the handler, the container will eventually
+ terminate within the Pod''s termination grace
+ period (unless delayed by finalizers). Other
+ management of the container blocks until the
+ hook completes or until the termination grace
+ period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to
take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command
+ line to execute inside the container,
+ the working directory for the command is
+ root ('/') in the container's filesystem.
+ The command is simply exec'd, it is
+ not run inside a shell, so traditional
+ shell instructions ('|', etc) won't
+ work. To use a shell, you need to
+ explicitly call out to that shell.
+ Exit status of 0 is treated as live/healthy
+ and non-zero is unhealthy.
items:
type: string
type: array
@@ -22987,9 +23126,10 @@ spec:
request to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to,
+ defaults to the pod IP. You probably
+ want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
description: Custom headers to set in
@@ -23001,9 +23141,11 @@ spec:
probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field
+ name. This will be canonicalized
+ upon output, so case-variant
+ names will be understood as
+ the same header.
type: string
value:
description: The header field
@@ -23022,15 +23164,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -23049,10 +23190,12 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT
+ supported as a LifecycleHandler and kept
+ for the backward compatibility. There
+ are no validation of this field and lifecycle
+ hooks will fail in runtime when tcp handler
+ is specified.
properties:
host:
description: 'Optional: Host name to
@@ -23062,10 +23205,10 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
@@ -23073,30 +23216,33 @@ spec:
type: object
type: object
livenessProbe:
- description: |-
- Periodic probe of container liveness.
+ 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
+ Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -23109,12 +23255,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -23124,8 +23269,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -23136,9 +23281,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -23156,35 +23302,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -23199,59 +23345,63 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
name:
- description: |-
- Name of the container specified as a DNS_LABEL.
- Each container in a pod must have a unique name (DNS_LABEL).
- Cannot be updated.
+ description: Name of the container specified as
+ a DNS_LABEL. Each container in a pod must have
+ a unique name (DNS_LABEL). Cannot be updated.
type: string
ports:
- description: |-
- List of ports to expose from the container. Not specifying a port here
- DOES NOT prevent that port from being exposed. Any port which is
- listening on the default "0.0.0.0" address inside a container will be
- accessible from the network.
- Modifying this array with strategic merge patch may corrupt the data.
- For more information See https://github.com/kubernetes/kubernetes/issues/108255.
+ description: List of ports to expose from the container.
+ Not specifying a port here DOES NOT prevent that
+ port from being exposed. Any port which is listening
+ on the default "0.0.0.0" address inside a container
+ will be accessible from the network. Modifying
+ this array with strategic merge patch may corrupt
+ the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255.
Cannot be updated.
items:
description: ContainerPort represents a network
port in a single container.
properties:
containerPort:
- description: |-
- Number of port to expose on the pod's IP address.
- This must be a valid port number, 0 < x < 65536.
+ description: Number of port to expose on the
+ pod's IP address. This must be a valid port
+ number, 0 < x < 65536.
format: int32
type: integer
hostIP:
@@ -23259,24 +23409,24 @@ spec:
port to.
type: string
hostPort:
- description: |-
- Number of port to expose on the host.
- If specified, this must be a valid port number, 0 < x < 65536.
- If HostNetwork is specified, this must match ContainerPort.
+ description: Number of port to expose on the
+ host. If specified, this must be a valid
+ port number, 0 < x < 65536. If HostNetwork
+ is specified, this must match ContainerPort.
Most containers do not need this.
format: int32
type: integer
name:
- description: |-
- If specified, this must be an IANA_SVC_NAME and unique within the pod. Each
- named port in a pod must have a unique name. Name for the port that can be
- referred to by services.
+ description: If specified, this must be an
+ IANA_SVC_NAME and unique within the pod.
+ Each named port in a pod must have a unique
+ name. Name for the port that can be referred
+ to by services.
type: string
protocol:
default: TCP
- description: |-
- Protocol for port. Must be UDP, TCP, or SCTP.
- Defaults to "TCP".
+ description: Protocol for port. Must be UDP,
+ TCP, or SCTP. Defaults to "TCP".
type: string
required:
- containerPort
@@ -23287,30 +23437,34 @@ spec:
- protocol
x-kubernetes-list-type: map
readinessProbe:
- description: |-
- Periodic probe of container service readiness.
- Container will be removed from service endpoints if the probe fails.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Periodic probe of container service
+ readiness. Container will be removed from service
+ endpoints if the probe fails. Cannot be updated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -23323,12 +23477,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -23338,8 +23491,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -23350,9 +23503,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -23370,35 +23524,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -23413,33 +23567,38 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
@@ -23450,14 +23609,14 @@ spec:
resource resize policy for the container.
properties:
resourceName:
- description: |-
- Name of the resource to which this resource resize policy applies.
- Supported values: cpu, memory.
+ description: 'Name of the resource to which
+ this resource resize policy applies. Supported
+ values: cpu, memory.'
type: string
restartPolicy:
- description: |-
- Restart policy to apply when specified resource is resized.
- If not specified, it defaults to NotRequired.
+ description: Restart policy to apply when
+ specified resource is resized. If not specified,
+ it defaults to NotRequired.
type: string
required:
- resourceName
@@ -23466,31 +23625,26 @@ spec:
type: array
x-kubernetes-list-type: atomic
resources:
- description: |-
- Compute Resources required by this container.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Compute Resources required by this
+ container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
properties:
claims:
- description: |-
- Claims lists the names of resources, defined in spec.resourceClaims,
- that are used by this container.
-
-
- This is an alpha field and requires enabling the
- DynamicResourceAllocation feature gate.
-
-
- This field is immutable. It can only be set for containers.
+ description: "Claims lists the names of resources,
+ defined in spec.resourceClaims, that are used
+ by this container. \n This is an alpha field
+ and requires enabling the DynamicResourceAllocation
+ feature gate. \n This field is immutable.
+ It can only be set for containers."
items:
description: ResourceClaim references one
entry in PodSpec.ResourceClaims.
properties:
name:
- description: |-
- Name must match the name of one entry in pod.spec.resourceClaims of
- the Pod where this field is used. It makes that resource available
- inside a container.
+ description: Name must match the name
+ of one entry in pod.spec.resourceClaims
+ of the Pod where this field is used.
+ It makes that resource available inside
+ a container.
type: string
required:
- name
@@ -23506,9 +23660,8 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Limits describes the maximum amount of compute resources allowed.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Limits describes the maximum amount
+ of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -23517,52 +23670,61 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Requests describes the minimum amount of compute resources required.
- If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
- otherwise to an implementation-defined value. Requests cannot exceed Limits.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Requests describes the minimum
+ amount of compute resources required. If Requests
+ is omitted for a container, it defaults to
+ Limits if that is explicitly specified, otherwise
+ to an implementation-defined value. Requests
+ cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
restartPolicy:
- description: |-
- RestartPolicy defines the restart behavior of individual containers in a pod.
- This field may only be set for init containers, and the only allowed value is "Always".
- For non-init containers or when this field is not specified,
- the restart behavior is defined by the Pod's restart policy and the container type.
- Setting the RestartPolicy as "Always" for the init container will have the following effect:
- this init container will be continually restarted on
- exit until all regular containers have terminated. Once all regular
- containers have completed, all init containers with restartPolicy "Always"
- will be shut down. This lifecycle differs from normal init containers and
- is often referred to as a "sidecar" container. Although this init
- container still starts in the init container sequence, it does not wait
- for the container to complete before proceeding to the next init
- container. Instead, the next init container starts immediately after this
- init container is started, or after any startupProbe has successfully
- completed.
+ description: 'RestartPolicy defines the restart
+ behavior of individual containers in a pod. This
+ field may only be set for init containers, and
+ the only allowed value is "Always". For non-init
+ containers or when this field is not specified,
+ the restart behavior is defined by the Pod''s
+ restart policy and the container type. Setting
+ the RestartPolicy as "Always" for the init container
+ will have the following effect: this init container
+ will be continually restarted on exit until all
+ regular containers have terminated. Once all regular
+ containers have completed, all init containers
+ with restartPolicy "Always" will be shut down.
+ This lifecycle differs from normal init containers
+ and is often referred to as a "sidecar" container.
+ Although this init container still starts in the
+ init container sequence, it does not wait for
+ the container to complete before proceeding to
+ the next init container. Instead, the next init
+ container starts immediately after this init container
+ is started, or after any startupProbe has successfully
+ completed.'
type: string
securityContext:
- description: |-
- SecurityContext defines the security options the container should be run with.
- If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
- More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
+ description: 'SecurityContext defines the security
+ options the container should be run with. If set,
+ the fields of SecurityContext override the equivalent
+ fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
properties:
allowPrivilegeEscalation:
- description: |-
- AllowPrivilegeEscalation controls whether a process can gain more
- privileges than its parent process. This bool directly controls if
- the no_new_privs flag will be set on the container process.
- AllowPrivilegeEscalation is true always when the container is:
- 1) run as Privileged
- 2) has CAP_SYS_ADMIN
- Note that this field cannot be set when spec.os.name is windows.
+ description: 'AllowPrivilegeEscalation controls
+ whether a process can gain more privileges
+ than its parent process. This bool directly
+ controls if the no_new_privs flag will be
+ set on the container process. AllowPrivilegeEscalation
+ is true always when the container is: 1) run
+ as Privileged 2) has CAP_SYS_ADMIN Note that
+ this field cannot be set when spec.os.name
+ is windows.'
type: boolean
capabilities:
- description: |-
- The capabilities to add/drop when running containers.
- Defaults to the default set of capabilities granted by the container runtime.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The capabilities to add/drop when
+ running containers. Defaults to the default
+ set of capabilities granted by the container
+ runtime. Note that this field cannot be set
+ when spec.os.name is windows.
properties:
add:
description: Added capabilities
@@ -23580,60 +23742,69 @@ spec:
type: array
type: object
privileged:
- description: |-
- Run container in privileged mode.
- Processes in privileged containers are essentially equivalent to root on the host.
- Defaults to false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Run container in privileged mode.
+ Processes in privileged containers are essentially
+ equivalent to root on the host. Defaults to
+ false. Note that this field cannot be set
+ when spec.os.name is windows.
type: boolean
procMount:
- description: |-
- procMount denotes the type of proc mount to use for the containers.
- The default is DefaultProcMount which uses the container runtime defaults for
- readonly paths and masked paths.
- This requires the ProcMountType feature flag to be enabled.
- Note that this field cannot be set when spec.os.name is windows.
+ description: procMount denotes the type of proc
+ mount to use for the containers. The default
+ is DefaultProcMount which uses the container
+ runtime defaults for readonly paths and masked
+ paths. This requires the ProcMountType feature
+ flag to be enabled. Note that this field cannot
+ be set when spec.os.name is windows.
type: string
readOnlyRootFilesystem:
- description: |-
- Whether this container has a read-only root filesystem.
- Default is false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Whether this container has a read-only
+ root filesystem. Default is false. Note that
+ this field cannot be set when spec.os.name
+ is windows.
type: boolean
runAsGroup:
- description: |-
- The GID to run the entrypoint of the container process.
- Uses runtime default if unset.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The GID to run the entrypoint of
+ the container process. Uses runtime default
+ if unset. May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is windows.
format: int64
type: integer
runAsNonRoot:
- description: |-
- Indicates that the container must run as a non-root user.
- If true, the Kubelet will validate the image at runtime to ensure that it
- does not run as UID 0 (root) and fail to start the container if it does.
- If unset or false, no such validation will be performed.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: Indicates that the container must
+ run as a non-root user. If true, the Kubelet
+ will validate the image at runtime to ensure
+ that it does not run as UID 0 (root) and fail
+ to start the container if it does. If unset
+ or false, no such validation will be performed.
+ May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence.
type: boolean
runAsUser:
- description: |-
- The UID to run the entrypoint of the container process.
- Defaults to user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The UID to run the entrypoint of
+ the container process. Defaults to user specified
+ in image metadata if unspecified. May also
+ be set in PodSecurityContext. If set in both
+ SecurityContext and PodSecurityContext, the
+ value specified in SecurityContext takes precedence.
+ Note that this field cannot be set when spec.os.name
+ is windows.
format: int64
type: integer
seLinuxOptions:
- description: |-
- The SELinux context to be applied to the container.
- If unspecified, the container runtime will allocate a random SELinux context for each
- container. May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The SELinux context to be applied
+ to the container. If unspecified, the container
+ runtime will allocate a random SELinux context
+ for each container. May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is windows.
properties:
level:
description: Level is SELinux level label
@@ -23653,93 +23824,112 @@ spec:
type: string
type: object
seccompProfile:
- description: |-
- The seccomp options to use by this container. If seccomp options are
- provided at both the pod & container level, the container options
- override the pod options.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The seccomp options to use by this
+ container. If seccomp options are provided
+ at both the pod & container level, the container
+ options override the pod options. Note that
+ this field cannot be set when spec.os.name
+ is windows.
properties:
localhostProfile:
- description: |-
- localhostProfile indicates a profile defined in a file on the node should be used.
- The profile must be preconfigured on the node to work.
- Must be a descending path, relative to the kubelet's configured seccomp profile location.
- Must be set if type is "Localhost". Must NOT be set for any other type.
+ description: localhostProfile indicates
+ a profile defined in a file on the node
+ should be used. The profile must be preconfigured
+ on the node to work. Must be a descending
+ path, relative to the kubelet's configured
+ seccomp profile location. Must be set
+ if type is "Localhost". Must NOT be set
+ for any other type.
type: string
type:
- description: |-
- type indicates which kind of seccomp profile will be applied.
- Valid options are:
-
-
- Localhost - a profile defined in a file on the node should be used.
- RuntimeDefault - the container runtime default profile should be used.
- Unconfined - no profile should be applied.
+ description: "type indicates which kind
+ of seccomp profile will be applied. Valid
+ options are: \n Localhost - a profile
+ defined in a file on the node should be
+ used. RuntimeDefault - the container runtime
+ default profile should be used. Unconfined
+ - no profile should be applied."
type: string
required:
- type
type: object
windowsOptions:
- description: |-
- The Windows specific settings applied to all containers.
- If unspecified, the options from the PodSecurityContext will be used.
- If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is linux.
+ description: The Windows specific settings applied
+ to all containers. If unspecified, the options
+ from the PodSecurityContext will be used.
+ If set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is linux.
properties:
gmsaCredentialSpec:
- description: |-
- GMSACredentialSpec is where the GMSA admission webhook
- (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
- GMSA credential spec named by the GMSACredentialSpecName field.
+ description: GMSACredentialSpec is where
+ the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa)
+ inlines the contents of the GMSA credential
+ spec named by the GMSACredentialSpecName
+ field.
type: string
gmsaCredentialSpecName:
description: GMSACredentialSpecName is the
name of the GMSA credential spec to use.
type: string
hostProcess:
- description: |-
- HostProcess determines if a container should be run as a 'Host Process' container.
- All of a Pod's containers must have the same effective HostProcess value
- (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
- In addition, if HostProcess is true then HostNetwork must also be set to true.
+ description: HostProcess determines if a
+ container should be run as a 'Host Process'
+ container. All of a Pod's containers must
+ have the same effective HostProcess value
+ (it is not allowed to have a mix of HostProcess
+ containers and non-HostProcess containers).
+ In addition, if HostProcess is true then
+ HostNetwork must also be set to true.
type: boolean
runAsUserName:
- description: |-
- The UserName in Windows to run the entrypoint of the container process.
- Defaults to the user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: The UserName in Windows to
+ run the entrypoint of the container process.
+ Defaults to the user specified in image
+ metadata if unspecified. May also be set
+ in PodSecurityContext. If set in both
+ SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext
+ takes precedence.
type: string
type: object
type: object
startupProbe:
- description: |-
- StartupProbe indicates that the Pod has successfully initialized.
- If specified, no other probes are executed until this completes successfully.
- If this probe fails, the Pod will be restarted, just as if the livenessProbe failed.
- This can be used to provide different probe parameters at the beginning of a Pod's lifecycle,
- when it might take a long time to load data or warm a cache, than during steady-state operation.
- This cannot be updated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'StartupProbe indicates that the Pod
+ has successfully initialized. If specified, no
+ other probes are executed until this completes
+ successfully. If this probe fails, the Pod will
+ be restarted, just as if the livenessProbe failed.
+ This can be used to provide different probe parameters
+ at the beginning of a Pod''s lifecycle, when it
+ might take a long time to load data or warm a
+ cache, than during steady-state operation. This
+ cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -23752,12 +23942,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -23767,8 +23956,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -23779,9 +23968,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -23799,35 +23989,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -23842,76 +24032,87 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
stdin:
- description: |-
- Whether this container should allocate a buffer for stdin in the container runtime. If this
- is not set, reads from stdin in the container will always result in EOF.
- Default is false.
+ description: Whether this container should allocate
+ a buffer for stdin in the container runtime. If
+ this is not set, reads from stdin in the container
+ will always result in EOF. Default is false.
type: boolean
stdinOnce:
- description: |-
- Whether the container runtime should close the stdin channel after it has been opened by
- a single attach. When stdin is true the stdin stream will remain open across multiple attach
- sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
- first client attaches to stdin, and then remains open and accepts data until the client disconnects,
- at which time stdin is closed and remains closed until the container is restarted. If this
- flag is false, a container processes that reads from stdin will never receive an EOF.
- Default is false
+ description: Whether the container runtime should
+ close the stdin channel after it has been opened
+ by a single attach. When stdin is true the stdin
+ stream will remain open across multiple attach
+ sessions. If stdinOnce is set to true, stdin is
+ opened on container start, is empty until the
+ first client attaches to stdin, and then remains
+ open and accepts data until the client disconnects,
+ at which time stdin is closed and remains closed
+ until the container is restarted. If this flag
+ is false, a container processes that reads from
+ stdin will never receive an EOF. Default is false
type: boolean
terminationMessagePath:
- description: |-
- Optional: Path at which the file to which the container's termination message
- will be written is mounted into the container's filesystem.
- Message written is intended to be brief final status, such as an assertion failure message.
- Will be truncated by the node if greater than 4096 bytes. The total message length across
- all containers will be limited to 12kb.
- Defaults to /dev/termination-log.
- Cannot be updated.
+ description: 'Optional: Path at which the file to
+ which the container''s termination message will
+ be written is mounted into the container''s filesystem.
+ Message written is intended to be brief final
+ status, such as an assertion failure message.
+ Will be truncated by the node if greater than
+ 4096 bytes. The total message length across all
+ containers will be limited to 12kb. Defaults to
+ /dev/termination-log. Cannot be updated.'
type: string
terminationMessagePolicy:
- description: |-
- Indicate how the termination message should be populated. File will use the contents of
- terminationMessagePath to populate the container status message on both success and failure.
- FallbackToLogsOnError will use the last chunk of container log output if the termination
- message file is empty and the container exited with an error.
- The log output is limited to 2048 bytes or 80 lines, whichever is smaller.
- Defaults to File.
- Cannot be updated.
+ description: Indicate how the termination message
+ should be populated. File will use the contents
+ of terminationMessagePath to populate the container
+ status message on both success and failure. FallbackToLogsOnError
+ will use the last chunk of container log output
+ if the termination message file is empty and the
+ container exited with an error. The log output
+ is limited to 2048 bytes or 80 lines, whichever
+ is smaller. Defaults to File. Cannot be updated.
type: string
tty:
- description: |-
- Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
- Default is false.
+ description: Whether this container should allocate
+ a TTY for itself, also requires 'stdin' to be
+ true. Default is false.
type: boolean
volumeDevices:
description: volumeDevices is the list of block
@@ -23935,45 +24136,46 @@ spec:
type: object
type: array
volumeMounts:
- description: |-
- Pod volumes to mount into the container's filesystem.
- Cannot be updated.
+ description: Pod volumes to mount into the container's
+ filesystem. Cannot be updated.
items:
description: VolumeMount describes a mounting
of a Volume within a container.
properties:
mountPath:
- description: |-
- Path within the container at which the volume should be mounted. Must
+ description: Path within the container at
+ which the volume should be mounted. Must
not contain ':'.
type: string
mountPropagation:
- description: |-
- mountPropagation determines how mounts are propagated from the host
- to container and the other way around.
- When not set, MountPropagationNone is used.
- This field is beta in 1.10.
+ description: mountPropagation determines how
+ mounts are propagated from the host to container
+ and the other way around. When not set,
+ MountPropagationNone is used. This field
+ is beta in 1.10.
type: string
name:
description: This must match the Name of a
Volume.
type: string
readOnly:
- description: |-
- Mounted read-only if true, read-write otherwise (false or unspecified).
- Defaults to false.
+ description: Mounted read-only if true, read-write
+ otherwise (false or unspecified). Defaults
+ to false.
type: boolean
subPath:
- description: |-
- Path within the volume from which the container's volume should be mounted.
+ description: Path within the volume from which
+ the container's volume should be mounted.
Defaults to "" (volume's root).
type: string
subPathExpr:
- description: |-
- Expanded path within the volume from which the container's volume should be mounted.
- Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.
- Defaults to "" (volume's root).
- SubPathExpr and SubPath are mutually exclusive.
+ description: Expanded path within the volume
+ from which the container's volume should
+ be mounted. Behaves similarly to SubPath
+ but environment variable references $(VAR_NAME)
+ are expanded using the container's environment.
+ Defaults to "" (volume's root). SubPathExpr
+ and SubPath are mutually exclusive.
type: string
required:
- mountPath
@@ -23981,11 +24183,10 @@ spec:
type: object
type: array
workingDir:
- description: |-
- Container's working directory.
- If not specified, the container runtime's default will be used, which
- might be configured in the container image.
- Cannot be updated.
+ description: Container's working directory. If not
+ specified, the container runtime's default will
+ be used, which might be configured in the container
+ image. Cannot be updated.
type: string
required:
- name
@@ -24003,68 +24204,69 @@ spec:
description: 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.
- Note that this field cannot be set when spec.os.name is windows.
+ description: "A special supplemental group that applies
+ to all containers in a pod. Some volume types allow
+ the Kubelet to change the ownership of that volume
+ to be owned by the pod: \n 1. The owning GID will
+ be the FSGroup 2. The setgid bit is set (new files
+ created in the volume will be owned by FSGroup)
+ 3. The permission bits are OR'd with rw-rw---- \n
+ If unset, the Kubelet will not modify the ownership
+ and permissions of any volume. Note that this field
+ cannot be set when spec.os.name is windows."
format: int64
type: integer
fsGroupChangePolicy:
- description: |-
- fsGroupChangePolicy defines behavior of changing ownership and permission of the volume
- before being exposed inside Pod. This field will only apply to
- volume types which support fsGroup based ownership(and permissions).
- It will have no effect on ephemeral volume types such as: secret, configmaps
- and emptydir.
- Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used.
- Note that this field cannot be set when spec.os.name is windows.
+ description: 'fsGroupChangePolicy defines behavior
+ of changing ownership and permission of the volume
+ before being exposed inside Pod. This field will
+ only apply to volume types which support fsGroup
+ based ownership(and permissions). It will have no
+ effect on ephemeral volume types such as: secret,
+ configmaps and emptydir. Valid values are "OnRootMismatch"
+ and "Always". If not specified, "Always" is used.
+ Note that this field cannot be set when spec.os.name
+ is windows.'
type: string
runAsGroup:
- description: |-
- The GID to run the entrypoint of the container process.
- Uses runtime default if unset.
- May also be set in SecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence
- for that container.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The GID to run the entrypoint of the
+ container process. Uses runtime default if unset.
+ May also be set in SecurityContext. If set in both
+ SecurityContext and PodSecurityContext, the value
+ specified in SecurityContext takes precedence for
+ that container. Note that this field cannot be set
+ when spec.os.name is windows.
format: int64
type: integer
runAsNonRoot:
- description: |-
- Indicates that the container must run as a non-root user.
- If true, the Kubelet will validate the image at runtime to ensure that it
- does not run as UID 0 (root) and fail to start the container if it does.
- If unset or false, no such validation will be performed.
- May also be set in SecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: Indicates that the container must run
+ as a non-root user. If true, the Kubelet will validate
+ the image at runtime to ensure that it does not
+ run as UID 0 (root) and fail to start the container
+ if it does. If unset or false, no such validation
+ will be performed. May also be set in SecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence.
type: boolean
runAsUser:
- description: |-
- The UID to run the entrypoint of the container process.
- Defaults to user specified in image metadata if unspecified.
- May also be set in SecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence
- for that container.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The UID to run the entrypoint of the
+ container process. Defaults to user specified in
+ image metadata if unspecified. May also be set in
+ SecurityContext. If set in both SecurityContext
+ and PodSecurityContext, the value specified in SecurityContext
+ takes precedence for that container. Note that this
+ field cannot be set when spec.os.name is windows.
format: int64
type: integer
seLinuxOptions:
- description: |-
- The SELinux context to be applied to all containers.
- If unspecified, the container runtime will allocate a random SELinux context for each
- container. May also be set in SecurityContext. If set in
- both SecurityContext and PodSecurityContext, the value specified in SecurityContext
- takes precedence for that container.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The SELinux context to be applied to
+ all containers. If unspecified, the container runtime
+ will allocate a random SELinux context for each
+ container. May also be set in SecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence
+ for that container. Note that this field cannot
+ be set when spec.os.name is windows.
properties:
level:
description: Level is SELinux level label that
@@ -24084,48 +24286,52 @@ spec:
type: string
type: object
seccompProfile:
- description: |-
- The seccomp options to use by the containers in this pod.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The seccomp options to use by the containers
+ in this pod. Note that this field cannot be set
+ when spec.os.name is windows.
properties:
localhostProfile:
- description: |-
- localhostProfile indicates a profile defined in a file on the node should be used.
- The profile must be preconfigured on the node to work.
- Must be a descending path, relative to the kubelet's configured seccomp profile location.
- Must be set if type is "Localhost". Must NOT be set for any other type.
+ description: localhostProfile indicates a profile
+ defined in a file on the node should be used.
+ The profile must be preconfigured on the node
+ to work. Must be a descending path, relative
+ to the kubelet's configured seccomp profile
+ location. Must be set if type is "Localhost".
+ Must NOT be set for any other type.
type: string
type:
- description: |-
- type indicates which kind of seccomp profile will be applied.
- Valid options are:
-
-
- Localhost - a profile defined in a file on the node should be used.
- RuntimeDefault - the container runtime default profile should be used.
- Unconfined - no profile should be applied.
+ description: "type indicates which kind of seccomp
+ profile will be applied. Valid options are:
+ \n Localhost - a profile defined in a file on
+ the node should be used. RuntimeDefault - the
+ container runtime default profile should be
+ used. Unconfined - no profile should be applied."
type: string
required:
- type
type: object
supplementalGroups:
- description: |-
- A list of groups applied to the first process run in each container, in addition
- to the container's primary GID, the fsGroup (if specified), and group memberships
- defined in the container image for the uid of the container process. If unspecified,
- no additional groups are added to any container. Note that group memberships
- defined in the container image for the uid of the container process are still effective,
- even if they are not included in this list.
- Note that this field cannot be set when spec.os.name is windows.
+ description: A list of groups applied to the first
+ process run in each container, in addition to the
+ container's primary GID, the fsGroup (if specified),
+ and group memberships defined in the container image
+ for the uid of the container process. If unspecified,
+ no additional groups are added to any container.
+ Note that group memberships defined in the container
+ image for the uid of the container process are still
+ effective, even if they are not included in this
+ list. Note that this field cannot be set when spec.os.name
+ is windows.
items:
format: int64
type: integer
type: array
sysctls:
- description: |-
- Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported
- sysctls (by the container runtime) might fail to launch.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Sysctls hold a list of namespaced sysctls
+ used for the pod. Pods with unsupported sysctls
+ (by the container runtime) might fail to launch.
+ Note that this field cannot be set when spec.os.name
+ is windows.
items:
description: Sysctl defines a kernel parameter to
be set
@@ -24142,35 +24348,42 @@ spec:
type: object
type: array
windowsOptions:
- description: |-
- The Windows specific settings applied to all containers.
- If unspecified, the options within a container's SecurityContext will be used.
- If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is linux.
+ description: The Windows specific settings applied
+ to all containers. If unspecified, the options within
+ a container's SecurityContext will be used. If set
+ in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence.
+ Note that this field cannot be set when spec.os.name
+ is linux.
properties:
gmsaCredentialSpec:
- description: |-
- GMSACredentialSpec is where the GMSA admission webhook
- (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
- GMSA credential spec named by the GMSACredentialSpecName field.
+ description: GMSACredentialSpec is where the GMSA
+ admission webhook (https://github.com/kubernetes-sigs/windows-gmsa)
+ inlines the contents of the GMSA credential
+ spec named by the GMSACredentialSpecName field.
type: string
gmsaCredentialSpecName:
description: GMSACredentialSpecName is the name
of the GMSA credential spec to use.
type: string
hostProcess:
- description: |-
- HostProcess determines if a container should be run as a 'Host Process' container.
- All of a Pod's containers must have the same effective HostProcess value
- (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
- In addition, if HostProcess is true then HostNetwork must also be set to true.
+ description: HostProcess determines if a container
+ should be run as a 'Host Process' container.
+ All of a Pod's containers must have the same
+ effective HostProcess value (it is not allowed
+ to have a mix of HostProcess containers and
+ non-HostProcess containers). In addition, if
+ HostProcess is true then HostNetwork must also
+ be set to true.
type: boolean
runAsUserName:
- description: |-
- The UserName in Windows to run the entrypoint of the container process.
- Defaults to the user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: The UserName in Windows to run the
+ entrypoint of the container process. Defaults
+ to the user specified in image metadata if unspecified.
+ May also be set in PodSecurityContext. If set
+ in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence.
type: string
type: object
type: object
@@ -24185,34 +24398,38 @@ spec:
to spread matching pods among the given topology.
properties:
labelSelector:
- description: |-
- LabelSelector is used to find matching pods.
- Pods that match this label selector are counted to determine the number of pods
- in their corresponding topology domain.
+ description: LabelSelector is used to find matching
+ pods. Pods that match this label selector are
+ counted to determine the number of pods in their
+ corresponding topology domain.
properties:
matchExpressions:
description: matchExpressions is a list of label
selector requirements. The requirements are
ANDed.
items:
- description: |-
- A label selector requirement is a selector that contains values, a key, and an operator that
- relates the key and values.
+ description: A label selector requirement
+ is a selector that contains values, a key,
+ and an operator that relates the key and
+ values.
properties:
key:
description: key is the label key that
the selector applies to.
type: string
operator:
- description: |-
- operator represents a key's relationship to a set of values.
- Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents a key's
+ relationship to a set of values. Valid
+ operators are In, NotIn, Exists and
+ DoesNotExist.
type: string
values:
- description: |-
- values is an array of string values. If the operator is In or NotIn,
- the values array must be non-empty. If the operator is Exists or DoesNotExist,
- the values array must be empty. This array is replaced during a strategic
+ description: values is an array of string
+ values. If the operator is In or NotIn,
+ the values array must be non-empty.
+ If the operator is Exists or DoesNotExist,
+ the values array must be empty. This
+ array is replaced during a strategic
merge patch.
items:
type: string
@@ -24225,134 +24442,146 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: |-
- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions, whose key field is "key", the
- operator is "In", and the values array contains only "value". The requirements are ANDed.
+ description: matchLabels is a map of {key,value}
+ pairs. A single {key,value} in the matchLabels
+ map is equivalent to an element of matchExpressions,
+ whose key field is "key", the operator is
+ "In", and the values array contains only "value".
+ The requirements are ANDed.
type: object
type: object
- x-kubernetes-map-type: atomic
matchLabelKeys:
- description: |-
- MatchLabelKeys is a set of pod label keys to select the pods over which
- spreading will be calculated. The keys are used to lookup values from the
- incoming pod labels, those key-value labels are ANDed with labelSelector
- to select the group of existing pods over which spreading will be calculated
- for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.
- MatchLabelKeys cannot be set when LabelSelector isn't set.
- Keys that don't exist in the incoming pod labels will
- be ignored. A null or empty list means only match against labelSelector.
-
-
- This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).
+ description: "MatchLabelKeys is a set of pod label
+ keys to select the pods over which spreading will
+ be calculated. The keys are used to lookup values
+ from the incoming pod labels, those key-value
+ labels are ANDed with labelSelector to select
+ the group of existing pods over which spreading
+ will be calculated for the incoming pod. The same
+ key is forbidden to exist in both MatchLabelKeys
+ and LabelSelector. MatchLabelKeys cannot be set
+ when LabelSelector isn't set. Keys that don't
+ exist in the incoming pod labels will be ignored.
+ A null or empty list means only match against
+ labelSelector. \n This is a beta field and requires
+ the MatchLabelKeysInPodTopologySpread feature
+ gate to be enabled (enabled by default)."
items:
type: string
type: array
x-kubernetes-list-type: atomic
maxSkew:
- description: |-
- MaxSkew describes the degree to which pods may be unevenly distributed.
- When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference
- between the number of matching pods in the target topology and the global minimum.
- The global minimum is the minimum number of matching pods in an eligible domain
- or zero if the number of eligible domains is less than MinDomains.
- For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same
- labelSelector spread as 2/2/1:
- In this case, the global minimum is 1.
- | zone1 | zone2 | zone3 |
- | P P | P P | P |
- - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2;
- scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2)
- violate MaxSkew(1).
- - if MaxSkew is 2, incoming pod can be scheduled onto any zone.
- When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence
- to topologies that satisfy it.
- It's a required field. Default value is 1 and 0 is not allowed.
+ description: 'MaxSkew describes the degree to which
+ pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`,
+ it is the maximum permitted difference between
+ the number of matching pods in the target topology
+ and the global minimum. The global minimum is
+ the minimum number of matching pods in an eligible
+ domain or zero if the number of eligible domains
+ is less than MinDomains. For example, in a 3-zone
+ cluster, MaxSkew is set to 1, and pods with the
+ same labelSelector spread as 2/2/1: In this case,
+ the global minimum is 1. | zone1 | zone2 | zone3
+ | | P P | P P | P | - if MaxSkew is 1,
+ incoming pod can only be scheduled to zone3 to
+ become 2/2/2; scheduling it onto zone1(zone2)
+ would make the ActualSkew(3-1) on zone1(zone2)
+ violate MaxSkew(1). - if MaxSkew is 2, incoming
+ pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`,
+ it is used to give higher precedence to topologies
+ that satisfy it. It''s a required field. Default
+ value is 1 and 0 is not allowed.'
format: int32
type: integer
minDomains:
- description: |-
- MinDomains indicates a minimum number of eligible domains.
- When the number of eligible domains with matching topology keys is less than minDomains,
- Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed.
- And when the number of eligible domains with matching topology keys equals or greater than minDomains,
- this value has no effect on scheduling.
- As a result, when the number of eligible domains is less than minDomains,
- scheduler won't schedule more than maxSkew Pods to those domains.
- If value is nil, the constraint behaves as if MinDomains is equal to 1.
- Valid values are integers greater than 0.
- When value is not nil, WhenUnsatisfiable must be DoNotSchedule.
-
-
- For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same
- labelSelector spread as 2/2/2:
- | zone1 | zone2 | zone3 |
- | P P | P P | P P |
- The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0.
- In this situation, new pod with the same labelSelector cannot be scheduled,
- because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones,
- it will violate MaxSkew.
-
-
- This is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default).
+ description: "MinDomains indicates a minimum number
+ of eligible domains. When the number of eligible
+ domains with matching topology keys is less than
+ minDomains, Pod Topology Spread treats \"global
+ minimum\" as 0, and then the calculation of Skew
+ is performed. And when the number of eligible
+ domains with matching topology keys equals or
+ greater than minDomains, this value has no effect
+ on scheduling. As a result, when the number of
+ eligible domains is less than minDomains, scheduler
+ won't schedule more than maxSkew Pods to those
+ domains. If value is nil, the constraint behaves
+ as if MinDomains is equal to 1. Valid values are
+ integers greater than 0. When value is not nil,
+ WhenUnsatisfiable must be DoNotSchedule. \n For
+ example, in a 3-zone cluster, MaxSkew is set to
+ 2, MinDomains is set to 5 and pods with the same
+ labelSelector spread as 2/2/2: | zone1 | zone2
+ | zone3 | | P P | P P | P P | The number
+ of domains is less than 5(MinDomains), so \"global
+ minimum\" is treated as 0. In this situation,
+ new pod with the same labelSelector cannot be
+ scheduled, because computed skew will be 3(3 -
+ 0) if new Pod is scheduled to any of the three
+ zones, it will violate MaxSkew. \n This is a beta
+ field and requires the MinDomainsInPodTopologySpread
+ feature gate to be enabled (enabled by default)."
format: int32
type: integer
nodeAffinityPolicy:
- description: |-
- NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector
- when calculating pod topology spread skew. Options are:
- - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations.
- - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.
-
-
- If this value is nil, the behavior is equivalent to the Honor policy.
- This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
+ description: "NodeAffinityPolicy indicates how we
+ will treat Pod's nodeAffinity/nodeSelector when
+ calculating pod topology spread skew. Options
+ are: - Honor: only nodes matching nodeAffinity/nodeSelector
+ are included in the calculations. - Ignore: nodeAffinity/nodeSelector
+ are ignored. All nodes are included in the calculations.
+ \n If this value is nil, the behavior is equivalent
+ to the Honor policy. This is a beta-level feature
+ default enabled by the NodeInclusionPolicyInPodTopologySpread
+ feature flag."
type: string
nodeTaintsPolicy:
- description: |-
- NodeTaintsPolicy indicates how we will treat node taints when calculating
- pod topology spread skew. Options are:
- - Honor: nodes without taints, along with tainted nodes for which the incoming pod
- has a toleration, are included.
- - Ignore: node taints are ignored. All nodes are included.
-
-
- If this value is nil, the behavior is equivalent to the Ignore policy.
- This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
+ description: "NodeTaintsPolicy indicates how we
+ will treat node taints when calculating pod topology
+ spread skew. Options are: - Honor: nodes without
+ taints, along with tainted nodes for which the
+ incoming pod has a toleration, are included. -
+ Ignore: node taints are ignored. All nodes are
+ included. \n If this value is nil, the behavior
+ is equivalent to the Ignore policy. This is a
+ beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread
+ feature flag."
type: string
topologyKey:
- description: |-
- TopologyKey is the key of node labels. Nodes that have a label with this key
- and identical values are considered to be in the same topology.
- We consider each as a "bucket", and try to put balanced number
- of pods into each bucket.
- We define a domain as a particular instance of a topology.
- Also, we define an eligible domain as a domain whose nodes meet the requirements of
- nodeAffinityPolicy and nodeTaintsPolicy.
- e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology.
- And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology.
- It's a required field.
+ description: TopologyKey is the key of node labels.
+ Nodes that have a label with this key and identical
+ values are considered to be in the same topology.
+ We consider each as a "bucket", and
+ try to put balanced number of pods into each bucket.
+ We define a domain as a particular instance of
+ a topology. Also, we define an eligible domain
+ as a domain whose nodes meet the requirements
+ of nodeAffinityPolicy and nodeTaintsPolicy. e.g.
+ If TopologyKey is "kubernetes.io/hostname", each
+ Node is a domain of that topology. And, if TopologyKey
+ is "topology.kubernetes.io/zone", each zone is
+ a domain of that topology. It's a required field.
type: string
whenUnsatisfiable:
- description: |-
- WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy
- the spread constraint.
- - DoNotSchedule (default) tells the scheduler not to schedule it.
- - ScheduleAnyway tells the scheduler to schedule the pod in any location,
- but giving higher precedence to topologies that would help reduce the
- skew.
- A constraint is considered "Unsatisfiable" for an incoming pod
- if and only if every possible node assignment for that pod would violate
- "MaxSkew" on some topology.
- For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same
- labelSelector spread as 3/1/1:
- | zone1 | zone2 | zone3 |
- | P P P | P | P |
- If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled
- to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies
- MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler
- won't make it *more* imbalanced.
- It's a required field.
+ description: 'WhenUnsatisfiable indicates how to
+ deal with a pod if it doesn''t satisfy the spread
+ constraint. - DoNotSchedule (default) tells the
+ scheduler not to schedule it. - ScheduleAnyway
+ tells the scheduler to schedule the pod in any
+ location, but giving higher precedence to topologies
+ that would help reduce the skew. A constraint
+ is considered "Unsatisfiable" for an incoming
+ pod if and only if every possible node assignment
+ for that pod would violate "MaxSkew" on some topology.
+ For example, in a 3-zone cluster, MaxSkew is set
+ to 1, and pods with the same labelSelector spread
+ as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P |
+ If WhenUnsatisfiable is set to DoNotSchedule,
+ incoming pod can only be scheduled to zone2(zone3)
+ to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3)
+ satisfies MaxSkew(1). In other words, the cluster
+ can still be imbalanced, but scheduler won''t
+ make it *more* imbalanced. It''s a required field.'
type: string
required:
- maxSkew
@@ -24367,36 +24596,40 @@ spec:
that may be accessed by any container in the pod.
properties:
awsElasticBlockStore:
- description: |-
- awsElasticBlockStore represents an AWS Disk resource that is attached to a
- kubelet's host machine and then exposed to the pod.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ description: 'awsElasticBlockStore represents an
+ AWS Disk resource that is attached to a kubelet''s
+ host machine and then exposed to the pod. More
+ info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
properties:
fsType:
- description: |-
- fsType is the filesystem type of the volume that you want to mount.
- Tip: Ensure that the filesystem type is supported by the host operating system.
- Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
- TODO: how do we prevent errors in the filesystem from compromising the machine
+ description: 'fsType is the filesystem type
+ of the volume that you want to mount. Tip:
+ Ensure that the filesystem type is supported
+ by the host operating system. Examples: "ext4",
+ "xfs", "ntfs". Implicitly inferred to be "ext4"
+ if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
partition:
- description: |-
- partition is the partition in the volume that you want to mount.
- If omitted, the default is to mount by volume name.
- Examples: For volume /dev/sda1, you specify the partition as "1".
- Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
+ description: 'partition is the partition in
+ the volume that you want to mount. If omitted,
+ the default is to mount by volume name. Examples:
+ For volume /dev/sda1, you specify the partition
+ as "1". Similarly, the volume partition for
+ /dev/sda is "0" (or you can leave the property
+ empty).'
format: int32
type: integer
readOnly:
- description: |-
- readOnly value true will force the readOnly setting in VolumeMounts.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ description: 'readOnly value true will force
+ the readOnly setting in VolumeMounts. More
+ info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
type: boolean
volumeID:
- description: |-
- volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume).
- More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ description: 'volumeID is unique ID of the persistent
+ disk resource in AWS (Amazon EBS volume).
+ More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
type: string
required:
- volumeID
@@ -24418,10 +24651,11 @@ spec:
in the blob storage
type: string
fsType:
- description: |-
- fsType is Filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: fsType is Filesystem type to mount.
+ Must be a filesystem type supported by the
+ host operating system. Ex. "ext4", "xfs",
+ "ntfs". Implicitly inferred to be "ext4" if
+ unspecified.
type: string
kind:
description: 'kind expected values are Shared:
@@ -24431,9 +24665,9 @@ spec:
set). defaults to shared'
type: string
readOnly:
- description: |-
- readOnly Defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: readOnly Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
required:
- diskName
@@ -24445,9 +24679,9 @@ spec:
pod.
properties:
readOnly:
- description: |-
- readOnly defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: readOnly defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
secretName:
description: secretName is the name of secret
@@ -24466,9 +24700,9 @@ spec:
the host that shares a pod's lifetime
properties:
monitors:
- description: |-
- monitors is Required: Monitors is a collection of Ceph monitors
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ description: 'monitors is Required: Monitors
+ is a collection of Ceph monitors More info:
+ https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
items:
type: string
type: array
@@ -24478,72 +24712,68 @@ spec:
default is /'
type: string
readOnly:
- description: |-
- readOnly is Optional: Defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ description: 'readOnly is Optional: Defaults
+ to false (read/write). ReadOnly here will
+ force the ReadOnly setting in VolumeMounts.
+ More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
type: boolean
secretFile:
- description: |-
- secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ description: 'secretFile is Optional: SecretFile
+ is the path to key ring for User, default
+ is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
type: string
secretRef:
- description: |-
- secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty.
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ description: 'secretRef is Optional: SecretRef
+ is reference to the authentication secret
+ for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
user:
- description: |-
- user is optional: User is the rados user name, default is admin
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ description: 'user is optional: User is the
+ rados user name, default is admin More info:
+ https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
type: string
required:
- monitors
type: object
cinder:
- description: |-
- cinder represents a cinder volume attached and mounted on kubelets host machine.
- More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ description: 'cinder represents a cinder volume
+ attached and mounted on kubelets host machine.
+ More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
properties:
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ description: 'fsType is the filesystem type
+ to mount. Must be a filesystem type supported
+ by the host operating system. Examples: "ext4",
+ "xfs", "ntfs". Implicitly inferred to be "ext4"
+ if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
type: string
readOnly:
- description: |-
- readOnly defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
- More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ description: 'readOnly defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
type: boolean
secretRef:
- description: |-
- secretRef is optional: points to a secret object containing parameters used to connect
- to OpenStack.
+ description: 'secretRef is optional: points
+ to a secret object containing parameters used
+ to connect to OpenStack.'
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
volumeID:
- description: |-
- volumeID used to identify the volume in cinder.
- More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ description: 'volumeID used to identify the
+ volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
type: string
required:
- volumeID
@@ -24553,25 +24783,31 @@ spec:
should populate this volume
properties:
defaultMode:
- description: |-
- defaultMode is optional: mode bits used to set permissions on created files by default.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- Defaults to 0644.
- Directories within the path are not affected by this setting.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'defaultMode is optional: mode
+ bits used to set permissions on created files
+ by default. Must be an octal value between
+ 0000 and 0777 or a decimal value between 0
+ and 511. YAML accepts both octal and decimal
+ values, JSON requires decimal values for mode
+ bits. Defaults to 0644. Directories within
+ the path are not affected by this setting.
+ This might be in conflict with other options
+ that affect the file mode, like fsGroup, and
+ the result can be other mode bits set.'
format: int32
type: integer
items:
- description: |-
- items if unspecified, each key-value pair in the Data field of the referenced
- ConfigMap will be projected into the volume as a file whose name is the
- key and content is the value. If specified, the listed keys will be
- projected into the specified paths, and unlisted keys will not be
- present. If a key is specified which is not present in the ConfigMap,
- the volume setup will error unless it is marked optional. Paths must be
- relative and may not contain the '..' path or start with '..'.
+ description: items if unspecified, each key-value
+ pair in the Data field of the referenced ConfigMap
+ will be projected into the volume as a file
+ whose name is the key and content is the value.
+ If specified, the listed keys will be projected
+ into the specified paths, and unlisted keys
+ will not be present. If a key is specified
+ which is not present in the ConfigMap, the
+ volume setup will error unless it is marked
+ optional. Paths must be relative and may not
+ contain the '..' path or start with '..'.
items:
description: Maps a string key to a path within
a volume.
@@ -24580,21 +24816,26 @@ spec:
description: key is the key to project.
type: string
mode:
- description: |-
- mode is Optional: mode bits used to set permissions on this file.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'mode is Optional: mode bits
+ used to set permissions on this file.
+ Must be an octal value between 0000
+ and 0777 or a decimal value between
+ 0 and 511. YAML accepts both octal and
+ decimal values, JSON requires decimal
+ values for mode bits. If not specified,
+ the volume defaultMode will be used.
+ This might be in conflict with other
+ options that affect the file mode, like
+ fsGroup, and the result can be other
+ mode bits set.'
format: int32
type: integer
path:
- description: |-
- path is the relative path of the file to map the key to.
- May not be an absolute path.
- May not contain the path element '..'.
- May not start with the string '..'.
+ description: path is the relative path
+ of the file to map the key to. May not
+ be an absolute path. May not contain
+ the path element '..'. May not start
+ with the string '..'.
type: string
required:
- key
@@ -24602,60 +24843,62 @@ spec:
type: object
type: array
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: optional specify whether the ConfigMap
or its keys must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
csi:
description: csi (Container Storage Interface) represents
ephemeral storage that is handled by certain external
CSI drivers (Beta feature).
properties:
driver:
- description: |-
- driver is the name of the CSI driver that handles this volume.
- Consult with your admin for the correct name as registered in the cluster.
+ description: driver is the name of the CSI driver
+ that handles this volume. Consult with your
+ admin for the correct name as registered in
+ the cluster.
type: string
fsType:
- description: |-
- fsType to mount. Ex. "ext4", "xfs", "ntfs".
- If not provided, the empty value is passed to the associated CSI driver
- which will determine the default filesystem to apply.
+ description: fsType to mount. Ex. "ext4", "xfs",
+ "ntfs". If not provided, the empty value is
+ passed to the associated CSI driver which
+ will determine the default filesystem to apply.
type: string
nodePublishSecretRef:
- description: |-
- nodePublishSecretRef is a reference to the secret object containing
- sensitive information to pass to the CSI driver to complete the CSI
- NodePublishVolume and NodeUnpublishVolume calls.
- This field is optional, and may be empty if no secret is required. If the
- secret object contains more than one secret, all secret references are passed.
+ description: nodePublishSecretRef is a reference
+ to the secret object containing sensitive
+ information to pass to the CSI driver to complete
+ the CSI NodePublishVolume and NodeUnpublishVolume
+ calls. This field is optional, and may be
+ empty if no secret is required. If the secret
+ object contains more than one secret, all
+ secret references are passed.
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
readOnly:
- description: |-
- readOnly specifies a read-only configuration for the volume.
- Defaults to false (read/write).
+ description: readOnly specifies a read-only
+ configuration for the volume. Defaults to
+ false (read/write).
type: boolean
volumeAttributes:
additionalProperties:
type: string
- description: |-
- volumeAttributes stores driver-specific properties that are passed to the CSI
- driver. Consult your driver's documentation for supported values.
+ description: volumeAttributes stores driver-specific
+ properties that are passed to the CSI driver.
+ Consult your driver's documentation for supported
+ values.
type: object
required:
- driver
@@ -24665,15 +24908,18 @@ spec:
about the pod that should populate this volume
properties:
defaultMode:
- description: |-
- Optional: mode bits to use on created files by default. Must be a
- Optional: mode bits used to set permissions on created files by default.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- Defaults to 0644.
- Directories within the path are not affected by this setting.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'Optional: mode bits to use on
+ created files by default. Must be a Optional:
+ mode bits used to set permissions on created
+ files by default. Must be an octal value between
+ 0000 and 0777 or a decimal value between 0
+ and 511. YAML accepts both octal and decimal
+ values, JSON requires decimal values for mode
+ bits. Defaults to 0644. Directories within
+ the path are not affected by this setting.
+ This might be in conflict with other options
+ that affect the file mode, like fsGroup, and
+ the result can be other mode bits set.'
format: int32
type: integer
items:
@@ -24701,15 +24947,19 @@ spec:
required:
- fieldPath
type: object
- x-kubernetes-map-type: atomic
mode:
- description: |-
- Optional: mode bits used to set permissions on this file, must be an octal value
- between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'Optional: mode bits used
+ to set permissions on this file, must
+ be an octal value between 0000 and 0777
+ or a decimal value between 0 and 511.
+ YAML accepts both octal and decimal
+ values, JSON requires decimal values
+ for mode bits. If not specified, the
+ volume defaultMode will be used. This
+ might be in conflict with other options
+ that affect the file mode, like fsGroup,
+ and the result can be other mode bits
+ set.'
format: int32
type: integer
path:
@@ -24721,9 +24971,11 @@ spec:
must not start with ''..'''
type: string
resourceFieldRef:
- description: |-
- Selects a resource of the container: only resources limits and requests
- (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
+ description: 'Selects a resource of the
+ container: only resources limits and
+ requests (limits.cpu, limits.memory,
+ requests.cpu and requests.memory) are
+ currently supported.'
properties:
containerName:
description: 'Container name: required
@@ -24745,132 +24997,134 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
required:
- path
type: object
type: array
type: object
emptyDir:
- description: |-
- emptyDir represents a temporary directory that shares a pod's lifetime.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
+ description: 'emptyDir represents a temporary directory
+ that shares a pod''s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
properties:
medium:
- description: |-
- medium represents what type of storage medium should back this directory.
- The default is "" which means to use the node's default medium.
- Must be an empty string (default) or Memory.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
+ description: 'medium represents what type of
+ storage medium should back this directory.
+ The default is "" which means to use the node''s
+ default medium. Must be an empty string (default)
+ or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
type: string
sizeLimit:
anyOf:
- type: integer
- type: string
- description: |-
- sizeLimit is the total amount of local storage required for this EmptyDir volume.
- The size limit is also applicable for memory medium.
- The maximum usage on memory medium EmptyDir would be the minimum value between
- the SizeLimit specified here and the sum of memory limits of all containers in a pod.
- The default is nil which means that the limit is undefined.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
+ description: 'sizeLimit is the total amount
+ of local storage required for this EmptyDir
+ volume. The size limit is also applicable
+ for memory medium. The maximum usage on memory
+ medium EmptyDir would be the minimum value
+ between the SizeLimit specified here and the
+ sum of memory limits of all containers in
+ a pod. The default is nil which means that
+ the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
type: object
ephemeral:
- description: |-
- ephemeral represents a volume that is handled by a cluster storage driver.
- The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts,
- and deleted when the pod is removed.
-
-
- Use this if:
+ description: "ephemeral represents a volume that
+ is handled by a cluster storage driver. The volume's
+ lifecycle is tied to the pod that defines it -
+ it will be created before the pod starts, and
+ deleted when the pod is removed. \n Use this if:
a) the volume is only needed while the pod runs,
- b) features of normal volumes like restoring from snapshot or capacity
- tracking are needed,
- c) the storage driver is specified through a storage class, and
- d) the storage driver supports dynamic volume provisioning through
- a PersistentVolumeClaim (see EphemeralVolumeSource for more
- information on the connection between this volume type
- and PersistentVolumeClaim).
-
-
- Use PersistentVolumeClaim or one of the vendor-specific
- APIs for volumes that persist for longer than the lifecycle
- of an individual pod.
-
-
- Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to
- be used that way - see the documentation of the driver for
- more information.
-
-
- A pod can use both types of ephemeral volumes and
- persistent volumes at the same time.
+ b) features of normal volumes like restoring from
+ snapshot or capacity tracking are needed, c)
+ the storage driver is specified through a storage
+ class, and d) the storage driver supports dynamic
+ volume provisioning through a PersistentVolumeClaim
+ (see EphemeralVolumeSource for more information
+ on the connection between this volume type and
+ PersistentVolumeClaim). \n Use PersistentVolumeClaim
+ or one of the vendor-specific APIs for volumes
+ that persist for longer than the lifecycle of
+ an individual pod. \n Use CSI for light-weight
+ local ephemeral volumes if the CSI driver is meant
+ to be used that way - see the documentation of
+ the driver for more information. \n A pod can
+ use both types of ephemeral volumes and persistent
+ volumes at the same time."
properties:
volumeClaimTemplate:
- description: |-
- Will be used to create a stand-alone PVC to provision the volume.
- The pod in which this EphemeralVolumeSource is embedded will be the
- owner of the PVC, i.e. the PVC will be deleted together with the
- pod. The name of the PVC will be `-` where
- `` is the name from the `PodSpec.Volumes` array
- entry. Pod validation will reject the pod if the concatenated name
+ description: "Will be used to create a stand-alone
+ PVC to provision the volume. The pod in which
+ this EphemeralVolumeSource is embedded will
+ be the owner of the PVC, i.e. the PVC will
+ be deleted together with the pod. The name
+ of the PVC will be `-`
+ where `` is the name from the
+ `PodSpec.Volumes` array entry. Pod validation
+ will reject the pod if the concatenated name
is not valid for a PVC (for example, too long).
-
-
- An existing PVC with that name that is not owned by the pod
- will *not* be used for the pod to avoid using an unrelated
- volume by mistake. Starting the pod is then blocked until
- the unrelated PVC is removed. If such a pre-created PVC is
- meant to be used by the pod, the PVC has to updated with an
- owner reference to the pod once the pod exists. Normally
- this should not be necessary, but it may be useful when
- manually reconstructing a broken cluster.
-
-
- This field is read-only and no changes will be made by Kubernetes
- to the PVC after it has been created.
-
-
- Required, must not be nil.
+ \n An existing PVC with that name that is
+ not owned by the pod will *not* be used for
+ the pod to avoid using an unrelated volume
+ by mistake. Starting the pod is then blocked
+ until the unrelated PVC is removed. If such
+ a pre-created PVC is meant to be used by the
+ pod, the PVC has to updated with an owner
+ reference to the pod once the pod exists.
+ Normally this should not be necessary, but
+ it may be useful when manually reconstructing
+ a broken cluster. \n This field is read-only
+ and no changes will be made by Kubernetes
+ to the PVC after it has been created. \n Required,
+ must not be nil."
properties:
metadata:
- description: |-
- May contain labels and annotations that will be copied into the PVC
- when creating it. No other fields are allowed and will be rejected during
- validation.
+ description: May contain labels and annotations
+ that will be copied into the PVC when
+ creating it. No other fields are allowed
+ and will be rejected during validation.
type: object
spec:
- description: |-
- The specification for the PersistentVolumeClaim. The entire content is
- copied unchanged into the PVC that gets created from this
+ description: The specification for the PersistentVolumeClaim.
+ The entire content is copied unchanged
+ into the PVC that gets created from this
template. The same fields as in a PersistentVolumeClaim
are also valid here.
properties:
accessModes:
- description: |-
- accessModes contains the desired access modes the volume should have.
- More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
+ description: 'accessModes contains the
+ desired access modes the volume should
+ have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
items:
type: string
type: array
dataSource:
- description: |-
- dataSource field can be used to specify either:
- * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
+ description: 'dataSource field can be
+ used to specify either: * An existing
+ VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
* An existing PVC (PersistentVolumeClaim)
- If the provisioner or an external controller can support the specified data source,
- it will create a new volume based on the contents of the specified data source.
- When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,
- and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.
- If the namespace is specified, then dataSourceRef will not be copied to dataSource.
+ If the provisioner or an external
+ controller can support the specified
+ data source, it will create a new
+ volume based on the contents of the
+ specified data source. When the AnyVolumeDataSource
+ feature gate is enabled, dataSource
+ contents will be copied to dataSourceRef,
+ and dataSourceRef contents will be
+ copied to dataSource when dataSourceRef.namespace
+ is not specified. If the namespace
+ is specified, then dataSourceRef will
+ not be copied to dataSource.'
properties:
apiGroup:
- description: |-
- APIGroup is the group for the resource being referenced.
- If APIGroup is not specified, the specified Kind must be in the core API group.
- For any other third-party types, APIGroup is required.
+ description: APIGroup is the group
+ for the resource being referenced.
+ If APIGroup is not specified,
+ the specified Kind must be in
+ the core API group. For any other
+ third-party types, APIGroup is
+ required.
type: string
kind:
description: Kind is the type of
@@ -24884,38 +25138,57 @@ spec:
- kind
- name
type: object
- x-kubernetes-map-type: atomic
dataSourceRef:
- description: |-
- dataSourceRef specifies the object from which to populate the volume with data, if a non-empty
- volume is desired. This may be any object from a non-empty API group (non
- core object) or a PersistentVolumeClaim object.
- When this field is specified, volume binding will only succeed if the type of
- the specified object matches some installed volume populator or dynamic
- provisioner.
- This field will replace the functionality of the dataSource field and as such
- if both fields are non-empty, they must have the same value. For backwards
- compatibility, when namespace isn't specified in dataSourceRef,
- both fields (dataSource and dataSourceRef) will be set to the same
- value automatically if one of them is empty and the other is non-empty.
- When namespace is specified in dataSourceRef,
- dataSource isn't set to the same value and must be empty.
- There are three important differences between dataSource and dataSourceRef:
- * While dataSource only allows two specific types of objects, dataSourceRef
- allows any non-core object, as well as PersistentVolumeClaim objects.
- * While dataSource ignores disallowed values (dropping them), dataSourceRef
- preserves all values, and generates an error if a disallowed value is
- specified.
- * While dataSource only allows local objects, dataSourceRef allows objects
- in any namespaces.
- (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
- (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
+ description: 'dataSourceRef specifies
+ the object from which to populate
+ the volume with data, if a non-empty
+ volume is desired. This may be any
+ object from a non-empty API group
+ (non core object) or a PersistentVolumeClaim
+ object. When this field is specified,
+ volume binding will only succeed if
+ the type of the specified object matches
+ some installed volume populator or
+ dynamic provisioner. This field will
+ replace the functionality of the dataSource
+ field and as such if both fields are
+ non-empty, they must have the same
+ value. For backwards compatibility,
+ when namespace isn''t specified in
+ dataSourceRef, both fields (dataSource
+ and dataSourceRef) will be set to
+ the same value automatically if one
+ of them is empty and the other is
+ non-empty. When namespace is specified
+ in dataSourceRef, dataSource isn''t
+ set to the same value and must be
+ empty. There are three important differences
+ between dataSource and dataSourceRef:
+ * While dataSource only allows two
+ specific types of objects, dataSourceRef allows
+ any non-core object, as well as PersistentVolumeClaim
+ objects. * While dataSource ignores
+ disallowed values (dropping them),
+ dataSourceRef preserves all values,
+ and generates an error if a disallowed
+ value is specified. * While dataSource
+ only allows local objects, dataSourceRef
+ allows objects in any namespaces.
+ (Beta) Using this field requires the
+ AnyVolumeDataSource feature gate to
+ be enabled. (Alpha) Using the namespace
+ field of dataSourceRef requires the
+ CrossNamespaceVolumeDataSource feature
+ gate to be enabled.'
properties:
apiGroup:
- description: |-
- APIGroup is the group for the resource being referenced.
- If APIGroup is not specified, the specified Kind must be in the core API group.
- For any other third-party types, APIGroup is required.
+ description: APIGroup is the group
+ for the resource being referenced.
+ If APIGroup is not specified,
+ the specified Kind must be in
+ the core API group. For any other
+ third-party types, APIGroup is
+ required.
type: string
kind:
description: Kind is the type of
@@ -24926,22 +25199,32 @@ spec:
resource being referenced
type: string
namespace:
- description: |-
- Namespace is the namespace of resource being referenced
- Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.
- (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
+ description: Namespace is the namespace
+ of resource being referenced Note
+ that when a namespace is specified,
+ a gateway.networking.k8s.io/ReferenceGrant
+ object is required in the referent
+ namespace to allow that namespace's
+ owner to accept the reference.
+ See the ReferenceGrant documentation
+ for details. (Alpha) This field
+ requires the CrossNamespaceVolumeDataSource
+ feature gate to be enabled.
type: string
required:
- kind
- name
type: object
resources:
- description: |-
- resources represents the minimum resources the volume should have.
- If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements
- that are lower than previous value but must still be higher than capacity recorded in the
- status field of the claim.
- More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
+ description: 'resources represents the
+ minimum resources the volume should
+ have. If RecoverVolumeExpansionFailure
+ feature is enabled users are allowed
+ to specify resource requirements that
+ are lower than previous value but
+ must still be higher than capacity
+ recorded in the status field of the
+ claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
properties:
limits:
additionalProperties:
@@ -24950,9 +25233,9 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Limits describes the maximum amount of compute resources allowed.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Limits describes the
+ maximum amount of compute resources
+ allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -24961,11 +25244,15 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Requests describes the minimum amount of compute resources required.
- If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
- otherwise to an implementation-defined value. Requests cannot exceed Limits.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Requests describes
+ the minimum amount of compute
+ resources required. If Requests
+ is omitted for a container, it
+ defaults to Limits if that is
+ explicitly specified, otherwise
+ to an implementation-defined value.
+ Requests cannot exceed Limits.
+ More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
selector:
@@ -24977,9 +25264,11 @@ spec:
a list of label selector requirements.
The requirements are ANDed.
items:
- description: |-
- A label selector requirement is a selector that contains values, a key, and an operator that
- relates the key and values.
+ description: A label selector
+ requirement is a selector that
+ contains values, a key, and
+ an operator that relates the
+ key and values.
properties:
key:
description: key is the label
@@ -24987,16 +25276,23 @@ spec:
to.
type: string
operator:
- description: |-
- operator represents a key's relationship to a set of values.
- Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents
+ a key's relationship to
+ a set of values. Valid operators
+ are In, NotIn, Exists and
+ DoesNotExist.
type: string
values:
- description: |-
- values is an array of string values. If the operator is In or NotIn,
- the values array must be non-empty. If the operator is Exists or DoesNotExist,
- the values array must be empty. This array is replaced during a strategic
- merge patch.
+ description: values is an
+ array of string values.
+ If the operator is In or
+ NotIn, the values array
+ must be non-empty. If the
+ operator is Exists or DoesNotExist,
+ the values array must be
+ empty. This array is replaced
+ during a strategic merge
+ patch.
items:
type: string
type: array
@@ -25008,37 +25304,55 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: |-
- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions, whose key field is "key", the
- operator is "In", and the values array contains only "value". The requirements are ANDed.
+ description: matchLabels is a map
+ of {key,value} pairs. A single
+ {key,value} in the matchLabels
+ map is equivalent to an element
+ of matchExpressions, whose key
+ field is "key", the operator is
+ "In", and the values array contains
+ only "value". The requirements
+ are ANDed.
type: object
type: object
- x-kubernetes-map-type: atomic
storageClassName:
- description: |-
- storageClassName is the name of the StorageClass required by the claim.
- More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
+ description: 'storageClassName is the
+ name of the StorageClass required
+ by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
type: string
volumeAttributesClassName:
- description: |-
- volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.
- If specified, the CSI driver will create or update the volume with the attributes defined
- in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,
- it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass
- will be applied to the claim but it's not allowed to reset this field to empty string once it is set.
- If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass
- will be set by the persistentvolume controller if it exists.
- If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be
- set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource
- exists.
+ description: 'volumeAttributesClassName
+ may be used to set the VolumeAttributesClass
+ used by this claim. If specified,
+ the CSI driver will create or update
+ the volume with the attributes defined
+ in the corresponding VolumeAttributesClass.
+ This has a different purpose than
+ storageClassName, it can be changed
+ after the claim is created. An empty
+ string value means that no VolumeAttributesClass
+ will be applied to the claim but it''s
+ not allowed to reset this field to
+ empty string once it is set. If unspecified
+ and the PersistentVolumeClaim is unbound,
+ the default VolumeAttributesClass
+ will be set by the persistentvolume
+ controller if it exists. If the resource
+ referred to by volumeAttributesClass
+ does not exist, this PersistentVolumeClaim
+ will be set to a Pending state, as
+ reflected by the modifyVolumeStatus
+ field, until such as a resource exists.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass
- (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.
+ (Alpha) Using this field requires
+ the VolumeAttributesClass feature
+ gate to be enabled.'
type: string
volumeMode:
- description: |-
- volumeMode defines what type of volume is required by the claim.
- Value of Filesystem is implied when not included in claim spec.
+ description: volumeMode defines what
+ type of volume is required by the
+ claim. Value of Filesystem is implied
+ when not included in claim spec.
type: string
volumeName:
description: volumeName is the binding
@@ -25056,11 +25370,12 @@ spec:
then exposed to the pod.
properties:
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- TODO: how do we prevent errors in the filesystem from compromising the machine
+ description: 'fsType is the filesystem type
+ to mount. Must be a filesystem type supported
+ by the host operating system. Ex. "ext4",
+ "xfs", "ntfs". Implicitly inferred to be "ext4"
+ if unspecified. TODO: how do we prevent errors
+ in the filesystem from compromising the machine'
type: string
lun:
description: 'lun is Optional: FC target lun
@@ -25068,9 +25383,9 @@ spec:
format: int32
type: integer
readOnly:
- description: |-
- readOnly is Optional: Defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: 'readOnly is Optional: Defaults
+ to false (read/write). ReadOnly here will
+ force the ReadOnly setting in VolumeMounts.'
type: boolean
targetWWNs:
description: 'targetWWNs is Optional: FC target
@@ -25079,27 +25394,29 @@ spec:
type: string
type: array
wwids:
- description: |-
- wwids Optional: FC volume world wide identifiers (wwids)
- Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
+ description: 'wwids Optional: FC volume world
+ wide identifiers (wwids) Either wwids or combination
+ of targetWWNs and lun must be set, but not
+ both simultaneously.'
items:
type: string
type: array
type: object
flexVolume:
- description: |-
- flexVolume represents a generic volume resource that is
- provisioned/attached using an exec based plugin.
+ description: flexVolume represents a generic volume
+ resource that is provisioned/attached using an
+ exec based plugin.
properties:
driver:
description: driver is the name of the driver
to use for this volume.
type: string
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
+ description: fsType is the filesystem type to
+ mount. Must be a filesystem type supported
+ by the host operating system. Ex. "ext4",
+ "xfs", "ntfs". The default filesystem depends
+ on FlexVolume script.
type: string
options:
additionalProperties:
@@ -25108,26 +25425,26 @@ spec:
holds extra command options if any.'
type: object
readOnly:
- description: |-
- readOnly is Optional: defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: 'readOnly is Optional: defaults
+ to false (read/write). ReadOnly here will
+ force the ReadOnly setting in VolumeMounts.'
type: boolean
secretRef:
- description: |-
- secretRef is Optional: secretRef is reference to the secret object containing
- sensitive information to pass to the plugin scripts. This may be
- empty if no secret object is specified. If the secret object
- contains more than one secret, all secrets are passed to the plugin
- scripts.
+ description: 'secretRef is Optional: secretRef
+ is reference to the secret object containing
+ sensitive information to pass to the plugin
+ scripts. This may be empty if no secret object
+ is specified. If the secret object contains
+ more than one secret, all secrets are passed
+ to the plugin scripts.'
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
required:
- driver
type: object
@@ -25137,9 +25454,9 @@ spec:
on the Flocker control service being running
properties:
datasetName:
- description: |-
- datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker
- should be considered as deprecated
+ description: datasetName is Name of the dataset
+ stored as metadata -> name on the dataset
+ for Flocker should be considered as deprecated
type: string
datasetUUID:
description: datasetUUID is the UUID of the
@@ -25148,55 +25465,59 @@ spec:
type: string
type: object
gcePersistentDisk:
- description: |-
- gcePersistentDisk represents a GCE Disk resource that is attached to a
- kubelet's host machine and then exposed to the pod.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ description: 'gcePersistentDisk represents a GCE
+ Disk resource that is attached to a kubelet''s
+ host machine and then exposed to the pod. More
+ info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
properties:
fsType:
- description: |-
- fsType is filesystem type of the volume that you want to mount.
- Tip: Ensure that the filesystem type is supported by the host operating system.
- Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
- TODO: how do we prevent errors in the filesystem from compromising the machine
+ description: 'fsType is filesystem type of the
+ volume that you want to mount. Tip: Ensure
+ that the filesystem type is supported by the
+ host operating system. Examples: "ext4", "xfs",
+ "ntfs". Implicitly inferred to be "ext4" if
+ unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
partition:
- description: |-
- partition is the partition in the volume that you want to mount.
- If omitted, the default is to mount by volume name.
- Examples: For volume /dev/sda1, you specify the partition as "1".
- Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ description: 'partition is the partition in
+ the volume that you want to mount. If omitted,
+ the default is to mount by volume name. Examples:
+ For volume /dev/sda1, you specify the partition
+ as "1". Similarly, the volume partition for
+ /dev/sda is "0" (or you can leave the property
+ empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
format: int32
type: integer
pdName:
- description: |-
- pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ description: 'pdName is unique name of the PD
+ resource in GCE. Used to identify the disk
+ in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
type: string
readOnly:
- description: |-
- readOnly here will force the ReadOnly setting in VolumeMounts.
- Defaults to false.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ description: 'readOnly here will force the ReadOnly
+ setting in VolumeMounts. Defaults to false.
+ More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
type: boolean
required:
- pdName
type: object
gitRepo:
- description: |-
- gitRepo represents a git repository at a particular revision.
- DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an
- EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir
- into the Pod's container.
+ description: 'gitRepo represents a git repository
+ at a particular revision. DEPRECATED: GitRepo
+ is deprecated. To provision a container with a
+ git repo, mount an EmptyDir into an InitContainer
+ that clones the repo using git, then mount the
+ EmptyDir into the Pod''s container.'
properties:
directory:
- description: |-
- directory is the target directory name.
- Must not contain or start with '..'. If '.' is supplied, the volume directory will be the
- git repository. Otherwise, if specified, the volume will contain the git repository in
- the subdirectory with the given name.
+ description: directory is the target directory
+ name. Must not contain or start with '..'. If
+ '.' is supplied, the volume directory will
+ be the git repository. Otherwise, if specified,
+ the volume will contain the git repository
+ in the subdirectory with the given name.
type: string
repository:
description: repository is the URL
@@ -25209,61 +25530,55 @@ spec:
- repository
type: object
glusterfs:
- description: |-
- glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.
- More info: https://examples.k8s.io/volumes/glusterfs/README.md
+ description: 'glusterfs represents a Glusterfs mount
+ on the host that shares a pod''s lifetime. More
+ info: https://examples.k8s.io/volumes/glusterfs/README.md'
properties:
endpoints:
- description: |-
- endpoints is the endpoint name that details Glusterfs topology.
- More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
+ description: 'endpoints is the endpoint name
+ that details Glusterfs topology. More info:
+ https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: string
path:
- description: |-
- path is the Glusterfs volume path.
- More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
+ description: 'path is the Glusterfs volume path.
+ More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: string
readOnly:
- description: |-
- readOnly here will force the Glusterfs volume to be mounted with read-only permissions.
- Defaults to false.
- More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
+ description: 'readOnly here will force the Glusterfs
+ volume to be mounted with read-only permissions.
+ Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: boolean
required:
- endpoints
- path
type: object
hostPath:
- description: |-
- hostPath represents a pre-existing file or directory on the host
- machine that is directly exposed to the container. This is generally
- used for system agents or other privileged things that are allowed
- to see the host machine. Most containers will NOT need this.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
- ---
- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not
- mount host directories as read/write.
+ description: 'hostPath represents a pre-existing
+ file or directory on the host machine that is
+ directly exposed to the container. This is generally
+ used for system agents or other privileged things
+ that are allowed to see the host machine. Most
+ containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
+ --- TODO(jonesdl) We need to restrict who can
+ use host directory mounts and who can/can not
+ mount host directories as read/write.'
properties:
path:
- description: |-
- path of the directory on the host.
- If the path is a symlink, it will follow the link to the real path.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
+ description: 'path of the directory on the host.
+ If the path is a symlink, it will follow the
+ link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
type: string
type:
- description: |-
- type for HostPath Volume
- Defaults to ""
- More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
+ description: 'type for HostPath Volume Defaults
+ to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
type: string
required:
- path
type: object
iscsi:
- description: |-
- iscsi represents an ISCSI Disk resource that is attached to a
- kubelet's host machine and then exposed to the pod.
- More info: https://examples.k8s.io/volumes/iscsi/README.md
+ description: 'iscsi represents an ISCSI Disk resource
+ that is attached to a kubelet''s host machine
+ and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md'
properties:
chapAuthDiscovery:
description: chapAuthDiscovery defines whether
@@ -25274,27 +25589,30 @@ spec:
support iSCSI Session CHAP authentication
type: boolean
fsType:
- description: |-
- fsType is the filesystem type of the volume that you want to mount.
- Tip: Ensure that the filesystem type is supported by the host operating system.
- Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
- TODO: how do we prevent errors in the filesystem from compromising the machine
+ description: 'fsType is the filesystem type
+ of the volume that you want to mount. Tip:
+ Ensure that the filesystem type is supported
+ by the host operating system. Examples: "ext4",
+ "xfs", "ntfs". Implicitly inferred to be "ext4"
+ if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
initiatorName:
- description: |-
- initiatorName is the custom iSCSI Initiator Name.
- If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface
- : will be created for the connection.
+ description: initiatorName is the custom iSCSI
+ Initiator Name. If initiatorName is specified
+ with iscsiInterface simultaneously, new iSCSI
+ interface : will
+ be created for the connection.
type: string
iqn:
description: iqn is the target iSCSI Qualified
Name.
type: string
iscsiInterface:
- description: |-
- iscsiInterface is the interface Name that uses an iSCSI transport.
- Defaults to 'default' (tcp).
+ description: iscsiInterface is the interface
+ Name that uses an iSCSI transport. Defaults
+ to 'default' (tcp).
type: string
lun:
description: lun represents iSCSI Target Lun
@@ -25302,33 +25620,33 @@ spec:
format: int32
type: integer
portals:
- description: |-
- portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port
- is other than default (typically TCP ports 860 and 3260).
+ description: portals is the iSCSI Target Portal
+ List. The portal is either an IP or ip_addr:port
+ if the port is other than default (typically
+ TCP ports 860 and 3260).
items:
type: string
type: array
readOnly:
- description: |-
- readOnly here will force the ReadOnly setting in VolumeMounts.
- Defaults to false.
+ description: readOnly here will force the ReadOnly
+ setting in VolumeMounts. Defaults to false.
type: boolean
secretRef:
description: secretRef is the CHAP Secret for
iSCSI target and initiator authentication
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
targetPortal:
- description: |-
- targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port
- is other than default (typically TCP ports 860 and 3260).
+ description: targetPortal is iSCSI Target Portal.
+ The Portal is either an IP or ip_addr:port
+ if the port is other than default (typically
+ TCP ports 860 and 3260).
type: string
required:
- iqn
@@ -25336,51 +25654,44 @@ spec:
- targetPortal
type: object
name:
- description: |-
- name of the volume.
- Must be a DNS_LABEL and unique within the pod.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ description: 'name of the volume. Must be a DNS_LABEL
+ and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
type: string
nfs:
- description: |-
- nfs represents an NFS mount on the host that shares a pod's lifetime
- More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ description: 'nfs represents an NFS mount on the
+ host that shares a pod''s lifetime More info:
+ https://kubernetes.io/docs/concepts/storage/volumes#nfs'
properties:
path:
- description: |-
- path that is exported by the NFS server.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ description: 'path that is exported by the NFS
+ server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: string
readOnly:
- description: |-
- readOnly here will force the NFS export to be mounted with read-only permissions.
- Defaults to false.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ description: 'readOnly here will force the NFS
+ export to be mounted with read-only permissions.
+ Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: boolean
server:
- description: |-
- server is the hostname or IP address of the NFS server.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ description: 'server is the hostname or IP address
+ of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: string
required:
- path
- server
type: object
persistentVolumeClaim:
- description: |-
- persistentVolumeClaimVolumeSource represents a reference to a
- PersistentVolumeClaim in the same namespace.
- More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
+ description: 'persistentVolumeClaimVolumeSource
+ represents a reference to a PersistentVolumeClaim
+ in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
properties:
claimName:
- description: |-
- claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.
- More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
+ description: 'claimName is the name of a PersistentVolumeClaim
+ in the same namespace as the pod using this
+ volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
type: string
readOnly:
- description: |-
- readOnly Will force the ReadOnly setting in VolumeMounts.
- Default false.
+ description: readOnly Will force the ReadOnly
+ setting in VolumeMounts. Default false.
type: boolean
required:
- claimName
@@ -25391,10 +25702,11 @@ spec:
host machine
properties:
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: fsType is the filesystem type to
+ mount. Must be a filesystem type supported
+ by the host operating system. Ex. "ext4",
+ "xfs", "ntfs". Implicitly inferred to be "ext4"
+ if unspecified.
type: string
pdID:
description: pdID is the ID that identifies
@@ -25408,15 +25720,16 @@ spec:
volume attached and mounted on kubelets host machine
properties:
fsType:
- description: |-
- fSType represents the filesystem type to mount
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
+ description: fSType represents the filesystem
+ type to mount Must be a filesystem type supported
+ by the host operating system. Ex. "ext4",
+ "xfs". Implicitly inferred to be "ext4" if
+ unspecified.
type: string
readOnly:
- description: |-
- readOnly defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: readOnly defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
volumeID:
description: volumeID uniquely identifies a
@@ -25430,13 +25743,16 @@ spec:
secrets, configmaps, and downward API
properties:
defaultMode:
- description: |-
- defaultMode are the mode bits used to set permissions on created files by default.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- Directories within the path are not affected by this setting.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: defaultMode are the mode bits used
+ to set permissions on created files by default.
+ Must be an octal value between 0000 and 0777
+ or a decimal value between 0 and 511. YAML
+ accepts both octal and decimal values, JSON
+ requires decimal values for mode bits. Directories
+ within the path are not affected by this setting.
+ This might be in conflict with other options
+ that affect the file mode, like fsGroup, and
+ the result can be other mode bits set.
format: int32
type: integer
sources:
@@ -25446,30 +25762,31 @@ spec:
along with other supported volume types
properties:
clusterTrustBundle:
- description: |-
- ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field
- of ClusterTrustBundle objects in an auto-updating file.
-
-
- Alpha, gated by the ClusterTrustBundleProjection feature gate.
-
-
- ClusterTrustBundle objects can either be selected by name, or by the
- combination of signer name and a label selector.
-
-
- Kubelet performs aggressive normalization of the PEM contents written
- into the pod filesystem. Esoteric PEM features such as inter-block
- comments and block headers are stripped. Certificates are deduplicated.
- The ordering of certificates within the file is arbitrary, and Kubelet
- may change the order over time.
+ description: "ClusterTrustBundle allows
+ a pod to access the `.spec.trustBundle`
+ field of ClusterTrustBundle objects
+ in an auto-updating file. \n Alpha,
+ gated by the ClusterTrustBundleProjection
+ feature gate. \n ClusterTrustBundle
+ objects can either be selected by name,
+ or by the combination of signer name
+ and a label selector. \n Kubelet performs
+ aggressive normalization of the PEM
+ contents written into the pod filesystem.
+ \ Esoteric PEM features such as inter-block
+ comments and block headers are stripped.
+ \ Certificates are deduplicated. The
+ ordering of certificates within the
+ file is arbitrary, and Kubelet may change
+ the order over time."
properties:
labelSelector:
- description: |-
- Select all ClusterTrustBundles that match this label selector. Only has
- effect if signerName is set. Mutually-exclusive with name. If unset,
- interpreted as "match nothing". If set but empty, interpreted as "match
- everything".
+ description: Select all ClusterTrustBundles
+ that match this label selector. Only
+ has effect if signerName is set. Mutually-exclusive
+ with name. If unset, interpreted
+ as "match nothing". If set but
+ empty, interpreted as "match everything".
properties:
matchExpressions:
description: matchExpressions
@@ -25477,9 +25794,11 @@ spec:
requirements. The requirements
are ANDed.
items:
- description: |-
- A label selector requirement is a selector that contains values, a key, and an operator that
- relates the key and values.
+ description: A label selector
+ requirement is a selector
+ that contains values, a key,
+ and an operator that relates
+ the key and values.
properties:
key:
description: key is the
@@ -25487,16 +25806,23 @@ spec:
applies to.
type: string
operator:
- description: |-
- operator represents a key's relationship to a set of values.
- Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents
+ a key's relationship to
+ a set of values. Valid
+ operators are In, NotIn,
+ Exists and DoesNotExist.
type: string
values:
- description: |-
- values is an array of string values. If the operator is In or NotIn,
- the values array must be non-empty. If the operator is Exists or DoesNotExist,
- the values array must be empty. This array is replaced during a strategic
- merge patch.
+ description: values is an
+ array of string values.
+ If the operator is In
+ or NotIn, the values array
+ must be non-empty. If
+ the operator is Exists
+ or DoesNotExist, the values
+ array must be empty. This
+ array is replaced during
+ a strategic merge patch.
items:
type: string
type: array
@@ -25508,35 +25834,42 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: |-
- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions, whose key field is "key", the
- operator is "In", and the values array contains only "value". The requirements are ANDed.
+ description: matchLabels is a
+ map of {key,value} pairs. A
+ single {key,value} in the matchLabels
+ map is equivalent to an element
+ of matchExpressions, whose key
+ field is "key", the operator
+ is "In", and the values array
+ contains only "value". The requirements
+ are ANDed.
type: object
type: object
- x-kubernetes-map-type: atomic
name:
- description: |-
- Select a single ClusterTrustBundle by object name. Mutually-exclusive
+ description: Select a single ClusterTrustBundle
+ by object name. Mutually-exclusive
with signerName and labelSelector.
type: string
optional:
- description: |-
- If true, don't block pod startup if the referenced ClusterTrustBundle(s)
- aren't available. If using name, then the named ClusterTrustBundle is
- allowed not to exist. If using signerName, then the combination of
- signerName and labelSelector is allowed to match zero
- ClusterTrustBundles.
+ description: If true, don't block
+ pod startup if the referenced ClusterTrustBundle(s)
+ aren't available. If using name,
+ then the named ClusterTrustBundle
+ is allowed not to exist. If using
+ signerName, then the combination
+ of signerName and labelSelector
+ is allowed to match zero ClusterTrustBundles.
type: boolean
path:
description: Relative path from the
volume root to write the bundle.
type: string
signerName:
- description: |-
- Select all ClusterTrustBundles that match this signer name.
- Mutually-exclusive with name. The contents of all selected
- ClusterTrustBundles will be unified and deduplicated.
+ description: Select all ClusterTrustBundles
+ that match this signer name. Mutually-exclusive
+ with name. The contents of all
+ selected ClusterTrustBundles will
+ be unified and deduplicated.
type: string
required:
- path
@@ -25546,14 +25879,21 @@ spec:
the configMap data to project
properties:
items:
- description: |-
- items if unspecified, each key-value pair in the Data field of the referenced
- ConfigMap will be projected into the volume as a file whose name is the
- key and content is the value. If specified, the listed keys will be
- projected into the specified paths, and unlisted keys will not be
- present. If a key is specified which is not present in the ConfigMap,
- the volume setup will error unless it is marked optional. Paths must be
- relative and may not contain the '..' path or start with '..'.
+ description: items if unspecified,
+ each key-value pair in the Data
+ field of the referenced ConfigMap
+ will be projected into the volume
+ as a file whose name is the key
+ and content is the value. If specified,
+ the listed keys will be projected
+ into the specified paths, and unlisted
+ keys will not be present. If a key
+ is specified which is not present
+ in the ConfigMap, the volume setup
+ will error unless it is marked optional.
+ Paths must be relative and may not
+ contain the '..' path or start with
+ '..'.
items:
description: Maps a string key to
a path within a volume.
@@ -25563,21 +25903,30 @@ spec:
to project.
type: string
mode:
- description: |-
- mode is Optional: mode bits used to set permissions on this file.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'mode is Optional:
+ mode bits used to set permissions
+ on this file. Must be an octal
+ value between 0000 and 0777
+ or a decimal value between
+ 0 and 511. YAML accepts both
+ octal and decimal values,
+ JSON requires decimal values
+ for mode bits. If not specified,
+ the volume defaultMode will
+ be used. This might be in
+ conflict with other options
+ that affect the file mode,
+ like fsGroup, and the result
+ can be other mode bits set.'
format: int32
type: integer
path:
- description: |-
- path is the relative path of the file to map the key to.
- May not be an absolute path.
- May not contain the path element '..'.
- May not start with the string '..'.
+ description: path is the relative
+ path of the file to map the
+ key to. May not be an absolute
+ path. May not contain the
+ path element '..'. May not
+ start with the string '..'.
type: string
required:
- key
@@ -25585,10 +25934,10 @@ spec:
type: object
type: array
name:
- description: |-
- Name of the referent.
+ description: 'Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: optional specify whether
@@ -25596,7 +25945,6 @@ spec:
defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
downwardAPI:
description: downwardAPI information about
the downwardAPI data to project
@@ -25629,15 +25977,22 @@ spec:
required:
- fieldPath
type: object
- x-kubernetes-map-type: atomic
mode:
- description: |-
- Optional: mode bits used to set permissions on this file, must be an octal value
- between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'Optional: mode
+ bits used to set permissions
+ on this file, must be an octal
+ value between 0000 and 0777
+ or a decimal value between
+ 0 and 511. YAML accepts both
+ octal and decimal values,
+ JSON requires decimal values
+ for mode bits. If not specified,
+ the volume defaultMode will
+ be used. This might be in
+ conflict with other options
+ that affect the file mode,
+ like fsGroup, and the result
+ can be other mode bits set.'
format: int32
type: integer
path:
@@ -25651,9 +26006,12 @@ spec:
start with ''..'''
type: string
resourceFieldRef:
- description: |-
- Selects a resource of the container: only resources limits and requests
- (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
+ description: 'Selects a resource
+ of the container: only resources
+ limits and requests (limits.cpu,
+ limits.memory, requests.cpu
+ and requests.memory) are currently
+ supported.'
properties:
containerName:
description: 'Container
@@ -25677,7 +26035,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
required:
- path
type: object
@@ -25688,14 +26045,21 @@ spec:
the secret data to project
properties:
items:
- description: |-
- items if unspecified, each key-value pair in the Data field of the referenced
- Secret will be projected into the volume as a file whose name is the
- key and content is the value. If specified, the listed keys will be
- projected into the specified paths, and unlisted keys will not be
- present. If a key is specified which is not present in the Secret,
- the volume setup will error unless it is marked optional. Paths must be
- relative and may not contain the '..' path or start with '..'.
+ description: items if unspecified,
+ each key-value pair in the Data
+ field of the referenced Secret will
+ be projected into the volume as
+ a file whose name is the key and
+ content is the value. If specified,
+ the listed keys will be projected
+ into the specified paths, and unlisted
+ keys will not be present. If a key
+ is specified which is not present
+ in the Secret, the volume setup
+ will error unless it is marked optional.
+ Paths must be relative and may not
+ contain the '..' path or start with
+ '..'.
items:
description: Maps a string key to
a path within a volume.
@@ -25705,21 +26069,30 @@ spec:
to project.
type: string
mode:
- description: |-
- mode is Optional: mode bits used to set permissions on this file.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'mode is Optional:
+ mode bits used to set permissions
+ on this file. Must be an octal
+ value between 0000 and 0777
+ or a decimal value between
+ 0 and 511. YAML accepts both
+ octal and decimal values,
+ JSON requires decimal values
+ for mode bits. If not specified,
+ the volume defaultMode will
+ be used. This might be in
+ conflict with other options
+ that affect the file mode,
+ like fsGroup, and the result
+ can be other mode bits set.'
format: int32
type: integer
path:
- description: |-
- path is the relative path of the file to map the key to.
- May not be an absolute path.
- May not contain the path element '..'.
- May not start with the string '..'.
+ description: path is the relative
+ path of the file to map the
+ key to. May not be an absolute
+ path. May not contain the
+ path element '..'. May not
+ start with the string '..'.
type: string
required:
- key
@@ -25727,10 +26100,10 @@ spec:
type: object
type: array
name:
- description: |-
- Name of the referent.
+ description: 'Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: optional field specify
@@ -25738,33 +26111,40 @@ spec:
be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
serviceAccountToken:
description: serviceAccountToken is information
about the serviceAccountToken data to
project
properties:
audience:
- description: |-
- audience is the intended audience of the token. A recipient of a token
- must identify itself with an identifier specified in the audience of the
- token, and otherwise should reject the token. The audience defaults to the
- identifier of the apiserver.
+ description: audience is the intended
+ audience of the token. A recipient
+ of a token must identify itself
+ with an identifier specified in
+ the audience of the token, and otherwise
+ should reject the token. The audience
+ defaults to the identifier of the
+ apiserver.
type: string
expirationSeconds:
- description: |-
- expirationSeconds is the requested duration of validity of the service
- account token. As the token approaches expiration, the kubelet volume
- plugin will proactively rotate the service account token. The kubelet will
- start trying to rotate the token if the token is older than 80 percent of
- its time to live or if the token is older than 24 hours.Defaults to 1 hour
+ description: expirationSeconds is
+ the requested duration of validity
+ of the service account token. As
+ the token approaches expiration,
+ the kubelet volume plugin will proactively
+ rotate the service account token.
+ The kubelet will start trying to
+ rotate the token if the token is
+ older than 80 percent of its time
+ to live or if the token is older
+ than 24 hours.Defaults to 1 hour
and must be at least 10 minutes.
format: int64
type: integer
path:
- description: |-
- path is the path relative to the mount point of the file to project the
- token into.
+ description: path is the path relative
+ to the mount point of the file to
+ project the token into.
type: string
required:
- path
@@ -25777,30 +26157,30 @@ spec:
on the host that shares a pod's lifetime
properties:
group:
- description: |-
- group to map volume access to
- Default is no group
+ description: group to map volume access to Default
+ is no group
type: string
readOnly:
- description: |-
- readOnly here will force the Quobyte volume to be mounted with read-only permissions.
+ description: readOnly here will force the Quobyte
+ volume to be mounted with read-only permissions.
Defaults to false.
type: boolean
registry:
- description: |-
- registry represents a single or multiple Quobyte Registry services
- specified as a string as host:port pair (multiple entries are separated with commas)
- which acts as the central registry for volumes
+ description: registry represents a single or
+ multiple Quobyte Registry services specified
+ as a string as host:port pair (multiple entries
+ are separated with commas) which acts as the
+ central registry for volumes
type: string
tenant:
- description: |-
- tenant owning the given Quobyte volume in the Backend
- Used with dynamically provisioned Quobyte volumes, value is set by the plugin
+ description: tenant owning the given Quobyte
+ volume in the Backend Used with dynamically
+ provisioned Quobyte volumes, value is set
+ by the plugin
type: string
user:
- description: |-
- user to map volume access to
- Defaults to serivceaccount user
+ description: user to map volume access to Defaults
+ to serivceaccount user
type: string
volume:
description: volume is a string that references
@@ -25811,68 +26191,59 @@ spec:
- volume
type: object
rbd:
- description: |-
- rbd represents a Rados Block Device mount on the host that shares a pod's lifetime.
- More info: https://examples.k8s.io/volumes/rbd/README.md
+ description: 'rbd represents a Rados Block Device
+ mount on the host that shares a pod''s lifetime.
+ More info: https://examples.k8s.io/volumes/rbd/README.md'
properties:
fsType:
- description: |-
- fsType is the filesystem type of the volume that you want to mount.
- Tip: Ensure that the filesystem type is supported by the host operating system.
- Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd
- TODO: how do we prevent errors in the filesystem from compromising the machine
+ description: 'fsType is the filesystem type
+ of the volume that you want to mount. Tip:
+ Ensure that the filesystem type is supported
+ by the host operating system. Examples: "ext4",
+ "xfs", "ntfs". Implicitly inferred to be "ext4"
+ if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
image:
- description: |-
- image is the rados image name.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'image is the rados image name.
+ More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
keyring:
- description: |-
- keyring is the path to key ring for RBDUser.
- Default is /etc/ceph/keyring.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'keyring is the path to key ring
+ for RBDUser. Default is /etc/ceph/keyring.
+ More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
monitors:
- description: |-
- monitors is a collection of Ceph monitors.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'monitors is a collection of Ceph
+ monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
items:
type: string
type: array
pool:
- description: |-
- pool is the rados pool name.
- Default is rbd.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'pool is the rados pool name. Default
+ is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
readOnly:
- description: |-
- readOnly here will force the ReadOnly setting in VolumeMounts.
- Defaults to false.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'readOnly here will force the ReadOnly
+ setting in VolumeMounts. Defaults to false.
+ More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: boolean
secretRef:
- description: |-
- secretRef is name of the authentication secret for RBDUser. If provided
- overrides keyring.
- Default is nil.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'secretRef is name of the authentication
+ secret for RBDUser. If provided overrides
+ keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
user:
- description: |-
- user is the rados user name.
- Default is admin.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'user is the rados user name. Default
+ is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
required:
- image
@@ -25883,11 +26254,10 @@ spec:
volume attached and mounted on Kubernetes nodes.
properties:
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs".
- Default is "xfs".
+ description: fsType is the filesystem type to
+ mount. Must be a filesystem type supported
+ by the host operating system. Ex. "ext4",
+ "xfs", "ntfs". Default is "xfs".
type: string
gateway:
description: gateway is the host address of
@@ -25899,31 +26269,31 @@ spec:
storage.
type: string
readOnly:
- description: |-
- readOnly Defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: readOnly Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
secretRef:
- description: |-
- secretRef references to the secret for ScaleIO user and other
- sensitive information. If this is not provided, Login operation will fail.
+ description: secretRef references to the secret
+ for ScaleIO user and other sensitive information.
+ If this is not provided, Login operation will
+ fail.
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
sslEnabled:
description: sslEnabled Flag enable/disable
SSL communication with Gateway, default false
type: boolean
storageMode:
- description: |-
- storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.
- Default is ThinProvisioned.
+ description: storageMode indicates whether the
+ storage for a volume should be ThickProvisioned
+ or ThinProvisioned. Default is ThinProvisioned.
type: string
storagePool:
description: storagePool is the ScaleIO Storage
@@ -25934,9 +26304,9 @@ spec:
system as configured in ScaleIO.
type: string
volumeName:
- description: |-
- volumeName is the name of a volume already created in the ScaleIO system
- that is associated with this volume source.
+ description: volumeName is the name of a volume
+ already created in the ScaleIO system that
+ is associated with this volume source.
type: string
required:
- gateway
@@ -25944,30 +26314,35 @@ spec:
- system
type: object
secret:
- description: |-
- secret represents a secret that should populate this volume.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
+ description: 'secret represents a secret that should
+ populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
properties:
defaultMode:
- description: |-
- defaultMode is Optional: mode bits used to set permissions on created files by default.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values
- for mode bits. Defaults to 0644.
- Directories within the path are not affected by this setting.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'defaultMode is Optional: mode
+ bits used to set permissions on created files
+ by default. Must be an octal value between
+ 0000 and 0777 or a decimal value between 0
+ and 511. YAML accepts both octal and decimal
+ values, JSON requires decimal values for mode
+ bits. Defaults to 0644. Directories within
+ the path are not affected by this setting.
+ This might be in conflict with other options
+ that affect the file mode, like fsGroup, and
+ the result can be other mode bits set.'
format: int32
type: integer
items:
- description: |-
- items If unspecified, each key-value pair in the Data field of the referenced
- Secret will be projected into the volume as a file whose name is the
- key and content is the value. If specified, the listed keys will be
- projected into the specified paths, and unlisted keys will not be
- present. If a key is specified which is not present in the Secret,
- the volume setup will error unless it is marked optional. Paths must be
- relative and may not contain the '..' path or start with '..'.
+ description: items If unspecified, each key-value
+ pair in the Data field of the referenced Secret
+ will be projected into the volume as a file
+ whose name is the key and content is the value.
+ If specified, the listed keys will be projected
+ into the specified paths, and unlisted keys
+ will not be present. If a key is specified
+ which is not present in the Secret, the volume
+ setup will error unless it is marked optional.
+ Paths must be relative and may not contain
+ the '..' path or start with '..'.
items:
description: Maps a string key to a path within
a volume.
@@ -25976,21 +26351,26 @@ spec:
description: key is the key to project.
type: string
mode:
- description: |-
- mode is Optional: mode bits used to set permissions on this file.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'mode is Optional: mode bits
+ used to set permissions on this file.
+ Must be an octal value between 0000
+ and 0777 or a decimal value between
+ 0 and 511. YAML accepts both octal and
+ decimal values, JSON requires decimal
+ values for mode bits. If not specified,
+ the volume defaultMode will be used.
+ This might be in conflict with other
+ options that affect the file mode, like
+ fsGroup, and the result can be other
+ mode bits set.'
format: int32
type: integer
path:
- description: |-
- path is the relative path of the file to map the key to.
- May not be an absolute path.
- May not contain the path element '..'.
- May not start with the string '..'.
+ description: path is the relative path
+ of the file to map the key to. May not
+ be an absolute path. May not contain
+ the path element '..'. May not start
+ with the string '..'.
type: string
required:
- key
@@ -26002,9 +26382,9 @@ spec:
the Secret or its keys must be defined
type: boolean
secretName:
- description: |-
- secretName is the name of the secret in the pod's namespace to use.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
+ description: 'secretName is the name of the
+ secret in the pod''s namespace to use. More
+ info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
type: string
type: object
storageos:
@@ -26012,42 +26392,45 @@ spec:
attached and mounted on Kubernetes nodes.
properties:
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: fsType is the filesystem type to
+ mount. Must be a filesystem type supported
+ by the host operating system. Ex. "ext4",
+ "xfs", "ntfs". Implicitly inferred to be "ext4"
+ if unspecified.
type: string
readOnly:
- description: |-
- readOnly defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: readOnly defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
secretRef:
- description: |-
- secretRef specifies the secret to use for obtaining the StorageOS API
- credentials. If not specified, default values will be attempted.
+ description: secretRef specifies the secret
+ to use for obtaining the StorageOS API credentials. If
+ not specified, default values will be attempted.
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
volumeName:
- description: |-
- volumeName is the human-readable name of the StorageOS volume. Volume
- names are only unique within a namespace.
+ description: volumeName is the human-readable
+ name of the StorageOS volume. Volume names
+ are only unique within a namespace.
type: string
volumeNamespace:
- description: |-
- volumeNamespace specifies the scope of the volume within StorageOS. If no
- namespace is specified then the Pod's namespace will be used. This allows the
- Kubernetes name scoping to be mirrored within StorageOS for tighter integration.
- Set VolumeName to any name to override the default behaviour.
- Set to "default" if you are not using namespaces within StorageOS.
- Namespaces that do not pre-exist within StorageOS will be created.
+ description: volumeNamespace specifies the scope
+ of the volume within StorageOS. If no namespace
+ is specified then the Pod's namespace will
+ be used. This allows the Kubernetes name
+ scoping to be mirrored within StorageOS for
+ tighter integration. Set VolumeName to any
+ name to override the default behaviour. Set
+ to "default" if you are not using namespaces
+ within StorageOS. Namespaces that do not pre-exist
+ within StorageOS will be created.
type: string
type: object
vsphereVolume:
@@ -26055,10 +26438,11 @@ spec:
volume attached and mounted on kubelets host machine
properties:
fsType:
- description: |-
- fsType is filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: fsType is filesystem type to mount.
+ Must be a filesystem type supported by the
+ host operating system. Ex. "ext4", "xfs",
+ "ntfs". Implicitly inferred to be "ext4" if
+ unspecified.
type: string
storagePolicyID:
description: storagePolicyID is the storage
@@ -26109,9 +26493,8 @@ spec:
description: The configuration of Affinity trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -26130,9 +26513,9 @@ spec:
integration in the same node (default `false`).
type: boolean
podAffinityLabels:
- description: |-
- Defines a set of pods (namely those matching the label selector, relative to the given namespace) that the
- integration pod(s) should be co-located with.
+ description: Defines a set of pods (namely those matching
+ the label selector, relative to the given namespace)
+ that the integration pod(s) should be co-located with.
items:
type: string
type: array
@@ -26141,9 +26524,10 @@ spec:
integration in the same node (default `false`).
type: boolean
podAntiAffinityLabels:
- description: |-
- Defines a set of pods (namely those matching the label selector, relative to the given namespace) that the
- integration pod(s) should not be co-located with.
+ description: Defines a set of pods (namely those matching
+ the label selector, relative to the given namespace)
+ that the integration pod(s) should not be co-located
+ with.
items:
type: string
type: array
@@ -26158,14 +26542,14 @@ spec:
use for the builder pod.
type: object
baseImage:
- description: |-
- Specify a base image. In order to have the application working properly it must be a container image which has a Java JDK
- installed and ready to use on path (ie `/usr/bin/java`).
+ description: Specify a base image. In order to have the
+ application working properly it must be a container
+ image which has a Java JDK installed and ready to use
+ on path (ie `/usr/bin/java`).
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -26176,21 +26560,28 @@ spec:
reuse existing containers (default `true`)
type: boolean
limitCPU:
- description: |-
- When using `pod` strategy, the maximum amount of CPU required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the maximum amount
+ of CPU required by the pod builder. Deprecated: use
+ TasksRequestCPU instead with task name `builder`.'
type: string
limitMemory:
- description: |-
- When using `pod` strategy, the maximum amount of memory required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the maximum amount
+ of memory required by the pod builder. Deprecated: use
+ TasksRequestCPU instead with task name `builder`.'
type: string
mavenProfiles:
- description: |-
- A list of references pointing to configmaps/secrets that contains a maven profile.
- This configmap/secret is a resource of the IntegrationKit created, therefore it needs to be present in the namespace where the operator is going to create the IntegrationKit.
- The content of the maven profile is expected to be a text containing a valid maven profile starting with `` and ending with `` that will be integrated as an inline profile in the POM.
- Syntax: [configmap|secret]:name[/key], where name represents the resource name, key optionally represents the resource key to be filtered (default key value = profile.xml).
+ description: 'A list of references pointing to configmaps/secrets
+ that contains a maven profile. This configmap/secret
+ is a resource of the IntegrationKit created, therefore
+ it needs to be present in the namespace where the operator
+ is going to create the IntegrationKit. The content of
+ the maven profile is expected to be a text containing
+ a valid maven profile starting with `` and
+ ending with `` that will be integrated as
+ an inline profile in the POM. Syntax: [configmap|secret]:name[/key],
+ where name represents the resource name, key optionally
+ represents the resource key to be filtered (default
+ key value = profile.xml).'
items:
type: string
type: array
@@ -26222,14 +26613,14 @@ spec:
type: string
type: array
requestCPU:
- description: |-
- When using `pod` strategy, the minimum amount of CPU required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the minimum amount
+ of CPU required by the pod builder. Deprecated: use
+ TasksRequestCPU instead with task name `builder`.'
type: string
requestMemory:
- description: |-
- When using `pod` strategy, the minimum amount of memory required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the minimum amount
+ of memory required by the pod builder. Deprecated: use
+ TasksRequestCPU instead with task name `builder`.'
type: string
strategy:
description: The strategy to use, either `pod` or `routine`
@@ -26245,10 +26636,11 @@ spec:
type: string
type: array
tasksFilter:
- description: |-
- A list of tasks sorted by the order of execution in a csv format, ie, `,,...`.
- Mind that you must include also the operator tasks (`builder`, `quarkus-native`, `package`, `jib`, `s2i`)
- if you need to execute them. Useful only with `pod` strategy.
+ description: A list of tasks sorted by the order of execution
+ in a csv format, ie, `,,...`.
+ Mind that you must include also the operator tasks (`builder`,
+ `quarkus-native`, `package`, `jib`, `s2i`) if you need
+ to execute them. Useful only with `pod` strategy.
type: string
tasksLimitCPU:
description: A list of limit cpu configuration for the
@@ -26275,18 +26667,17 @@ spec:
type: string
type: array
verbose:
- description: |-
- Enable verbose logging on build components that support it (e.g. Kaniko build pod).
- Deprecated no longer in use
+ description: Enable verbose logging on build components
+ that support it (e.g. Kaniko build pod). Deprecated
+ no longer in use
type: boolean
type: object
camel:
description: The configuration of Camel trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -26299,10 +26690,12 @@ spec:
type: string
type: array
runtimeVersion:
- description: |-
- The camel-k-runtime version to use for the integration. It overrides the default version set in the Integration Platform.
- You can use a fixed version (for example "3.2.3") or a semantic version (for example "3.x") which will try to resolve
- to the best matching Catalog existing on the cluster.
+ description: The camel-k-runtime version to use for the
+ integration. It overrides the default version set in
+ the Integration Platform. You can use a fixed version
+ (for example "3.2.3") or a semantic version (for example
+ "3.x") which will try to resolve to the best matching
+ Catalog existing on the cluster.
type: string
type: object
container:
@@ -26332,9 +26725,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -26345,10 +26737,14 @@ spec:
kubernetes Service.
type: boolean
image:
- description: |-
- The main container image to use for the Integration. When using this parameter the operator will create a synthetic IntegrationKit which
- won't be able to execute traits requiring CamelCatalog. If the container image you're using is coming from an IntegrationKit, use instead
- Integration `.spec.integrationKit` parameter. If you're moving the Integration across environments, you will also need to create an "external" IntegrationKit.
+ description: The main container image to use for the Integration.
+ When using this parameter the operator will create a
+ synthetic IntegrationKit which won't be able to execute
+ traits requiring CamelCatalog. If the container image
+ you're using is coming from an IntegrationKit, use instead
+ Integration `.spec.integrationKit` parameter. If you're
+ moving the Integration across environments, you will
+ also need to create an "external" IntegrationKit.
type: string
imagePullPolicy:
description: 'The pull policy: Always|Never|IfNotPresent'
@@ -26416,52 +26812,52 @@ spec:
description: The configuration of Cron trait
properties:
activeDeadlineSeconds:
- description: |-
- Specifies the duration in seconds, relative to the start time, that the job
- may be continuously active before it is considered to be failed.
- It defaults to 60s.
+ description: Specifies the duration in seconds, relative
+ to the start time, that the job may be continuously
+ active before it is considered to be failed. It defaults
+ to 60s.
format: int64
type: integer
auto:
- description: |-
- Automatically deploy the integration as CronJob when all routes are
- either starting from a periodic consumer (only `cron`, `timer` and `quartz` are supported) or a passive consumer (e.g. `direct` is a passive consumer).
-
-
- It's required that all periodic consumers have the same period, and it can be expressed as cron schedule (e.g. `1m` can be expressed as `0/1 * * * *`,
- while `35m` or `50s` cannot).
+ description: "Automatically deploy the integration as
+ CronJob when all routes are either starting from a periodic
+ consumer (only `cron`, `timer` and `quartz` are supported)
+ or a passive consumer (e.g. `direct` is a passive consumer).
+ \n It's required that all periodic consumers have the
+ same period, and it can be expressed as cron schedule
+ (e.g. `1m` can be expressed as `0/1 * * * *`, while
+ `35m` or `50s` cannot)."
type: boolean
backoffLimit:
- description: |-
- Specifies the number of retries before marking the job failed.
- It defaults to 2.
+ description: Specifies the number of retries before marking
+ the job failed. It defaults to 2.
format: int32
type: integer
components:
- description: |-
- A comma separated list of the Camel components that need to be customized in order for them to work when the schedule is triggered externally by Kubernetes.
- A specific customizer is activated for each specified component. E.g. for the `timer` component, the `cron-timer` customizer is
- activated (it's present in the `org.apache.camel.k:camel-k-cron` library).
-
-
- Supported components are currently: `cron`, `timer` and `quartz`.
+ description: "A comma separated list of the Camel components
+ that need to be customized in order for them to work
+ when the schedule is triggered externally by Kubernetes.
+ A specific customizer is activated for each specified
+ component. E.g. for the `timer` component, the `cron-timer`
+ customizer is activated (it's present in the `org.apache.camel.k:camel-k-cron`
+ library). \n Supported components are currently: `cron`,
+ `timer` and `quartz`."
type: string
concurrencyPolicy:
- description: |-
- Specifies how to treat concurrent executions of a Job.
- Valid values are:
- - "Allow": allows CronJobs to run concurrently;
- - "Forbid" (default): forbids concurrent runs, skipping next run if previous run hasn't finished yet;
- - "Replace": cancels currently running job and replaces it with a new one
+ description: 'Specifies how to treat concurrent executions
+ of a Job. Valid values are: - "Allow": allows CronJobs
+ to run concurrently; - "Forbid" (default): forbids concurrent
+ runs, skipping next run if previous run hasn''t finished
+ yet; - "Replace": cancels currently running job and
+ replaces it with a new one'
enum:
- Allow
- Forbid
- Replace
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -26469,19 +26865,19 @@ spec:
All traits share this common property.
type: boolean
fallback:
- description: |-
- Use the default Camel implementation of the `cron` endpoint (`quartz`) instead of trying to materialize the integration
- as Kubernetes CronJob.
+ description: Use the default Camel implementation of the
+ `cron` endpoint (`quartz`) instead of trying to materialize
+ the integration as Kubernetes CronJob.
type: boolean
schedule:
- description: |-
- The CronJob schedule for the whole integration. If multiple routes are declared, they must have the same schedule for this
- mechanism to work correctly.
+ description: The CronJob schedule for the whole integration.
+ If multiple routes are declared, they must have the
+ same schedule for this mechanism to work correctly.
type: string
startingDeadlineSeconds:
- description: |-
- Optional deadline in seconds for starting the job if it misses scheduled
- time for any reason. Missed jobs executions will be counted as failed ones.
+ description: Optional deadline in seconds for starting
+ the job if it misses scheduled time for any reason. Missed
+ jobs executions will be counted as failed ones.
format: int64
type: integer
timeZone:
@@ -26492,9 +26888,8 @@ spec:
description: The configuration of Dependencies trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -26505,9 +26900,8 @@ spec:
description: The configuration of Deployer trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -26523,51 +26917,49 @@ spec:
- knative-service
type: string
useSSA:
- description: |-
- Use server-side apply to update the owned resources (default `true`).
- Note that it automatically falls back to client-side patching, if SSA is not available, e.g., on old Kubernetes clusters.
+ description: Use server-side apply to update the owned
+ resources (default `true`). Note that it automatically
+ falls back to client-side patching, if SSA is not available,
+ e.g., on old Kubernetes clusters.
type: boolean
type: object
deployment:
description: The configuration of Deployment trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
description: 'Deprecated: no longer in use.'
type: boolean
progressDeadlineSeconds:
- description: |-
- The maximum time in seconds for the deployment to make progress before it
- is considered to be failed. It defaults to `60s`.
+ description: The maximum time in seconds for the deployment
+ to make progress before it is considered to be failed.
+ It defaults to `60s`.
format: int32
type: integer
rollingUpdateMaxSurge:
anyOf:
- type: integer
- type: string
- description: |-
- The maximum number of pods that can be scheduled above the desired number of
- pods.
- Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
- This can not be 0 if MaxUnavailable is 0.
- Absolute number is calculated from percentage by rounding up.
- Defaults to `25%`.
+ description: 'The maximum number of pods that can be scheduled
+ above the desired number of pods. Value can be an absolute
+ number (ex: 5) or a percentage of desired pods (ex:
+ 10%). This can not be 0 if MaxUnavailable is 0. Absolute
+ number is calculated from percentage by rounding up.
+ Defaults to `25%`.'
x-kubernetes-int-or-string: true
rollingUpdateMaxUnavailable:
anyOf:
- type: integer
- type: string
- description: |-
- The maximum number of pods that can be unavailable during the update.
- Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
- Absolute number is calculated from percentage by rounding down.
- This can not be 0 if MaxSurge is 0.
- Defaults to `25%`.
+ description: 'The maximum number of pods that can be unavailable
+ during the update. Value can be an absolute number (ex:
+ 5) or a percentage of desired pods (ex: 10%). Absolute
+ number is calculated from percentage by rounding down.
+ This can not be 0 if MaxSurge is 0. Defaults to `25%`.'
x-kubernetes-int-or-string: true
strategy:
description: The deployment strategy to use to replace
@@ -26581,9 +26973,8 @@ spec:
description: The configuration of Environment trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
containerMeta:
@@ -26598,11 +26989,12 @@ spec:
and `NO_PROXY` environment variables (default `true`)
type: boolean
vars:
- description: |-
- A list of environment variables to be added to the integration container.
- The syntax is either VAR=VALUE or VAR=[configmap|secret]:name/key, where name represents the resource name,
- and key represents the resource key to be mapped as and environment variable.
- These take precedence over any previously defined environment variables.
+ description: A list of environment variables to be added
+ to the integration container. The syntax is either VAR=VALUE
+ or VAR=[configmap|secret]:name/key, where name represents
+ the resource name, and key represents the resource key
+ to be mapped as and environment variable. These take
+ precedence over any previously defined environment variables.
items:
type: string
type: array
@@ -26611,9 +27003,8 @@ spec:
description: The configuration of Error Handler trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -26628,15 +27019,14 @@ spec:
description: The configuration of GC trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
discoveryCache:
- description: |-
- Discovery client cache to be used, either `disabled`, `disk` or `memory` (default `memory`).
- Deprecated: to be removed from trait configuration.
+ description: 'Discovery client cache to be used, either
+ `disabled`, `disk` or `memory` (default `memory`). Deprecated:
+ to be removed from trait configuration.'
enum:
- disabled
- disk
@@ -26651,9 +27041,8 @@ spec:
description: The configuration of Health trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -26775,19 +27164,17 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to the ingress.
- This can be used to set controller specific annotations, e.g., when using the NGINX Ingress controller:
- See https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md
+ description: 'The annotations added to the ingress. This
+ can be used to set controller specific annotations,
+ e.g., when using the NGINX Ingress controller: See https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md'
type: object
auto:
description: To automatically add an ingress whenever
the integration uses an HTTP endpoint consumer.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -26797,14 +27184,18 @@ spec:
host:
description: To configure the host exposed by the ingress.
type: string
+ ingressClassName:
+ description: The Ingress class name as defined by the
+ Ingress spec See https://kubernetes.io/docs/concepts/services-networking/ingress/
+ type: string
path:
description: To configure the path exposed by the ingress
(default `/`).
type: string
pathType:
- description: |-
- To configure the path type exposed by the ingress.
- One of `Exact`, `Prefix`, `ImplementationSpecific` (default to `Prefix`).
+ description: To configure the path type exposed by the
+ ingress. One of `Exact`, `Prefix`, `ImplementationSpecific`
+ (default to `Prefix`).
enum:
- Exact
- Prefix
@@ -26829,9 +27220,8 @@ spec:
default).
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -26848,23 +27238,25 @@ spec:
description: The configuration of Jolokia trait
properties:
CACert:
- description: |-
- The PEM encoded CA certification file path, used to verify client certificates,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt` for OpenShift).
+ description: The PEM encoded CA certification file path,
+ used to verify client certificates, applicable when
+ `protocol` is `https` and `use-ssl-client-authentication`
+ is `true` (default `/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt`
+ for OpenShift).
type: string
clientPrincipal:
- description: |-
- The principal(s) which must be given in a client certificate to allow access to the Jolokia endpoint,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `clientPrincipal=cn=system:master-proxy`, `cn=hawtio-online.hawtio.svc` and `cn=fuse-console.fuse.svc` for OpenShift).
+ description: The principal(s) which must be given in a
+ client certificate to allow access to the Jolokia endpoint,
+ applicable when `protocol` is `https` and `use-ssl-client-authentication`
+ is `true` (default `clientPrincipal=cn=system:master-proxy`,
+ `cn=hawtio-online.hawtio.svc` and `cn=fuse-console.fuse.svc`
+ for OpenShift).
items:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
discoveryEnabled:
@@ -26875,20 +27267,20 @@ spec:
All traits share this common property.
type: boolean
extendedClientCheck:
- description: |-
- Mandate the client certificate contains a client flag in the extended key usage section,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `true` for OpenShift).
+ description: Mandate the client certificate contains a
+ client flag in the extended key usage section, applicable
+ when `protocol` is `https` and `use-ssl-client-authentication`
+ is `true` (default `true` for OpenShift).
type: boolean
host:
- description: |-
- The Host address to which the Jolokia agent should bind to. If `"\*"` or `"0.0.0.0"` is given,
- the servers binds to every network interface (default `"*"`).
+ description: The Host address to which the Jolokia agent
+ should bind to. If `"\*"` or `"0.0.0.0"` is given, the
+ servers binds to every network interface (default `"*"`).
type: string
options:
- description: |-
- A list of additional Jolokia options as defined
- in https://jolokia.org/reference/html/agents.html#agent-jvm-config[JVM agent configuration options]
+ description: A list of additional Jolokia options as defined
+ in https://jolokia.org/reference/html/agents.html#agent-jvm-config[JVM
+ agent configuration options]
items:
type: string
type: array
@@ -26919,9 +27311,8 @@ spec:
separator)
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
debug:
@@ -26950,9 +27341,9 @@ spec:
type: string
type: array
printCommand:
- description: |-
- Prints the command used the start the JVM in the container logs (default `true`)
- Deprecated: no longer in use.
+ description: 'Prints the command used the start the JVM
+ in the container logs (default `true`) Deprecated: no
+ longer in use.'
type: boolean
type: object
kamelets:
@@ -26963,9 +27354,8 @@ spec:
and their default configuration (enabled by default)
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -26998,16 +27388,16 @@ spec:
description: Enable automatic discovery of all trait properties.
type: boolean
channelSinks:
- description: |-
- List of channels used as destination of integration routes.
- Can contain simple channel names or full Camel URIs.
+ description: List of channels used as destination of integration
+ routes. Can contain simple channel names or full Camel
+ URIs.
items:
type: string
type: array
channelSources:
- description: |-
- List of channels used as source of integration routes.
- Can contain simple channel names or full Camel URIs.
+ description: List of channels used as source of integration
+ routes. Can contain simple channel names or full Camel
+ URIs.
items:
type: string
type: array
@@ -27016,9 +27406,8 @@ spec:
configuration in JSON format.
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -27026,9 +27415,9 @@ spec:
All traits share this common property.
type: boolean
endpointSinks:
- description: |-
- List of endpoints used as destination of integration routes.
- Can contain simple endpoint names or full Camel URIs.
+ description: List of endpoints used as destination of
+ integration routes. Can contain simple endpoint names
+ or full Camel URIs.
items:
type: string
type: array
@@ -27039,49 +27428,56 @@ spec:
type: string
type: array
eventSinks:
- description: |-
- List of event types that the integration will produce.
- Can contain simple event types or full Camel URIs (to use a specific broker).
+ description: List of event types that the integration
+ will produce. Can contain simple event types or full
+ Camel URIs (to use a specific broker).
items:
type: string
type: array
eventSources:
- description: |-
- List of event types that the integration will be subscribed to.
- Can contain simple event types or full Camel URIs (to use a specific broker different from "default").
+ description: List of event types that the integration
+ will be subscribed to. Can contain simple event types
+ or full Camel URIs (to use a specific broker different
+ from "default").
items:
type: string
type: array
filterEventType:
- description: |-
- Enables the default filtering for the Knative trigger using the event type
- If this is true, the created Knative trigger uses the event type as a filter on the event stream when no other filter criteria is given. (default: true)
+ description: 'Enables the default filtering for the Knative
+ trigger using the event type If this is true, the created
+ Knative trigger uses the event type as a filter on the
+ event stream when no other filter criteria is given.
+ (default: true)'
type: boolean
filterSourceChannels:
- description: |-
- Enables filtering on events based on the header "ce-knativehistory". Since this header has been removed in newer versions of
- Knative, filtering is disabled by default.
+ description: Enables filtering on events based on the
+ header "ce-knativehistory". Since this header has been
+ removed in newer versions of Knative, filtering is disabled
+ by default.
type: boolean
filters:
- description: |-
- Sets filter attributes on the event stream (such as event type, source, subject and so on).
- A list of key-value pairs that represent filter attributes and its values.
- The syntax is KEY=VALUE, e.g., `source="my.source"`.
- Filter attributes get set on the Knative trigger that is being created as part of this integration.
+ description: Sets filter attributes on the event stream
+ (such as event type, source, subject and so on). A list
+ of key-value pairs that represent filter attributes
+ and its values. The syntax is KEY=VALUE, e.g., `source="my.source"`.
+ Filter attributes get set on the Knative trigger that
+ is being created as part of this integration.
items:
type: string
type: array
namespaceLabel:
- description: |-
- Enables the camel-k-operator to set the "bindings.knative.dev/include=true" label to the namespace
- As Knative requires this label to perform injection of K_SINK URL into the service.
- If this is false, the integration pod may start and fail, read the SinkBinding Knative documentation. (default: true)
+ description: 'Enables the camel-k-operator to set the
+ "bindings.knative.dev/include=true" label to the namespace
+ As Knative requires this label to perform injection
+ of K_SINK URL into the service. If this is false, the
+ integration pod may start and fail, read the SinkBinding
+ Knative documentation. (default: true)'
type: boolean
sinkBinding:
- description: |-
- Allows binding the integration to a sink via a Knative SinkBinding resource.
- This can be used when the integration targets a single sink.
- It's enabled by default when the integration targets a single sink
+ description: Allows binding the integration to a sink
+ via a Knative SinkBinding resource. This can be used
+ when the integration targets a single sink. It's enabled
+ by default when the integration targets a single sink
(except when the integration is owned by a Knative source).
type: boolean
type: object
@@ -27091,47 +27487,41 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to route.
- This can be used to set knative service specific annotations
- CLI usage example: -t "knative-service.annotations.'haproxy.router.openshift.io/balance'=true"
+ description: 'The annotations added to route. This can
+ be used to set knative service specific annotations
+ CLI usage example: -t "knative-service.annotations.''haproxy.router.openshift.io/balance''=true"'
type: object
auto:
- description: |-
- Automatically deploy the integration as Knative service when all conditions hold:
-
-
- * Integration is using the Knative profile
- * All routes are either starting from an HTTP based consumer or a passive consumer (e.g. `direct` is a passive consumer)
+ description: "Automatically deploy the integration as
+ Knative service when all conditions hold: \n * Integration
+ is using the Knative profile * All routes are either
+ starting from an HTTP based consumer or a passive consumer
+ (e.g. `direct` is a passive consumer)"
type: boolean
autoscalingMetric:
- description: |-
- Configures the Knative autoscaling metric property (e.g. to set `concurrency` based or `cpu` based autoscaling).
-
-
- Refer to the Knative documentation for more information.
+ description: "Configures the Knative autoscaling metric
+ property (e.g. to set `concurrency` based or `cpu` based
+ autoscaling). \n Refer to the Knative documentation
+ for more information."
type: string
autoscalingTarget:
- description: |-
- Sets the allowed concurrency level or CPU percentage (depending on the autoscaling metric) for each Pod.
-
-
- Refer to the Knative documentation for more information.
+ description: "Sets the allowed concurrency level or CPU
+ percentage (depending on the autoscaling metric) for
+ each Pod. \n Refer to the Knative documentation for
+ more information."
type: integer
class:
- description: |-
- Configures the Knative autoscaling class property (e.g. to set `hpa.autoscaling.knative.dev` or `kpa.autoscaling.knative.dev` autoscaling).
-
-
- Refer to the Knative documentation for more information.
+ description: "Configures the Knative autoscaling class
+ property (e.g. to set `hpa.autoscaling.knative.dev`
+ or `kpa.autoscaling.knative.dev` autoscaling). \n Refer
+ to the Knative documentation for more information."
enum:
- kpa.autoscaling.knative.dev
- hpa.autoscaling.knative.dev
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -27139,43 +27529,38 @@ spec:
All traits share this common property.
type: boolean
maxScale:
- description: |-
- An upper bound for the number of Pods that can be running in parallel for the integration.
- Knative has its own cap value that depends on the installation.
-
-
- Refer to the Knative documentation for more information.
+ description: "An upper bound for the number of Pods that
+ can be running in parallel for the integration. Knative
+ has its own cap value that depends on the installation.
+ \n Refer to the Knative documentation for more information."
type: integer
minScale:
- description: |-
- The minimum number of Pods that should be running at any time for the integration. It's **zero** by default, meaning that
- the integration is scaled down to zero when not used for a configured amount of time.
-
-
- Refer to the Knative documentation for more information.
+ description: "The minimum number of Pods that should be
+ running at any time for the integration. It's **zero**
+ by default, meaning that the integration is scaled down
+ to zero when not used for a configured amount of time.
+ \n Refer to the Knative documentation for more information."
type: integer
rolloutDuration:
- description: |-
- Enables to gradually shift traffic to the latest Revision and sets the rollout duration.
- It's disabled by default and must be expressed as a Golang `time.Duration` string representation,
- rounded to a second precision.
+ description: Enables to gradually shift traffic to the
+ latest Revision and sets the rollout duration. It's
+ disabled by default and must be expressed as a Golang
+ `time.Duration` string representation, rounded to a
+ second precision.
type: string
timeoutSeconds:
- description: |-
- The maximum duration in seconds that the request instance is allowed to respond to a request.
+ description: "The maximum duration in seconds that the
+ request instance is allowed to respond to a request.
This field propagates to the integration pod's terminationGracePeriodSeconds
-
-
- Refer to the Knative documentation for more information.
+ \n Refer to the Knative documentation for more information."
format: int64
type: integer
visibility:
- description: |-
- Setting `cluster-local`, Knative service becomes a private service.
- Specifically, this option applies the `networking.knative.dev/visibility` label to Knative service.
-
-
- Refer to the Knative documentation for more information.
+ description: "Setting `cluster-local`, Knative service
+ becomes a private service. Specifically, this option
+ applies the `networking.knative.dev/visibility` label
+ to Knative service. \n Refer to the Knative documentation
+ for more information."
enum:
- cluster-local
type: string
@@ -27187,9 +27572,8 @@ spec:
description: Colorize the log output
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -27229,18 +27613,20 @@ spec:
description: The configuration of Mount trait
properties:
configs:
- description: |-
- A list of configuration pointing to configmap/secret.
- The configuration are expected to be UTF-8 resources as they are processed by runtime Camel Context and tried to be parsed as property files.
- They are also made available on the classpath in order to ease their usage directly from the Route.
- Syntax: [configmap|secret]:name[/key], where name represents the resource name and key optionally represents the resource key to be filtered
+ description: 'A list of configuration pointing to configmap/secret.
+ The configuration are expected to be UTF-8 resources
+ as they are processed by runtime Camel Context and tried
+ to be parsed as property files. They are also made available
+ on the classpath in order to ease their usage directly
+ from the Route. Syntax: [configmap|secret]:name[/key],
+ where name represents the resource name and key optionally
+ represents the resource key to be filtered'
items:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
emptyDirs:
@@ -27253,17 +27639,21 @@ spec:
description: 'Deprecated: no longer in use.'
type: boolean
hotReload:
- description: |-
- Enable "hot reload" when a secret/configmap mounted is edited (default `false`). The configmap/secret must be
- marked with `camel.apache.org/integration` label to be taken in account. The resource will be watched for any kind change, also for
- changes in metadata.
+ description: Enable "hot reload" when a secret/configmap
+ mounted is edited (default `false`). The configmap/secret
+ must be marked with `camel.apache.org/integration` label
+ to be taken in account. The resource will be watched
+ for any kind change, also for changes in metadata.
type: boolean
resources:
- description: |-
- A list of resources (text or binary content) pointing to configmap/secret.
- The resources are expected to be any resource type (text or binary content).
- The destination path can be either a default location or any path specified by the user.
- Syntax: [configmap|secret]:name[/key][@path], where name represents the resource name, key optionally represents the resource key to be filtered and path represents the destination path
+ description: 'A list of resources (text or binary content)
+ pointing to configmap/secret. The resources are expected
+ to be any resource type (text or binary content). The
+ destination path can be either a default location or
+ any path specified by the user. Syntax: [configmap|secret]:name[/key][@path],
+ where name represents the resource name, key optionally
+ represents the resource key to be filtered and path
+ represents the destination path'
items:
type: string
type: array
@@ -27288,9 +27678,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -27301,9 +27690,8 @@ spec:
description: The configuration of Owner trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -27325,9 +27713,8 @@ spec:
description: The configuration of PDB trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -27335,53 +27722,56 @@ spec:
All traits share this common property.
type: boolean
maxUnavailable:
- description: |-
- The number of pods for the Integration that can be unavailable after an eviction.
- It can be either an absolute number or a percentage (default `1` if `min-available` is also not set).
- Only one of `max-unavailable` and `min-available` can be specified.
+ description: The number of pods for the Integration that
+ can be unavailable after an eviction. It can be either
+ an absolute number or a percentage (default `1` if `min-available`
+ is also not set). Only one of `max-unavailable` and
+ `min-available` can be specified.
type: string
minAvailable:
- description: |-
- The number of pods for the Integration that must still be available after an eviction.
- It can be either an absolute number or a percentage.
- Only one of `min-available` and `max-unavailable` can be specified.
+ description: The number of pods for the Integration that
+ must still be available after an eviction. It can be
+ either an absolute number or a percentage. Only one
+ of `min-available` and `max-unavailable` can be specified.
type: string
type: object
platform:
description: The configuration of Platform trait
properties:
auto:
- description: |-
- To automatically detect from the environment if a default platform can be created (it will be created on OpenShift or when a registry address is set).
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'To automatically detect from the environment
+ if a default platform can be created (it will be created
+ on OpenShift or when a registry address is set). Deprecated:
+ Platform is auto generated by the operator install procedure
+ - maintained for backward compatibility'
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
createDefault:
- description: |-
- To create a default (empty) platform when the platform is missing.
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'To create a default (empty) platform when
+ the platform is missing. Deprecated: Platform is auto
+ generated by the operator install procedure - maintained
+ for backward compatibility'
type: boolean
enabled:
description: 'Deprecated: no longer in use.'
type: boolean
global:
- description: |-
- Indicates if the platform should be created globally in the case of global operator (default true).
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'Indicates if the platform should be created
+ globally in the case of global operator (default true).
+ Deprecated: Platform is auto generated by the operator
+ install procedure - maintained for backward compatibility'
type: boolean
type: object
pod:
description: The configuration of Pod trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -27393,9 +27783,8 @@ spec:
description: The configuration of Prometheus trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -27421,9 +27810,8 @@ spec:
secret on the pod if it is of type `kubernetes.io/dockerconfigjson`.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -27446,10 +27834,11 @@ spec:
description: The configuration of Quarkus trait
properties:
buildMode:
- description: |-
- The Quarkus mode to run: either `jvm` or `native` (default `jvm`).
- In case both `jvm` and `native` are specified, two `IntegrationKit` resources are created,
- with the `native` kit having precedence over the `jvm` one once ready.
+ description: 'The Quarkus mode to run: either `jvm` or
+ `native` (default `jvm`). In case both `jvm` and `native`
+ are specified, two `IntegrationKit` resources are created,
+ with the `native` kit having precedence over the `jvm`
+ one once ready.'
items:
description: QuarkusMode is the type of Quarkus build
packaging.
@@ -27459,9 +27848,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -27477,18 +27865,19 @@ spec:
in the runtime catalog)
type: string
packageTypes:
- description: |-
- The Quarkus package types, `fast-jar` or `native` (default `fast-jar`).
- In case both `fast-jar` and `native` are specified, two `IntegrationKit` resources are created,
- with the native kit having precedence over the `fast-jar` one once ready.
- The order influences the resolution of the current kit for the integration.
- The kit corresponding to the first package type will be assigned to the
- integration in case no existing kit that matches the integration exists.
- Deprecated: use `build-mode` instead.
+ description: 'The Quarkus package types, `fast-jar` or
+ `native` (default `fast-jar`). In case both `fast-jar`
+ and `native` are specified, two `IntegrationKit` resources
+ are created, with the native kit having precedence over
+ the `fast-jar` one once ready. The order influences
+ the resolution of the current kit for the integration.
+ The kit corresponding to the first package type will
+ be assigned to the integration in case no existing kit
+ that matches the integration exists. Deprecated: use
+ `build-mode` instead.'
items:
- description: |-
- QuarkusPackageType is the type of Quarkus build packaging.
- Deprecated: use `QuarkusMode` instead.
+ description: 'QuarkusPackageType is the type of Quarkus
+ build packaging. Deprecated: use `QuarkusMode` instead.'
enum:
- fast-jar
- native
@@ -27496,14 +27885,13 @@ spec:
type: array
type: object
registry:
- description: |-
- The configuration of Registry trait (support removed since version 2.5.0).
- Deprecated: use jvm trait or read documentation.
+ description: 'The configuration of Registry trait (support
+ removed since version 2.5.0). Deprecated: use jvm trait
+ or read documentation.'
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -27517,16 +27905,14 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to route.
- This can be used to set route specific annotations
- For annotations options see https://docs.openshift.com/container-platform/3.11/architecture/networking/routes.html#route-specific-annotations
- CLI usage example: -t "route.annotations.'haproxy.router.openshift.io/balance'=true"
+ description: 'The annotations added to route. This can
+ be used to set route specific annotations For annotations
+ options see https://docs.openshift.com/container-platform/3.11/architecture/networking/routes.html#route-specific-annotations
+ CLI usage example: -t "route.annotations.''haproxy.router.openshift.io/balance''=true"'
type: object
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -27537,82 +27923,82 @@ spec:
description: To configure the host exposed by the route.
type: string
tlsCACertificate:
- description: |-
- The TLS CA certificate contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS CA certificate contents. \n Refer
+ to the OpenShift route documentation for additional
+ information."
type: string
tlsCACertificateSecret:
- description: |-
- The secret name and key reference to the TLS CA certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the
+ TLS CA certificate. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only
+ one key in the secret it will be read, otherwise you
+ can set a key name separated with a \"/\". \n Refer
+ to the OpenShift route documentation for additional
+ information."
type: string
tlsCertificate:
- description: |-
- The TLS certificate contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS certificate contents. \n Refer to
+ the OpenShift route documentation for additional information."
type: string
tlsCertificateSecret:
- description: |-
- The secret name and key reference to the TLS certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the
+ TLS certificate. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only
+ one key in the secret it will be read, otherwise you
+ can set a key name separated with a \"/\". \n Refer
+ to the OpenShift route documentation for additional
+ information."
type: string
tlsDestinationCACertificate:
- description: |-
- The destination CA certificate provides the contents of the ca certificate of the final destination. When using reencrypt
- termination this file should be provided in order to have routers use it for health checks on the secure connection.
- If this field is not specified, the router may provide its own destination CA and perform hostname validation using
- the short service name (service.namespace.svc), which allows infrastructure generated certificates to automatically
- verify.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The destination CA certificate provides
+ the contents of the ca certificate of the final destination.
+ \ When using reencrypt termination this file should
+ be provided in order to have routers use it for health
+ checks on the secure connection. If this field is not
+ specified, the router may provide its own destination
+ CA and perform hostname validation using the short service
+ name (service.namespace.svc), which allows infrastructure
+ generated certificates to automatically verify. \n Refer
+ to the OpenShift route documentation for additional
+ information."
type: string
tlsDestinationCACertificateSecret:
- description: |-
- The secret name and key reference to the destination CA certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the
+ destination CA certificate. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only
+ one key in the secret it will be read, otherwise you
+ can set a key name separated with a \"/\". \n Refer
+ to the OpenShift route documentation for additional
+ information."
type: string
tlsInsecureEdgeTerminationPolicy:
- description: |-
- To configure how to deal with insecure traffic, e.g. `Allow`, `Disable` or `Redirect` traffic.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "To configure how to deal with insecure traffic,
+ e.g. `Allow`, `Disable` or `Redirect` traffic. \n Refer
+ to the OpenShift route documentation for additional
+ information."
enum:
- None
- Allow
- Redirect
type: string
tlsKey:
- description: |-
- The TLS certificate key contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS certificate key contents. \n Refer
+ to the OpenShift route documentation for additional
+ information."
type: string
tlsKeySecret:
- description: |-
- The secret name and key reference to the TLS certificate key. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the
+ TLS certificate key. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only
+ one key in the secret it will be read, otherwise you
+ can set a key name separated with a \"/\". \n Refer
+ to the OpenShift route documentation for additional
+ information."
type: string
tlsTermination:
- description: |-
- The TLS termination type, like `edge`, `passthrough` or `reencrypt`.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS termination type, like `edge`, `passthrough`
+ or `reencrypt`. \n Refer to the OpenShift route documentation
+ for additional information."
enum:
- edge
- reencrypt
@@ -27623,9 +28009,8 @@ spec:
description: The configuration of Security Context trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -27657,9 +28042,8 @@ spec:
a Service needs to be created.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -27667,9 +28051,8 @@ spec:
All traits share this common property.
type: boolean
nodePort:
- description: |-
- Enable Service to be exposed as NodePort (default `false`).
- Deprecated: Use service type instead.
+ description: 'Enable Service to be exposed as NodePort
+ (default `false`). Deprecated: Use service type instead.'
type: boolean
type:
description: The type of service to be used, either 'ClusterIP',
@@ -27684,9 +28067,8 @@ spec:
description: The configuration of Service Binding trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -27713,9 +28095,8 @@ spec:
description: The configuration of Toleration trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -27780,48 +28161,39 @@ spec:
description: API version of the referent.
type: string
fieldPath:
- description: |-
- If referring to a piece of an object instead of an entire object, this string
- should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
- For example, if the object reference is to a container within a pod, this would take on a value like:
- "spec.containers{name}" (where "name" refers to the name of the container that triggered
- the event) or if no container name is specified "spec.containers[2]" (container with
- index 2 in this pod). This syntax is chosen only to have some well-defined way of
- referencing a part of an object.
- TODO: this design is not final and this field is subject to change in the future.
+ description: 'If referring to a piece of an object instead
+ of an entire object, this string should contain a valid
+ JSON/Go field access statement, such as desiredState.manifest.containers[2].
+ For example, if the object reference is to a container within
+ a pod, this would take on a value like: "spec.containers{name}"
+ (where "name" refers to the name of the container that triggered
+ the event) or if no container name is specified "spec.containers[2]"
+ (container with index 2 in this pod). This syntax is chosen
+ only to have some well-defined way of referencing a part
+ of an object. TODO: this design is not final and this field
+ is subject to change in the future.'
type: string
kind:
- description: |-
- Kind of the referent.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ 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: 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'
type: string
namespace:
- description: |-
- Namespace of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
+ description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type: string
resourceVersion:
- description: |-
- Specific resourceVersion to which this reference is made, if any.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
+ description: 'Specific resourceVersion to which this reference
+ is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
type: string
uid:
- description: |-
- UID of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
+ description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
type: string
type: object
- x-kubernetes-map-type: atomic
types:
additionalProperties:
- description: |-
- EventTypeSpec represents a specification for an event type.
- Deprecated: In favor of using DataTypeSpec.
+ description: 'EventTypeSpec represents a specification for an
+ event type. Deprecated: In favor of using DataTypeSpec.'
properties:
mediaType:
description: media type as expected for HTTP media types
@@ -27836,9 +28208,9 @@ spec:
description:
type: string
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value.
+ These types are supported: bool, int64, float64, string,
+ []interface{}, map[string]interface{} and nil.'
x-kubernetes-preserve-unknown-fields: true
externalDocs:
description: ExternalDocumentation allows referencing
@@ -27864,49 +28236,64 @@ spec:
type: string
enum:
items:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON
+ value. These types are supported: bool, int64,
+ float64, string, []interface{}, map[string]interface{}
+ and nil.'
x-kubernetes-preserve-unknown-fields: true
type: array
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value.
+ These types are supported: bool, int64, float64,
+ string, []interface{}, map[string]interface{}
+ and nil.'
x-kubernetes-preserve-unknown-fields: true
exclusiveMaximum:
type: boolean
exclusiveMinimum:
type: boolean
format:
- description: |-
- format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:
-
-
- - bsonobjectid: a bson object ID, i.e. a 24 characters hex string
- - uri: an URI as parsed by Golang net/url.ParseRequestURI
- - email: an email address as parsed by Golang net/mail.ParseAddress
- - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034].
- - ipv4: an IPv4 IP as parsed by Golang net.ParseIP
- - ipv6: an IPv6 IP as parsed by Golang net.ParseIP
- - cidr: a CIDR as parsed by Golang net.ParseCIDR
- - mac: a MAC address as parsed by Golang net.ParseMAC
- - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041"
- - isbn10: an ISBN10 number string like "0321751043"
- - isbn13: an ISBN13 number string like "978-0321751041"
- - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\d{3})\\d{11})$ with any non digit characters mixed in
- - ssn: a U.S. social security number following the regex ^\\d{3}[- ]?\\d{2}[- ]?\\d{4}$
- - hexcolor: an hexadecimal color code like "#FFFFFF" following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
- - rgbcolor: an RGB color code like rgb like "rgb(255,255,255)"
- - byte: base64 encoded binary data
- - password: any kind of string
- - date: a date string like "2006-01-02" as defined by full-date in RFC3339
- - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format
- - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339.
+ description: "format is an OpenAPI v3 format string.
+ Unknown formats are ignored. The following formats
+ are validated: \n - bsonobjectid: a bson object
+ ID, i.e. a 24 characters hex string - uri: an
+ URI as parsed by Golang net/url.ParseRequestURI
+ - email: an email address as parsed by Golang
+ net/mail.ParseAddress - hostname: a valid representation
+ for an Internet host name, as defined by RFC
+ 1034, section 3.1 [RFC1034]. - ipv4: an IPv4
+ IP as parsed by Golang net.ParseIP - ipv6: an
+ IPv6 IP as parsed by Golang net.ParseIP - cidr:
+ a CIDR as parsed by Golang net.ParseCIDR - mac:
+ a MAC address as parsed by Golang net.ParseMAC
+ - uuid: an UUID that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid3: an UUID3 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid4: an UUID4 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - uuid5: an UUID5 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - isbn: an ISBN10 or ISBN13 number string like
+ \"0321751043\" or \"978-0321751041\" - isbn10:
+ an ISBN10 number string like \"0321751043\"
+ - isbn13: an ISBN13 number string like \"978-0321751041\"
+ - creditcard: a credit card number defined by
+ the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\\\d{3})\\\\d{11})$
+ with any non digit characters mixed in - ssn:
+ a U.S. social security number following the
+ regex ^\\\\d{3}[- ]?\\\\d{2}[- ]?\\\\d{4}$ -
+ hexcolor: an hexadecimal color code like \"#FFFFFF\"
+ following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
+ - rgbcolor: an RGB color code like rgb like
+ \"rgb(255,255,255)\" - byte: base64 encoded
+ binary data - password: any kind of string -
+ date: a date string like \"2006-01-02\" as defined
+ by full-date in RFC3339 - duration: a duration
+ string like \"22 ns\" as parsed by Golang time.ParseDuration
+ or compatible with Scala duration format - datetime:
+ a date time string like \"2014-12-15T19:30:20.000Z\"
+ as defined by date-time in RFC3339."
type: string
id:
type: string
@@ -27969,9 +28356,9 @@ spec:
type: string
type: object
type: object
- description: |-
- Types defines the data type of the data produced/consumed by the endpoint and references a given data type specification.
- Deprecated: In favor of using DataTypes
+ description: 'Types defines the data type of the data produced/consumed
+ by the endpoint and references a given data type specification.
+ Deprecated: In favor of using DataTypes'
type: object
uri:
description: URI can be used to specify the (Camel) endpoint explicitly
@@ -28009,48 +28396,39 @@ spec:
description: API version of the referent.
type: string
fieldPath:
- description: |-
- If referring to a piece of an object instead of an entire object, this string
- should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
- For example, if the object reference is to a container within a pod, this would take on a value like:
- "spec.containers{name}" (where "name" refers to the name of the container that triggered
- the event) or if no container name is specified "spec.containers[2]" (container with
- index 2 in this pod). This syntax is chosen only to have some well-defined way of
- referencing a part of an object.
- TODO: this design is not final and this field is subject to change in the future.
+ description: 'If referring to a piece of an object instead
+ of an entire object, this string should contain a valid
+ JSON/Go field access statement, such as desiredState.manifest.containers[2].
+ For example, if the object reference is to a container within
+ a pod, this would take on a value like: "spec.containers{name}"
+ (where "name" refers to the name of the container that triggered
+ the event) or if no container name is specified "spec.containers[2]"
+ (container with index 2 in this pod). This syntax is chosen
+ only to have some well-defined way of referencing a part
+ of an object. TODO: this design is not final and this field
+ is subject to change in the future.'
type: string
kind:
- description: |-
- Kind of the referent.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ 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: 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'
type: string
namespace:
- description: |-
- Namespace of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
+ description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type: string
resourceVersion:
- description: |-
- Specific resourceVersion to which this reference is made, if any.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
+ description: 'Specific resourceVersion to which this reference
+ is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
type: string
uid:
- description: |-
- UID of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
+ description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
type: string
type: object
- x-kubernetes-map-type: atomic
types:
additionalProperties:
- description: |-
- EventTypeSpec represents a specification for an event type.
- Deprecated: In favor of using DataTypeSpec.
+ description: 'EventTypeSpec represents a specification for an
+ event type. Deprecated: In favor of using DataTypeSpec.'
properties:
mediaType:
description: media type as expected for HTTP media types
@@ -28065,9 +28443,9 @@ spec:
description:
type: string
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value.
+ These types are supported: bool, int64, float64, string,
+ []interface{}, map[string]interface{} and nil.'
x-kubernetes-preserve-unknown-fields: true
externalDocs:
description: ExternalDocumentation allows referencing
@@ -28093,49 +28471,64 @@ spec:
type: string
enum:
items:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON
+ value. These types are supported: bool, int64,
+ float64, string, []interface{}, map[string]interface{}
+ and nil.'
x-kubernetes-preserve-unknown-fields: true
type: array
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value.
+ These types are supported: bool, int64, float64,
+ string, []interface{}, map[string]interface{}
+ and nil.'
x-kubernetes-preserve-unknown-fields: true
exclusiveMaximum:
type: boolean
exclusiveMinimum:
type: boolean
format:
- description: |-
- format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:
-
-
- - bsonobjectid: a bson object ID, i.e. a 24 characters hex string
- - uri: an URI as parsed by Golang net/url.ParseRequestURI
- - email: an email address as parsed by Golang net/mail.ParseAddress
- - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034].
- - ipv4: an IPv4 IP as parsed by Golang net.ParseIP
- - ipv6: an IPv6 IP as parsed by Golang net.ParseIP
- - cidr: a CIDR as parsed by Golang net.ParseCIDR
- - mac: a MAC address as parsed by Golang net.ParseMAC
- - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041"
- - isbn10: an ISBN10 number string like "0321751043"
- - isbn13: an ISBN13 number string like "978-0321751041"
- - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\d{3})\\d{11})$ with any non digit characters mixed in
- - ssn: a U.S. social security number following the regex ^\\d{3}[- ]?\\d{2}[- ]?\\d{4}$
- - hexcolor: an hexadecimal color code like "#FFFFFF" following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
- - rgbcolor: an RGB color code like rgb like "rgb(255,255,255)"
- - byte: base64 encoded binary data
- - password: any kind of string
- - date: a date string like "2006-01-02" as defined by full-date in RFC3339
- - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format
- - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339.
+ description: "format is an OpenAPI v3 format string.
+ Unknown formats are ignored. The following formats
+ are validated: \n - bsonobjectid: a bson object
+ ID, i.e. a 24 characters hex string - uri: an
+ URI as parsed by Golang net/url.ParseRequestURI
+ - email: an email address as parsed by Golang
+ net/mail.ParseAddress - hostname: a valid representation
+ for an Internet host name, as defined by RFC
+ 1034, section 3.1 [RFC1034]. - ipv4: an IPv4
+ IP as parsed by Golang net.ParseIP - ipv6: an
+ IPv6 IP as parsed by Golang net.ParseIP - cidr:
+ a CIDR as parsed by Golang net.ParseCIDR - mac:
+ a MAC address as parsed by Golang net.ParseMAC
+ - uuid: an UUID that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid3: an UUID3 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid4: an UUID4 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - uuid5: an UUID5 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - isbn: an ISBN10 or ISBN13 number string like
+ \"0321751043\" or \"978-0321751041\" - isbn10:
+ an ISBN10 number string like \"0321751043\"
+ - isbn13: an ISBN13 number string like \"978-0321751041\"
+ - creditcard: a credit card number defined by
+ the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\\\d{3})\\\\d{11})$
+ with any non digit characters mixed in - ssn:
+ a U.S. social security number following the
+ regex ^\\\\d{3}[- ]?\\\\d{2}[- ]?\\\\d{4}$ -
+ hexcolor: an hexadecimal color code like \"#FFFFFF\"
+ following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
+ - rgbcolor: an RGB color code like rgb like
+ \"rgb(255,255,255)\" - byte: base64 encoded
+ binary data - password: any kind of string -
+ date: a date string like \"2006-01-02\" as defined
+ by full-date in RFC3339 - duration: a duration
+ string like \"22 ns\" as parsed by Golang time.ParseDuration
+ or compatible with Scala duration format - datetime:
+ a date time string like \"2014-12-15T19:30:20.000Z\"
+ as defined by date-time in RFC3339."
type: string
id:
type: string
@@ -28198,9 +28591,9 @@ spec:
type: string
type: object
type: object
- description: |-
- Types defines the data type of the data produced/consumed by the endpoint and references a given data type specification.
- Deprecated: In favor of using DataTypes
+ description: 'Types defines the data type of the data produced/consumed
+ by the endpoint and references a given data type specification.
+ Deprecated: In favor of using DataTypes'
type: object
uri:
description: URI can be used to specify the (Camel) endpoint explicitly
@@ -28241,48 +28634,40 @@ spec:
description: API version of the referent.
type: string
fieldPath:
- description: |-
- If referring to a piece of an object instead of an entire object, this string
- should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
- For example, if the object reference is to a container within a pod, this would take on a value like:
- "spec.containers{name}" (where "name" refers to the name of the container that triggered
- the event) or if no container name is specified "spec.containers[2]" (container with
- index 2 in this pod). This syntax is chosen only to have some well-defined way of
- referencing a part of an object.
- TODO: this design is not final and this field is subject to change in the future.
+ description: 'If referring to a piece of an object instead
+ of an entire object, this string should contain a valid
+ JSON/Go field access statement, such as desiredState.manifest.containers[2].
+ For example, if the object reference is to a container
+ within a pod, this would take on a value like: "spec.containers{name}"
+ (where "name" refers to the name of the container that
+ triggered the event) or if no container name is specified
+ "spec.containers[2]" (container with index 2 in this pod).
+ This syntax is chosen only to have some well-defined way
+ of referencing a part of an object. TODO: this design
+ is not final and this field is subject to change in the
+ future.'
type: string
kind:
- description: |-
- Kind of the referent.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ 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: 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'
type: string
namespace:
- description: |-
- Namespace of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
+ description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type: string
resourceVersion:
- description: |-
- Specific resourceVersion to which this reference is made, if any.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
+ description: 'Specific resourceVersion to which this reference
+ is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
type: string
uid:
- description: |-
- UID of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
+ description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
type: string
type: object
- x-kubernetes-map-type: atomic
types:
additionalProperties:
- description: |-
- EventTypeSpec represents a specification for an event type.
- Deprecated: In favor of using DataTypeSpec.
+ description: 'EventTypeSpec represents a specification for
+ an event type. Deprecated: In favor of using DataTypeSpec.'
properties:
mediaType:
description: media type as expected for HTTP media types
@@ -28297,9 +28682,10 @@ spec:
description:
type: string
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value.
+ These types are supported: bool, int64, float64,
+ string, []interface{}, map[string]interface{} and
+ nil.'
x-kubernetes-preserve-unknown-fields: true
externalDocs:
description: ExternalDocumentation allows referencing
@@ -28325,49 +28711,65 @@ spec:
type: string
enum:
items:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON
+ value. These types are supported: bool,
+ int64, float64, string, []interface{}, map[string]interface{}
+ and nil.'
x-kubernetes-preserve-unknown-fields: true
type: array
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON
+ value. These types are supported: bool, int64,
+ float64, string, []interface{}, map[string]interface{}
+ and nil.'
x-kubernetes-preserve-unknown-fields: true
exclusiveMaximum:
type: boolean
exclusiveMinimum:
type: boolean
format:
- description: |-
- format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:
-
-
- - bsonobjectid: a bson object ID, i.e. a 24 characters hex string
- - uri: an URI as parsed by Golang net/url.ParseRequestURI
- - email: an email address as parsed by Golang net/mail.ParseAddress
- - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034].
+ description: "format is an OpenAPI v3 format
+ string. Unknown formats are ignored. The following
+ formats are validated: \n - bsonobjectid:
+ a bson object ID, i.e. a 24 characters hex
+ string - uri: an URI as parsed by Golang net/url.ParseRequestURI
+ - email: an email address as parsed by Golang
+ net/mail.ParseAddress - hostname: a valid
+ representation for an Internet host name,
+ as defined by RFC 1034, section 3.1 [RFC1034].
- ipv4: an IPv4 IP as parsed by Golang net.ParseIP
- ipv6: an IPv6 IP as parsed by Golang net.ParseIP
- cidr: a CIDR as parsed by Golang net.ParseCIDR
- mac: a MAC address as parsed by Golang net.ParseMAC
- - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041"
- - isbn10: an ISBN10 number string like "0321751043"
- - isbn13: an ISBN13 number string like "978-0321751041"
- - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\d{3})\\d{11})$ with any non digit characters mixed in
- - ssn: a U.S. social security number following the regex ^\\d{3}[- ]?\\d{2}[- ]?\\d{4}$
- - hexcolor: an hexadecimal color code like "#FFFFFF" following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
- - rgbcolor: an RGB color code like rgb like "rgb(255,255,255)"
- - byte: base64 encoded binary data
- - password: any kind of string
- - date: a date string like "2006-01-02" as defined by full-date in RFC3339
- - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format
- - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339.
+ - uuid: an UUID that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid3: an UUID3 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid4: an UUID4 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - uuid5: an UUID5 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - isbn: an ISBN10 or ISBN13 number string
+ like \"0321751043\" or \"978-0321751041\"
+ - isbn10: an ISBN10 number string like \"0321751043\"
+ - isbn13: an ISBN13 number string like \"978-0321751041\"
+ - creditcard: a credit card number defined
+ by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\\\d{3})\\\\d{11})$
+ with any non digit characters mixed in - ssn:
+ a U.S. social security number following the
+ regex ^\\\\d{3}[- ]?\\\\d{2}[- ]?\\\\d{4}$
+ - hexcolor: an hexadecimal color code like
+ \"#FFFFFF\" following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
+ - rgbcolor: an RGB color code like rgb like
+ \"rgb(255,255,255)\" - byte: base64 encoded
+ binary data - password: any kind of string
+ - date: a date string like \"2006-01-02\"
+ as defined by full-date in RFC3339 - duration:
+ a duration string like \"22 ns\" as parsed
+ by Golang time.ParseDuration or compatible
+ with Scala duration format - datetime: a date
+ time string like \"2014-12-15T19:30:20.000Z\"
+ as defined by date-time in RFC3339."
type: string
id:
type: string
@@ -28430,9 +28832,9 @@ spec:
type: string
type: object
type: object
- description: |-
- Types defines the data type of the data produced/consumed by the endpoint and references a given data type specification.
- Deprecated: In favor of using DataTypes
+ description: 'Types defines the data type of the data produced/consumed
+ by the endpoint and references a given data type specification.
+ Deprecated: In favor of using DataTypes'
type: object
uri:
description: URI can be used to specify the (Camel) endpoint
@@ -28490,15 +28892,12 @@ spec:
the condition's last transition.
type: string
status:
- description: |-
- Status is the status of the condition.
- Can be True, False, Unknown.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
+ description: 'Status is the status of the condition.
+ Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions'
type: string
type:
- description: |-
- Type is the type of the condition.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
+ description: 'Type is the type of the condition. More
+ info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions'
type: string
required:
- status
@@ -28508,10 +28907,10 @@ spec:
items:
properties:
data:
- description: |-
- RawMessage is a raw encoded JSON value.
+ description: RawMessage is a raw encoded JSON value.
It implements Marshaler and Unmarshaler and can
- be used to delay JSON decoding or precompute a JSON encoding.
+ be used to delay JSON decoding or precompute a
+ JSON encoding.
x-kubernetes-preserve-unknown-fields: true
name:
type: string
@@ -28564,12 +28963,19 @@ spec:
specReplicasPath: .spec.replicas
statusReplicasPath: .status.replicas
status: {}
+status:
+ acceptedNames:
+ kind: ""
+ plural: ""
+ conditions: []
+ storedVersions: []
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
- controller-gen.kubebuilder.io/version: v0.15.0
+ controller-gen.kubebuilder.io/version: v0.6.1
+ creationTimestamp: null
labels:
app: camel-k
name: kamelets.camel.apache.org
@@ -28598,19 +29004,14 @@ spec:
description: Kamelet is the Schema for the kamelets API.
properties:
apiVersion:
- description: |-
- APIVersion defines the versioned schema of this representation of an object.
- Servers should convert recognized schemas to the latest internal value, and
- may reject unrecognized values.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+ description: 'APIVersion defines the versioned schema of this representation
+ of an object. Servers should convert recognized schemas to the latest
+ internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: |-
- Kind is a string value representing the REST resource this object represents.
- Servers may infer this from the endpoint the client submits requests to.
- Cannot be updated.
- In CamelCase.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ description: 'Kind is a string value representing the REST resource this
+ object represents. Servers may infer this from the endpoint the client
+ submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
@@ -28691,9 +29092,10 @@ spec:
description:
type: string
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value.
+ These types are supported: bool, int64, float64,
+ string, []interface{}, map[string]interface{} and
+ nil.'
x-kubernetes-preserve-unknown-fields: true
externalDocs:
description: ExternalDocumentation allows referencing
@@ -28719,49 +29121,65 @@ spec:
type: string
enum:
items:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON
+ value. These types are supported: bool,
+ int64, float64, string, []interface{}, map[string]interface{}
+ and nil.'
x-kubernetes-preserve-unknown-fields: true
type: array
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON
+ value. These types are supported: bool, int64,
+ float64, string, []interface{}, map[string]interface{}
+ and nil.'
x-kubernetes-preserve-unknown-fields: true
exclusiveMaximum:
type: boolean
exclusiveMinimum:
type: boolean
format:
- description: |-
- format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:
-
-
- - bsonobjectid: a bson object ID, i.e. a 24 characters hex string
- - uri: an URI as parsed by Golang net/url.ParseRequestURI
- - email: an email address as parsed by Golang net/mail.ParseAddress
- - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034].
+ description: "format is an OpenAPI v3 format
+ string. Unknown formats are ignored. The following
+ formats are validated: \n - bsonobjectid:
+ a bson object ID, i.e. a 24 characters hex
+ string - uri: an URI as parsed by Golang net/url.ParseRequestURI
+ - email: an email address as parsed by Golang
+ net/mail.ParseAddress - hostname: a valid
+ representation for an Internet host name,
+ as defined by RFC 1034, section 3.1 [RFC1034].
- ipv4: an IPv4 IP as parsed by Golang net.ParseIP
- ipv6: an IPv6 IP as parsed by Golang net.ParseIP
- cidr: a CIDR as parsed by Golang net.ParseCIDR
- mac: a MAC address as parsed by Golang net.ParseMAC
- - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041"
- - isbn10: an ISBN10 number string like "0321751043"
- - isbn13: an ISBN13 number string like "978-0321751041"
- - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\d{3})\\d{11})$ with any non digit characters mixed in
- - ssn: a U.S. social security number following the regex ^\\d{3}[- ]?\\d{2}[- ]?\\d{4}$
- - hexcolor: an hexadecimal color code like "#FFFFFF" following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
- - rgbcolor: an RGB color code like rgb like "rgb(255,255,255)"
- - byte: base64 encoded binary data
- - password: any kind of string
- - date: a date string like "2006-01-02" as defined by full-date in RFC3339
- - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format
- - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339.
+ - uuid: an UUID that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid3: an UUID3 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid4: an UUID4 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - uuid5: an UUID5 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - isbn: an ISBN10 or ISBN13 number string
+ like \"0321751043\" or \"978-0321751041\"
+ - isbn10: an ISBN10 number string like \"0321751043\"
+ - isbn13: an ISBN13 number string like \"978-0321751041\"
+ - creditcard: a credit card number defined
+ by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\\\d{3})\\\\d{11})$
+ with any non digit characters mixed in - ssn:
+ a U.S. social security number following the
+ regex ^\\\\d{3}[- ]?\\\\d{2}[- ]?\\\\d{4}$
+ - hexcolor: an hexadecimal color code like
+ \"#FFFFFF\" following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
+ - rgbcolor: an RGB color code like rgb like
+ \"rgb(255,255,255)\" - byte: base64 encoded
+ binary data - password: any kind of string
+ - date: a date string like \"2006-01-02\"
+ as defined by full-date in RFC3339 - duration:
+ a duration string like \"22 ns\" as parsed
+ by Golang time.ParseDuration or compatible
+ with Scala duration format - datetime: a date
+ time string like \"2014-12-15T19:30:20.000Z\"
+ as defined by date-time in RFC3339."
type: string
id:
type: string
@@ -28842,9 +29260,9 @@ spec:
description:
type: string
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value. These types
+ are supported: bool, int64, float64, string, []interface{},
+ map[string]interface{} and nil.'
x-kubernetes-preserve-unknown-fields: true
externalDocs:
description: ExternalDocumentation allows referencing an external
@@ -28870,49 +29288,56 @@ spec:
type: string
enum:
items:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value. These
+ types are supported: bool, int64, float64, string, []interface{},
+ map[string]interface{} and nil.'
x-kubernetes-preserve-unknown-fields: true
type: array
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value. These
+ types are supported: bool, int64, float64, string, []interface{},
+ map[string]interface{} and nil.'
x-kubernetes-preserve-unknown-fields: true
exclusiveMaximum:
type: boolean
exclusiveMinimum:
type: boolean
format:
- description: |-
- format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:
-
-
- - bsonobjectid: a bson object ID, i.e. a 24 characters hex string
- - uri: an URI as parsed by Golang net/url.ParseRequestURI
+ description: "format is an OpenAPI v3 format string. Unknown
+ formats are ignored. The following formats are validated:
+ \n - bsonobjectid: a bson object ID, i.e. a 24 characters
+ hex string - uri: an URI as parsed by Golang net/url.ParseRequestURI
- email: an email address as parsed by Golang net/mail.ParseAddress
- - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034].
- - ipv4: an IPv4 IP as parsed by Golang net.ParseIP
- - ipv6: an IPv6 IP as parsed by Golang net.ParseIP
- - cidr: a CIDR as parsed by Golang net.ParseCIDR
- - mac: a MAC address as parsed by Golang net.ParseMAC
- - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041"
- - isbn10: an ISBN10 number string like "0321751043"
- - isbn13: an ISBN13 number string like "978-0321751041"
- - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\d{3})\\d{11})$ with any non digit characters mixed in
- - ssn: a U.S. social security number following the regex ^\\d{3}[- ]?\\d{2}[- ]?\\d{4}$
- - hexcolor: an hexadecimal color code like "#FFFFFF" following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
- - rgbcolor: an RGB color code like rgb like "rgb(255,255,255)"
- - byte: base64 encoded binary data
- - password: any kind of string
- - date: a date string like "2006-01-02" as defined by full-date in RFC3339
- - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format
- - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339.
+ - hostname: a valid representation for an Internet host
+ name, as defined by RFC 1034, section 3.1 [RFC1034]. -
+ ipv4: an IPv4 IP as parsed by Golang net.ParseIP - ipv6:
+ an IPv6 IP as parsed by Golang net.ParseIP - cidr: a CIDR
+ as parsed by Golang net.ParseCIDR - mac: a MAC address
+ as parsed by Golang net.ParseMAC - uuid: an UUID that
+ allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid3: an UUID3 that allows uppercase defined by the
+ regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid4: an UUID4 that allows uppercase defined by the
+ regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - uuid5: an UUID5 that allows uppercase defined by the
+ regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - isbn: an ISBN10 or ISBN13 number string like \"0321751043\"
+ or \"978-0321751041\" - isbn10: an ISBN10 number string
+ like \"0321751043\" - isbn13: an ISBN13 number string
+ like \"978-0321751041\" - creditcard: a credit card number
+ defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\\\d{3})\\\\d{11})$
+ with any non digit characters mixed in - ssn: a U.S. social
+ security number following the regex ^\\\\d{3}[- ]?\\\\d{2}[-
+ ]?\\\\d{4}$ - hexcolor: an hexadecimal color code like
+ \"#FFFFFF\" following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
+ - rgbcolor: an RGB color code like rgb like \"rgb(255,255,255)\"
+ - byte: base64 encoded binary data - password: any kind
+ of string - date: a date string like \"2006-01-02\" as
+ defined by full-date in RFC3339 - duration: a duration
+ string like \"22 ns\" as parsed by Golang time.ParseDuration
+ or compatible with Scala duration format - datetime: a
+ date time string like \"2014-12-15T19:30:20.000Z\" as
+ defined by date-time in RFC3339."
type: string
id:
type: string
@@ -29000,8 +29425,7 @@ spec:
description: True if the spec is generated from a Kamelet
type: boolean
interceptors:
- description: |-
- Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
+ description: Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
uses to pre/post process sources
items:
type: string
@@ -29011,9 +29435,8 @@ spec:
to interpret this source code
type: string
loader:
- description: |-
- Loader is an optional id of the org.apache.camel.k.RoutesLoader that will
- interpret this source at runtime
+ description: Loader is an optional id of the org.apache.camel.k.RoutesLoader
+ that will interpret this source at runtime
type: string
name:
description: the name of the specification
@@ -29043,9 +29466,8 @@ spec:
x-kubernetes-preserve-unknown-fields: true
types:
additionalProperties:
- description: |-
- EventTypeSpec represents a specification for an event type.
- Deprecated: In favor of using DataTypeSpec.
+ description: 'EventTypeSpec represents a specification for an event
+ type. Deprecated: In favor of using DataTypeSpec.'
properties:
mediaType:
description: media type as expected for HTTP media types (ie,
@@ -29060,9 +29482,9 @@ spec:
description:
type: string
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value. These
+ types are supported: bool, int64, float64, string, []interface{},
+ map[string]interface{} and nil.'
x-kubernetes-preserve-unknown-fields: true
externalDocs:
description: ExternalDocumentation allows referencing an
@@ -29088,49 +29510,61 @@ spec:
type: string
enum:
items:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value.
+ These types are supported: bool, int64, float64,
+ string, []interface{}, map[string]interface{}
+ and nil.'
x-kubernetes-preserve-unknown-fields: true
type: array
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value.
+ These types are supported: bool, int64, float64,
+ string, []interface{}, map[string]interface{} and
+ nil.'
x-kubernetes-preserve-unknown-fields: true
exclusiveMaximum:
type: boolean
exclusiveMinimum:
type: boolean
format:
- description: |-
- format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:
-
-
- - bsonobjectid: a bson object ID, i.e. a 24 characters hex string
- - uri: an URI as parsed by Golang net/url.ParseRequestURI
- - email: an email address as parsed by Golang net/mail.ParseAddress
- - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034].
+ description: "format is an OpenAPI v3 format string.
+ Unknown formats are ignored. The following formats
+ are validated: \n - bsonobjectid: a bson object
+ ID, i.e. a 24 characters hex string - uri: an URI
+ as parsed by Golang net/url.ParseRequestURI - email:
+ an email address as parsed by Golang net/mail.ParseAddress
+ - hostname: a valid representation for an Internet
+ host name, as defined by RFC 1034, section 3.1 [RFC1034].
- ipv4: an IPv4 IP as parsed by Golang net.ParseIP
- ipv6: an IPv6 IP as parsed by Golang net.ParseIP
- cidr: a CIDR as parsed by Golang net.ParseCIDR
- mac: a MAC address as parsed by Golang net.ParseMAC
- - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041"
- - isbn10: an ISBN10 number string like "0321751043"
- - isbn13: an ISBN13 number string like "978-0321751041"
- - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\d{3})\\d{11})$ with any non digit characters mixed in
- - ssn: a U.S. social security number following the regex ^\\d{3}[- ]?\\d{2}[- ]?\\d{4}$
- - hexcolor: an hexadecimal color code like "#FFFFFF" following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
- - rgbcolor: an RGB color code like rgb like "rgb(255,255,255)"
- - byte: base64 encoded binary data
- - password: any kind of string
- - date: a date string like "2006-01-02" as defined by full-date in RFC3339
- - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format
- - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339.
+ - uuid: an UUID that allows uppercase defined by
+ the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid3: an UUID3 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid4: an UUID4 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - uuid5: an UUID5 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - isbn: an ISBN10 or ISBN13 number string like \"0321751043\"
+ or \"978-0321751041\" - isbn10: an ISBN10 number
+ string like \"0321751043\" - isbn13: an ISBN13 number
+ string like \"978-0321751041\" - creditcard: a credit
+ card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\\\d{3})\\\\d{11})$
+ with any non digit characters mixed in - ssn: a
+ U.S. social security number following the regex
+ ^\\\\d{3}[- ]?\\\\d{2}[- ]?\\\\d{4}$ - hexcolor:
+ an hexadecimal color code like \"#FFFFFF\" following
+ the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ -
+ rgbcolor: an RGB color code like rgb like \"rgb(255,255,255)\"
+ - byte: base64 encoded binary data - password: any
+ kind of string - date: a date string like \"2006-01-02\"
+ as defined by full-date in RFC3339 - duration: a
+ duration string like \"22 ns\" as parsed by Golang
+ time.ParseDuration or compatible with Scala duration
+ format - datetime: a date time string like \"2014-12-15T19:30:20.000Z\"
+ as defined by date-time in RFC3339."
type: string
id:
type: string
@@ -29189,17 +29623,15 @@ spec:
type: string
type: object
type: object
- description: |-
- data specification types for the events consumed/produced by the Kamelet
- Deprecated: In favor of using DataTypes
+ description: 'data specification types for the events consumed/produced
+ by the Kamelet Deprecated: In favor of using DataTypes'
type: object
type: object
status:
default:
phase: Ready
- description: |-
- the actual status of the resource
- Deprecated no longer in use
+ description: the actual status of the resource Deprecated no longer in
+ use
properties:
conditions:
description: Conditions --
@@ -29275,19 +29707,14 @@ spec:
description: Kamelet is the Schema for the kamelets API.
properties:
apiVersion:
- description: |-
- APIVersion defines the versioned schema of this representation of an object.
- Servers should convert recognized schemas to the latest internal value, and
- may reject unrecognized values.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+ description: 'APIVersion defines the versioned schema of this representation
+ of an object. Servers should convert recognized schemas to the latest
+ internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: |-
- Kind is a string value representing the REST resource this object represents.
- Servers may infer this from the endpoint the client submits requests to.
- Cannot be updated.
- In CamelCase.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ description: 'Kind is a string value representing the REST resource this
+ object represents. Servers may infer this from the endpoint the client
+ submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
@@ -29368,9 +29795,10 @@ spec:
description:
type: string
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value.
+ These types are supported: bool, int64, float64,
+ string, []interface{}, map[string]interface{} and
+ nil.'
x-kubernetes-preserve-unknown-fields: true
externalDocs:
description: ExternalDocumentation allows referencing
@@ -29396,49 +29824,65 @@ spec:
type: string
enum:
items:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON
+ value. These types are supported: bool,
+ int64, float64, string, []interface{}, map[string]interface{}
+ and nil.'
x-kubernetes-preserve-unknown-fields: true
type: array
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON
+ value. These types are supported: bool, int64,
+ float64, string, []interface{}, map[string]interface{}
+ and nil.'
x-kubernetes-preserve-unknown-fields: true
exclusiveMaximum:
type: boolean
exclusiveMinimum:
type: boolean
format:
- description: |-
- format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:
-
-
- - bsonobjectid: a bson object ID, i.e. a 24 characters hex string
- - uri: an URI as parsed by Golang net/url.ParseRequestURI
- - email: an email address as parsed by Golang net/mail.ParseAddress
- - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034].
+ description: "format is an OpenAPI v3 format
+ string. Unknown formats are ignored. The following
+ formats are validated: \n - bsonobjectid:
+ a bson object ID, i.e. a 24 characters hex
+ string - uri: an URI as parsed by Golang net/url.ParseRequestURI
+ - email: an email address as parsed by Golang
+ net/mail.ParseAddress - hostname: a valid
+ representation for an Internet host name,
+ as defined by RFC 1034, section 3.1 [RFC1034].
- ipv4: an IPv4 IP as parsed by Golang net.ParseIP
- ipv6: an IPv6 IP as parsed by Golang net.ParseIP
- cidr: a CIDR as parsed by Golang net.ParseCIDR
- mac: a MAC address as parsed by Golang net.ParseMAC
- - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041"
- - isbn10: an ISBN10 number string like "0321751043"
- - isbn13: an ISBN13 number string like "978-0321751041"
- - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\d{3})\\d{11})$ with any non digit characters mixed in
- - ssn: a U.S. social security number following the regex ^\\d{3}[- ]?\\d{2}[- ]?\\d{4}$
- - hexcolor: an hexadecimal color code like "#FFFFFF" following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
- - rgbcolor: an RGB color code like rgb like "rgb(255,255,255)"
- - byte: base64 encoded binary data
- - password: any kind of string
- - date: a date string like "2006-01-02" as defined by full-date in RFC3339
- - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format
- - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339.
+ - uuid: an UUID that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid3: an UUID3 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid4: an UUID4 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - uuid5: an UUID5 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - isbn: an ISBN10 or ISBN13 number string
+ like \"0321751043\" or \"978-0321751041\"
+ - isbn10: an ISBN10 number string like \"0321751043\"
+ - isbn13: an ISBN13 number string like \"978-0321751041\"
+ - creditcard: a credit card number defined
+ by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\\\d{3})\\\\d{11})$
+ with any non digit characters mixed in - ssn:
+ a U.S. social security number following the
+ regex ^\\\\d{3}[- ]?\\\\d{2}[- ]?\\\\d{4}$
+ - hexcolor: an hexadecimal color code like
+ \"#FFFFFF\" following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
+ - rgbcolor: an RGB color code like rgb like
+ \"rgb(255,255,255)\" - byte: base64 encoded
+ binary data - password: any kind of string
+ - date: a date string like \"2006-01-02\"
+ as defined by full-date in RFC3339 - duration:
+ a duration string like \"22 ns\" as parsed
+ by Golang time.ParseDuration or compatible
+ with Scala duration format - datetime: a date
+ time string like \"2014-12-15T19:30:20.000Z\"
+ as defined by date-time in RFC3339."
type: string
id:
type: string
@@ -29519,9 +29963,9 @@ spec:
description:
type: string
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value. These types
+ are supported: bool, int64, float64, string, []interface{},
+ map[string]interface{} and nil.'
x-kubernetes-preserve-unknown-fields: true
externalDocs:
description: ExternalDocumentation allows referencing an external
@@ -29547,49 +29991,56 @@ spec:
type: string
enum:
items:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value. These
+ types are supported: bool, int64, float64, string, []interface{},
+ map[string]interface{} and nil.'
x-kubernetes-preserve-unknown-fields: true
type: array
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value. These
+ types are supported: bool, int64, float64, string, []interface{},
+ map[string]interface{} and nil.'
x-kubernetes-preserve-unknown-fields: true
exclusiveMaximum:
type: boolean
exclusiveMinimum:
type: boolean
format:
- description: |-
- format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:
-
-
- - bsonobjectid: a bson object ID, i.e. a 24 characters hex string
- - uri: an URI as parsed by Golang net/url.ParseRequestURI
+ description: "format is an OpenAPI v3 format string. Unknown
+ formats are ignored. The following formats are validated:
+ \n - bsonobjectid: a bson object ID, i.e. a 24 characters
+ hex string - uri: an URI as parsed by Golang net/url.ParseRequestURI
- email: an email address as parsed by Golang net/mail.ParseAddress
- - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034].
- - ipv4: an IPv4 IP as parsed by Golang net.ParseIP
- - ipv6: an IPv6 IP as parsed by Golang net.ParseIP
- - cidr: a CIDR as parsed by Golang net.ParseCIDR
- - mac: a MAC address as parsed by Golang net.ParseMAC
- - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041"
- - isbn10: an ISBN10 number string like "0321751043"
- - isbn13: an ISBN13 number string like "978-0321751041"
- - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\d{3})\\d{11})$ with any non digit characters mixed in
- - ssn: a U.S. social security number following the regex ^\\d{3}[- ]?\\d{2}[- ]?\\d{4}$
- - hexcolor: an hexadecimal color code like "#FFFFFF" following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
- - rgbcolor: an RGB color code like rgb like "rgb(255,255,255)"
- - byte: base64 encoded binary data
- - password: any kind of string
- - date: a date string like "2006-01-02" as defined by full-date in RFC3339
- - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format
- - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339.
+ - hostname: a valid representation for an Internet host
+ name, as defined by RFC 1034, section 3.1 [RFC1034]. -
+ ipv4: an IPv4 IP as parsed by Golang net.ParseIP - ipv6:
+ an IPv6 IP as parsed by Golang net.ParseIP - cidr: a CIDR
+ as parsed by Golang net.ParseCIDR - mac: a MAC address
+ as parsed by Golang net.ParseMAC - uuid: an UUID that
+ allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid3: an UUID3 that allows uppercase defined by the
+ regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid4: an UUID4 that allows uppercase defined by the
+ regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - uuid5: an UUID5 that allows uppercase defined by the
+ regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - isbn: an ISBN10 or ISBN13 number string like \"0321751043\"
+ or \"978-0321751041\" - isbn10: an ISBN10 number string
+ like \"0321751043\" - isbn13: an ISBN13 number string
+ like \"978-0321751041\" - creditcard: a credit card number
+ defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\\\d{3})\\\\d{11})$
+ with any non digit characters mixed in - ssn: a U.S. social
+ security number following the regex ^\\\\d{3}[- ]?\\\\d{2}[-
+ ]?\\\\d{4}$ - hexcolor: an hexadecimal color code like
+ \"#FFFFFF\" following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
+ - rgbcolor: an RGB color code like rgb like \"rgb(255,255,255)\"
+ - byte: base64 encoded binary data - password: any kind
+ of string - date: a date string like \"2006-01-02\" as
+ defined by full-date in RFC3339 - duration: a duration
+ string like \"22 ns\" as parsed by Golang time.ParseDuration
+ or compatible with Scala duration format - datetime: a
+ date time string like \"2014-12-15T19:30:20.000Z\" as
+ defined by date-time in RFC3339."
type: string
id:
type: string
@@ -29677,8 +30128,7 @@ spec:
description: True if the spec is generated from a Kamelet
type: boolean
interceptors:
- description: |-
- Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
+ description: Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
uses to pre/post process sources
items:
type: string
@@ -29688,9 +30138,8 @@ spec:
to interpret this source code
type: string
loader:
- description: |-
- Loader is an optional id of the org.apache.camel.k.RoutesLoader that will
- interpret this source at runtime
+ description: Loader is an optional id of the org.apache.camel.k.RoutesLoader
+ that will interpret this source at runtime
type: string
name:
description: the name of the specification
@@ -29720,9 +30169,8 @@ spec:
x-kubernetes-preserve-unknown-fields: true
types:
additionalProperties:
- description: |-
- EventTypeSpec represents a specification for an event type.
- Deprecated: In favor of using DataTypeSpec.
+ description: 'EventTypeSpec represents a specification for an event
+ type. Deprecated: In favor of using DataTypeSpec.'
properties:
mediaType:
description: media type as expected for HTTP media types (ie,
@@ -29737,9 +30185,9 @@ spec:
description:
type: string
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value. These
+ types are supported: bool, int64, float64, string, []interface{},
+ map[string]interface{} and nil.'
x-kubernetes-preserve-unknown-fields: true
externalDocs:
description: ExternalDocumentation allows referencing an
@@ -29765,49 +30213,61 @@ spec:
type: string
enum:
items:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value.
+ These types are supported: bool, int64, float64,
+ string, []interface{}, map[string]interface{}
+ and nil.'
x-kubernetes-preserve-unknown-fields: true
type: array
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value.
+ These types are supported: bool, int64, float64,
+ string, []interface{}, map[string]interface{} and
+ nil.'
x-kubernetes-preserve-unknown-fields: true
exclusiveMaximum:
type: boolean
exclusiveMinimum:
type: boolean
format:
- description: |-
- format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:
-
-
- - bsonobjectid: a bson object ID, i.e. a 24 characters hex string
- - uri: an URI as parsed by Golang net/url.ParseRequestURI
- - email: an email address as parsed by Golang net/mail.ParseAddress
- - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034].
+ description: "format is an OpenAPI v3 format string.
+ Unknown formats are ignored. The following formats
+ are validated: \n - bsonobjectid: a bson object
+ ID, i.e. a 24 characters hex string - uri: an URI
+ as parsed by Golang net/url.ParseRequestURI - email:
+ an email address as parsed by Golang net/mail.ParseAddress
+ - hostname: a valid representation for an Internet
+ host name, as defined by RFC 1034, section 3.1 [RFC1034].
- ipv4: an IPv4 IP as parsed by Golang net.ParseIP
- ipv6: an IPv6 IP as parsed by Golang net.ParseIP
- cidr: a CIDR as parsed by Golang net.ParseCIDR
- mac: a MAC address as parsed by Golang net.ParseMAC
- - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041"
- - isbn10: an ISBN10 number string like "0321751043"
- - isbn13: an ISBN13 number string like "978-0321751041"
- - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\d{3})\\d{11})$ with any non digit characters mixed in
- - ssn: a U.S. social security number following the regex ^\\d{3}[- ]?\\d{2}[- ]?\\d{4}$
- - hexcolor: an hexadecimal color code like "#FFFFFF" following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
- - rgbcolor: an RGB color code like rgb like "rgb(255,255,255)"
- - byte: base64 encoded binary data
- - password: any kind of string
- - date: a date string like "2006-01-02" as defined by full-date in RFC3339
- - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format
- - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339.
+ - uuid: an UUID that allows uppercase defined by
+ the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid3: an UUID3 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid4: an UUID4 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - uuid5: an UUID5 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - isbn: an ISBN10 or ISBN13 number string like \"0321751043\"
+ or \"978-0321751041\" - isbn10: an ISBN10 number
+ string like \"0321751043\" - isbn13: an ISBN13 number
+ string like \"978-0321751041\" - creditcard: a credit
+ card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\\\d{3})\\\\d{11})$
+ with any non digit characters mixed in - ssn: a
+ U.S. social security number following the regex
+ ^\\\\d{3}[- ]?\\\\d{2}[- ]?\\\\d{4}$ - hexcolor:
+ an hexadecimal color code like \"#FFFFFF\" following
+ the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ -
+ rgbcolor: an RGB color code like rgb like \"rgb(255,255,255)\"
+ - byte: base64 encoded binary data - password: any
+ kind of string - date: a date string like \"2006-01-02\"
+ as defined by full-date in RFC3339 - duration: a
+ duration string like \"22 ns\" as parsed by Golang
+ time.ParseDuration or compatible with Scala duration
+ format - datetime: a date time string like \"2014-12-15T19:30:20.000Z\"
+ as defined by date-time in RFC3339."
type: string
id:
type: string
@@ -29866,9 +30326,8 @@ spec:
type: string
type: object
type: object
- description: |-
- data specification types for the events consumed/produced by the Kamelet
- Deprecated: In favor of using DataTypes
+ description: 'data specification types for the events consumed/produced
+ by the Kamelet Deprecated: In favor of using DataTypes'
type: object
type: object
status:
@@ -29935,12 +30394,19 @@ spec:
storage: false
subresources:
status: {}
+status:
+ acceptedNames:
+ kind: ""
+ plural: ""
+ conditions: []
+ storedVersions: []
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
- controller-gen.kubebuilder.io/version: v0.15.0
+ controller-gen.kubebuilder.io/version: v0.6.1
+ creationTimestamp: null
labels:
app: camel-k
name: pipes.camel.apache.org
@@ -29973,19 +30439,14 @@ spec:
description: Pipe is the Schema for the Pipe API.
properties:
apiVersion:
- description: |-
- APIVersion defines the versioned schema of this representation of an object.
- Servers should convert recognized schemas to the latest internal value, and
- may reject unrecognized values.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+ description: 'APIVersion defines the versioned schema of this representation
+ of an object. Servers should convert recognized schemas to the latest
+ internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: |-
- Kind is a string value representing the REST resource this object represents.
- Servers may infer this from the endpoint the client submits requests to.
- Cannot be updated.
- In CamelCase.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ description: 'Kind is a string value representing the REST resource this
+ object represents. Servers may infer this from the endpoint the client
+ submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
@@ -29998,17 +30459,15 @@ spec:
type: object
x-kubernetes-preserve-unknown-fields: true
integration:
- description: |-
- Integration is an optional integration used to specify custom parameters
- Deprecated don't use this. Use trait annotations if you need to change any cluster configuration.
+ description: Integration is an optional integration used to specify
+ custom parameters Deprecated don't use this. Use trait annotations
+ if you need to change any cluster configuration.
properties:
configuration:
- description: |-
- Deprecated:
- Use camel trait (camel.properties) to manage properties
- Use mount trait (mount.configs) to manage configs
- Use mount trait (mount.resources) to manage resources
- Use mount trait (mount.volumes) to manage volumes
+ description: 'Deprecated: Use camel trait (camel.properties) to
+ manage properties Use mount trait (mount.configs) to manage
+ configs Use mount trait (mount.resources) to manage resources
+ Use mount trait (mount.volumes) to manage volumes'
items:
description: ConfigurationSpec represents a generic configuration
specification.
@@ -30049,43 +30508,35 @@ spec:
description: API version of the referent.
type: string
fieldPath:
- description: |-
- If referring to a piece of an object instead of an entire object, this string
- should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
- For example, if the object reference is to a container within a pod, this would take on a value like:
- "spec.containers{name}" (where "name" refers to the name of the container that triggered
- the event) or if no container name is specified "spec.containers[2]" (container with
- index 2 in this pod). This syntax is chosen only to have some well-defined way of
- referencing a part of an object.
- TODO: this design is not final and this field is subject to change in the future.
+ description: 'If referring to a piece of an object instead
+ of an entire object, this string should contain a valid
+ JSON/Go field access statement, such as desiredState.manifest.containers[2].
+ For example, if the object reference is to a container within
+ a pod, this would take on a value like: "spec.containers{name}"
+ (where "name" refers to the name of the container that triggered
+ the event) or if no container name is specified "spec.containers[2]"
+ (container with index 2 in this pod). This syntax is chosen
+ only to have some well-defined way of referencing a part
+ of an object. TODO: this design is not final and this field
+ is subject to change in the future.'
type: string
kind:
- description: |-
- Kind of the referent.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ 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: 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'
type: string
namespace:
- description: |-
- Namespace of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
+ description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type: string
resourceVersion:
- description: |-
- Specific resourceVersion to which this reference is made, if any.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
+ description: 'Specific resourceVersion to which this reference
+ is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
type: string
uid:
- description: |-
- UID of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
+ description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
type: string
type: object
- x-kubernetes-map-type: atomic
profile:
description: the profile needed to run this Integration
type: string
@@ -30126,8 +30577,7 @@ spec:
description: True if the spec is generated from a Kamelet
type: boolean
interceptors:
- description: |-
- Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
+ description: Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
uses to pre/post process sources
items:
type: string
@@ -30137,9 +30587,8 @@ spec:
to interpret this source code
type: string
loader:
- description: |-
- Loader is an optional id of the org.apache.camel.k.RoutesLoader that will
- interpret this source at runtime
+ description: Loader is an optional id of the org.apache.camel.k.RoutesLoader
+ that will interpret this source at runtime
type: string
name:
description: the name of the specification
@@ -30183,35 +30632,39 @@ spec:
want to run within a pod.
properties:
args:
- description: |-
- Arguments to the entrypoint.
- The container image's CMD is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Arguments to the entrypoint. The container
+ image''s CMD is used if this is not provided.
+ Variable references $(VAR_NAME) are expanded using
+ the container''s environment. If a variable cannot
+ be resolved, the reference in the input string
+ will be unchanged. Double $$ are reduced to a
+ single $, which allows for escaping the $(VAR_NAME)
+ syntax: i.e. "$$(VAR_NAME)" will produce the string
+ literal "$(VAR_NAME)". Escaped references will
+ never be expanded, regardless of whether the variable
+ exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
command:
- description: |-
- Entrypoint array. Not executed within a shell.
- The container image's ENTRYPOINT is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Entrypoint array. Not executed within
+ a shell. The container image''s ENTRYPOINT is
+ used if this is not provided. Variable references
+ $(VAR_NAME) are expanded using the container''s
+ environment. If a variable cannot be resolved,
+ the reference in the input string will be unchanged.
+ Double $$ are reduced to a single $, which allows
+ for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)"
+ will produce the string literal "$(VAR_NAME)".
+ Escaped references will never be expanded, regardless
+ of whether the variable exists or not. Cannot
+ be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
env:
- description: |-
- List of environment variables to set in the container.
- Cannot be updated.
+ description: List of environment variables to set
+ in the container. Cannot be updated.
items:
description: EnvVar represents an environment
variable present in a Container.
@@ -30221,16 +30674,18 @@ spec:
Must be a C_IDENTIFIER.
type: string
value:
- description: |-
- Variable references $(VAR_NAME) are expanded
- using the previously defined environment variables in the container and
- any service environment variables. If a variable cannot be resolved,
- the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
- "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
- Escaped references will never be expanded, regardless of whether the variable
- exists or not.
- Defaults to "".
+ description: 'Variable references $(VAR_NAME)
+ are expanded using the previously defined
+ environment variables in the container and
+ any service environment variables. If a
+ variable cannot be resolved, the reference
+ in the input string will be unchanged. Double
+ $$ are reduced to a single $, which allows
+ for escaping the $(VAR_NAME) syntax: i.e.
+ "$$(VAR_NAME)" will produce the string literal
+ "$(VAR_NAME)". Escaped references will never
+ be expanded, regardless of whether the variable
+ exists or not. Defaults to "".'
type: string
valueFrom:
description: Source for the environment variable's
@@ -30243,10 +30698,10 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
+ description: 'Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
@@ -30255,11 +30710,12 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
fieldRef:
- description: |-
- Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`,
- spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ description: 'Selects a field of the pod:
+ supports metadata.name, metadata.namespace,
+ `metadata.labels['''']`, `metadata.annotations['''']`,
+ spec.nodeName, spec.serviceAccountName,
+ status.hostIP, status.podIP, status.podIPs.'
properties:
apiVersion:
description: Version of the schema
@@ -30273,11 +30729,13 @@ spec:
required:
- fieldPath
type: object
- x-kubernetes-map-type: atomic
resourceFieldRef:
- description: |-
- Selects a resource of the container: only resources limits and requests
- (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
+ description: 'Selects a resource of the
+ container: only resources limits and
+ requests (limits.cpu, limits.memory,
+ limits.ephemeral-storage, requests.cpu,
+ requests.memory and requests.ephemeral-storage)
+ are currently supported.'
properties:
containerName:
description: 'Container name: required
@@ -30299,7 +30757,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret
in the pod's namespace
@@ -30310,10 +30767,10 @@ spec:
secret key.
type: string
name:
- description: |-
- Name of the referent.
+ description: 'Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret
@@ -30322,20 +30779,21 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
required:
- name
type: object
type: array
envFrom:
- description: |-
- List of sources to populate environment variables in the container.
- The keys defined within a source must be a C_IDENTIFIER. All invalid keys
- will be reported as an event when the container is starting. When a key exists in multiple
- sources, the value associated with the last source will take precedence.
- Values defined by an Env with a duplicate key will take precedence.
- Cannot be updated.
+ description: List of sources to populate environment
+ variables in the container. The keys defined within
+ a source must be a C_IDENTIFIER. All invalid keys
+ will be reported as an event when the container
+ is starting. When a key exists in multiple sources,
+ the value associated with the last source will
+ take precedence. Values defined by an Env with
+ a duplicate key will take precedence. Cannot be
+ updated.
items:
description: EnvFromSource represents the source
of a set of ConfigMaps
@@ -30344,17 +30802,16 @@ spec:
description: The ConfigMap to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
prefix:
description: An optional identifier to prepend
to each key in the ConfigMap. Must be a
@@ -30364,57 +30821,59 @@ spec:
description: The Secret to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret
must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
image:
- description: |-
- Container image name.
- More info: https://kubernetes.io/docs/concepts/containers/images
- This field is optional to allow higher level config management to default or override
- container images in workload controllers like Deployments and StatefulSets.
+ description: 'Container image name. More info: https://kubernetes.io/docs/concepts/containers/images
+ This field is optional to allow higher level config
+ management to default or override container images
+ in workload controllers like Deployments and StatefulSets.'
type: string
imagePullPolicy:
- description: |-
- Image pull policy.
- One of Always, Never, IfNotPresent.
- Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
+ description: 'Image pull policy. One of Always,
+ Never, IfNotPresent. Defaults to Always if :latest
+ tag is specified, or IfNotPresent otherwise. Cannot
+ be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
- description: |-
- Actions that the management system should take in response to container lifecycle events.
- Cannot be updated.
+ description: Actions that the management system
+ should take in response to container lifecycle
+ events. Cannot be updated.
properties:
postStart:
- description: |-
- PostStart is called immediately after a container is created. If the handler fails,
- the container is terminated and restarted according to its restart policy.
- Other management of the container blocks until the hook completes.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PostStart is called immediately
+ after a container is created. If the handler
+ fails, the container is terminated and restarted
+ according to its restart policy. Other management
+ of the container blocks until the hook completes.
+ More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to
take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command
+ line to execute inside the container,
+ the working directory for the command is
+ root ('/') in the container's filesystem.
+ The command is simply exec'd, it is
+ not run inside a shell, so traditional
+ shell instructions ('|', etc) won't
+ work. To use a shell, you need to
+ explicitly call out to that shell.
+ Exit status of 0 is treated as live/healthy
+ and non-zero is unhealthy.
items:
type: string
type: array
@@ -30424,9 +30883,10 @@ spec:
request to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to,
+ defaults to the pod IP. You probably
+ want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
description: Custom headers to set in
@@ -30438,9 +30898,11 @@ spec:
probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field
+ name. This will be canonicalized
+ upon output, so case-variant
+ names will be understood as
+ the same header.
type: string
value:
description: The header field
@@ -30459,15 +30921,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -30486,10 +30947,12 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT
+ supported as a LifecycleHandler and kept
+ for the backward compatibility. There
+ are no validation of this field and lifecycle
+ hooks will fail in runtime when tcp handler
+ is specified.
properties:
host:
description: 'Optional: Host name to
@@ -30499,38 +30962,47 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
preStop:
- description: |-
- PreStop is called immediately before a container is terminated due to an
- API request or management event such as liveness/startup probe failure,
- preemption, resource contention, etc. The handler is not called if the
- container crashes or exits. The Pod's termination grace period countdown begins before the
- PreStop hook is executed. Regardless of the outcome of the handler, the
- container will eventually terminate within the Pod's termination grace
- period (unless delayed by finalizers). Other management of the container blocks until the hook completes
- or until the termination grace period is reached.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PreStop is called immediately
+ before a container is terminated due to an
+ API request or management event such as liveness/startup
+ probe failure, preemption, resource contention,
+ etc. The handler is not called if the container
+ crashes or exits. The Pod''s termination grace
+ period countdown begins before the PreStop
+ hook is executed. Regardless of the outcome
+ of the handler, the container will eventually
+ terminate within the Pod''s termination grace
+ period (unless delayed by finalizers). Other
+ management of the container blocks until the
+ hook completes or until the termination grace
+ period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to
take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command
+ line to execute inside the container,
+ the working directory for the command is
+ root ('/') in the container's filesystem.
+ The command is simply exec'd, it is
+ not run inside a shell, so traditional
+ shell instructions ('|', etc) won't
+ work. To use a shell, you need to
+ explicitly call out to that shell.
+ Exit status of 0 is treated as live/healthy
+ and non-zero is unhealthy.
items:
type: string
type: array
@@ -30540,9 +31012,10 @@ spec:
request to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to,
+ defaults to the pod IP. You probably
+ want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
description: Custom headers to set in
@@ -30554,9 +31027,11 @@ spec:
probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field
+ name. This will be canonicalized
+ upon output, so case-variant
+ names will be understood as
+ the same header.
type: string
value:
description: The header field
@@ -30575,15 +31050,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -30602,10 +31076,12 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT
+ supported as a LifecycleHandler and kept
+ for the backward compatibility. There
+ are no validation of this field and lifecycle
+ hooks will fail in runtime when tcp handler
+ is specified.
properties:
host:
description: 'Optional: Host name to
@@ -30615,10 +31091,10 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
@@ -30626,30 +31102,33 @@ spec:
type: object
type: object
livenessProbe:
- description: |-
- Periodic probe of container liveness.
+ 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
+ Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -30662,12 +31141,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -30677,8 +31155,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -30689,9 +31167,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -30709,35 +31188,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -30752,59 +31231,63 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
name:
- description: |-
- Name of the container specified as a DNS_LABEL.
- Each container in a pod must have a unique name (DNS_LABEL).
- Cannot be updated.
+ description: Name of the container specified as
+ a DNS_LABEL. Each container in a pod must have
+ a unique name (DNS_LABEL). Cannot be updated.
type: string
ports:
- description: |-
- List of ports to expose from the container. Not specifying a port here
- DOES NOT prevent that port from being exposed. Any port which is
- listening on the default "0.0.0.0" address inside a container will be
- accessible from the network.
- Modifying this array with strategic merge patch may corrupt the data.
- For more information See https://github.com/kubernetes/kubernetes/issues/108255.
+ description: List of ports to expose from the container.
+ Not specifying a port here DOES NOT prevent that
+ port from being exposed. Any port which is listening
+ on the default "0.0.0.0" address inside a container
+ will be accessible from the network. Modifying
+ this array with strategic merge patch may corrupt
+ the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255.
Cannot be updated.
items:
description: ContainerPort represents a network
port in a single container.
properties:
containerPort:
- description: |-
- Number of port to expose on the pod's IP address.
- This must be a valid port number, 0 < x < 65536.
+ description: Number of port to expose on the
+ pod's IP address. This must be a valid port
+ number, 0 < x < 65536.
format: int32
type: integer
hostIP:
@@ -30812,24 +31295,24 @@ spec:
port to.
type: string
hostPort:
- description: |-
- Number of port to expose on the host.
- If specified, this must be a valid port number, 0 < x < 65536.
- If HostNetwork is specified, this must match ContainerPort.
+ description: Number of port to expose on the
+ host. If specified, this must be a valid
+ port number, 0 < x < 65536. If HostNetwork
+ is specified, this must match ContainerPort.
Most containers do not need this.
format: int32
type: integer
name:
- description: |-
- If specified, this must be an IANA_SVC_NAME and unique within the pod. Each
- named port in a pod must have a unique name. Name for the port that can be
- referred to by services.
+ description: If specified, this must be an
+ IANA_SVC_NAME and unique within the pod.
+ Each named port in a pod must have a unique
+ name. Name for the port that can be referred
+ to by services.
type: string
protocol:
default: TCP
- description: |-
- Protocol for port. Must be UDP, TCP, or SCTP.
- Defaults to "TCP".
+ description: Protocol for port. Must be UDP,
+ TCP, or SCTP. Defaults to "TCP".
type: string
required:
- containerPort
@@ -30840,30 +31323,34 @@ spec:
- protocol
x-kubernetes-list-type: map
readinessProbe:
- description: |-
- Periodic probe of container service readiness.
- Container will be removed from service endpoints if the probe fails.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Periodic probe of container service
+ readiness. Container will be removed from service
+ endpoints if the probe fails. Cannot be updated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -30876,12 +31363,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -30891,8 +31377,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -30903,9 +31389,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -30923,35 +31410,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -30966,33 +31453,38 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
@@ -31003,14 +31495,14 @@ spec:
resource resize policy for the container.
properties:
resourceName:
- description: |-
- Name of the resource to which this resource resize policy applies.
- Supported values: cpu, memory.
+ description: 'Name of the resource to which
+ this resource resize policy applies. Supported
+ values: cpu, memory.'
type: string
restartPolicy:
- description: |-
- Restart policy to apply when specified resource is resized.
- If not specified, it defaults to NotRequired.
+ description: Restart policy to apply when
+ specified resource is resized. If not specified,
+ it defaults to NotRequired.
type: string
required:
- resourceName
@@ -31019,31 +31511,26 @@ spec:
type: array
x-kubernetes-list-type: atomic
resources:
- description: |-
- Compute Resources required by this container.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Compute Resources required by this
+ container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
properties:
claims:
- description: |-
- Claims lists the names of resources, defined in spec.resourceClaims,
- that are used by this container.
-
-
- This is an alpha field and requires enabling the
- DynamicResourceAllocation feature gate.
-
-
- This field is immutable. It can only be set for containers.
+ description: "Claims lists the names of resources,
+ defined in spec.resourceClaims, that are used
+ by this container. \n This is an alpha field
+ and requires enabling the DynamicResourceAllocation
+ feature gate. \n This field is immutable.
+ It can only be set for containers."
items:
description: ResourceClaim references one
entry in PodSpec.ResourceClaims.
properties:
name:
- description: |-
- Name must match the name of one entry in pod.spec.resourceClaims of
- the Pod where this field is used. It makes that resource available
- inside a container.
+ description: Name must match the name
+ of one entry in pod.spec.resourceClaims
+ of the Pod where this field is used.
+ It makes that resource available inside
+ a container.
type: string
required:
- name
@@ -31059,9 +31546,8 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Limits describes the maximum amount of compute resources allowed.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Limits describes the maximum amount
+ of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -31070,52 +31556,61 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Requests describes the minimum amount of compute resources required.
- If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
- otherwise to an implementation-defined value. Requests cannot exceed Limits.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Requests describes the minimum
+ amount of compute resources required. If Requests
+ is omitted for a container, it defaults to
+ Limits if that is explicitly specified, otherwise
+ to an implementation-defined value. Requests
+ cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
restartPolicy:
- description: |-
- RestartPolicy defines the restart behavior of individual containers in a pod.
- This field may only be set for init containers, and the only allowed value is "Always".
- For non-init containers or when this field is not specified,
- the restart behavior is defined by the Pod's restart policy and the container type.
- Setting the RestartPolicy as "Always" for the init container will have the following effect:
- this init container will be continually restarted on
- exit until all regular containers have terminated. Once all regular
- containers have completed, all init containers with restartPolicy "Always"
- will be shut down. This lifecycle differs from normal init containers and
- is often referred to as a "sidecar" container. Although this init
- container still starts in the init container sequence, it does not wait
- for the container to complete before proceeding to the next init
- container. Instead, the next init container starts immediately after this
- init container is started, or after any startupProbe has successfully
- completed.
+ description: 'RestartPolicy defines the restart
+ behavior of individual containers in a pod. This
+ field may only be set for init containers, and
+ the only allowed value is "Always". For non-init
+ containers or when this field is not specified,
+ the restart behavior is defined by the Pod''s
+ restart policy and the container type. Setting
+ the RestartPolicy as "Always" for the init container
+ will have the following effect: this init container
+ will be continually restarted on exit until all
+ regular containers have terminated. Once all regular
+ containers have completed, all init containers
+ with restartPolicy "Always" will be shut down.
+ This lifecycle differs from normal init containers
+ and is often referred to as a "sidecar" container.
+ Although this init container still starts in the
+ init container sequence, it does not wait for
+ the container to complete before proceeding to
+ the next init container. Instead, the next init
+ container starts immediately after this init container
+ is started, or after any startupProbe has successfully
+ completed.'
type: string
securityContext:
- description: |-
- SecurityContext defines the security options the container should be run with.
- If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
- More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
+ description: 'SecurityContext defines the security
+ options the container should be run with. If set,
+ the fields of SecurityContext override the equivalent
+ fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
properties:
allowPrivilegeEscalation:
- description: |-
- AllowPrivilegeEscalation controls whether a process can gain more
- privileges than its parent process. This bool directly controls if
- the no_new_privs flag will be set on the container process.
- AllowPrivilegeEscalation is true always when the container is:
- 1) run as Privileged
- 2) has CAP_SYS_ADMIN
- Note that this field cannot be set when spec.os.name is windows.
+ description: 'AllowPrivilegeEscalation controls
+ whether a process can gain more privileges
+ than its parent process. This bool directly
+ controls if the no_new_privs flag will be
+ set on the container process. AllowPrivilegeEscalation
+ is true always when the container is: 1) run
+ as Privileged 2) has CAP_SYS_ADMIN Note that
+ this field cannot be set when spec.os.name
+ is windows.'
type: boolean
capabilities:
- description: |-
- The capabilities to add/drop when running containers.
- Defaults to the default set of capabilities granted by the container runtime.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The capabilities to add/drop when
+ running containers. Defaults to the default
+ set of capabilities granted by the container
+ runtime. Note that this field cannot be set
+ when spec.os.name is windows.
properties:
add:
description: Added capabilities
@@ -31133,60 +31628,69 @@ spec:
type: array
type: object
privileged:
- description: |-
- Run container in privileged mode.
- Processes in privileged containers are essentially equivalent to root on the host.
- Defaults to false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Run container in privileged mode.
+ Processes in privileged containers are essentially
+ equivalent to root on the host. Defaults to
+ false. Note that this field cannot be set
+ when spec.os.name is windows.
type: boolean
procMount:
- description: |-
- procMount denotes the type of proc mount to use for the containers.
- The default is DefaultProcMount which uses the container runtime defaults for
- readonly paths and masked paths.
- This requires the ProcMountType feature flag to be enabled.
- Note that this field cannot be set when spec.os.name is windows.
+ description: procMount denotes the type of proc
+ mount to use for the containers. The default
+ is DefaultProcMount which uses the container
+ runtime defaults for readonly paths and masked
+ paths. This requires the ProcMountType feature
+ flag to be enabled. Note that this field cannot
+ be set when spec.os.name is windows.
type: string
readOnlyRootFilesystem:
- description: |-
- Whether this container has a read-only root filesystem.
- Default is false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Whether this container has a read-only
+ root filesystem. Default is false. Note that
+ this field cannot be set when spec.os.name
+ is windows.
type: boolean
runAsGroup:
- description: |-
- The GID to run the entrypoint of the container process.
- Uses runtime default if unset.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The GID to run the entrypoint of
+ the container process. Uses runtime default
+ if unset. May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is windows.
format: int64
type: integer
runAsNonRoot:
- description: |-
- Indicates that the container must run as a non-root user.
- If true, the Kubelet will validate the image at runtime to ensure that it
- does not run as UID 0 (root) and fail to start the container if it does.
- If unset or false, no such validation will be performed.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: Indicates that the container must
+ run as a non-root user. If true, the Kubelet
+ will validate the image at runtime to ensure
+ that it does not run as UID 0 (root) and fail
+ to start the container if it does. If unset
+ or false, no such validation will be performed.
+ May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence.
type: boolean
runAsUser:
- description: |-
- The UID to run the entrypoint of the container process.
- Defaults to user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The UID to run the entrypoint of
+ the container process. Defaults to user specified
+ in image metadata if unspecified. May also
+ be set in PodSecurityContext. If set in both
+ SecurityContext and PodSecurityContext, the
+ value specified in SecurityContext takes precedence.
+ Note that this field cannot be set when spec.os.name
+ is windows.
format: int64
type: integer
seLinuxOptions:
- description: |-
- The SELinux context to be applied to the container.
- If unspecified, the container runtime will allocate a random SELinux context for each
- container. May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The SELinux context to be applied
+ to the container. If unspecified, the container
+ runtime will allocate a random SELinux context
+ for each container. May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is windows.
properties:
level:
description: Level is SELinux level label
@@ -31206,93 +31710,112 @@ spec:
type: string
type: object
seccompProfile:
- description: |-
- The seccomp options to use by this container. If seccomp options are
- provided at both the pod & container level, the container options
- override the pod options.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The seccomp options to use by this
+ container. If seccomp options are provided
+ at both the pod & container level, the container
+ options override the pod options. Note that
+ this field cannot be set when spec.os.name
+ is windows.
properties:
localhostProfile:
- description: |-
- localhostProfile indicates a profile defined in a file on the node should be used.
- The profile must be preconfigured on the node to work.
- Must be a descending path, relative to the kubelet's configured seccomp profile location.
- Must be set if type is "Localhost". Must NOT be set for any other type.
+ description: localhostProfile indicates
+ a profile defined in a file on the node
+ should be used. The profile must be preconfigured
+ on the node to work. Must be a descending
+ path, relative to the kubelet's configured
+ seccomp profile location. Must be set
+ if type is "Localhost". Must NOT be set
+ for any other type.
type: string
type:
- description: |-
- type indicates which kind of seccomp profile will be applied.
- Valid options are:
-
-
- Localhost - a profile defined in a file on the node should be used.
- RuntimeDefault - the container runtime default profile should be used.
- Unconfined - no profile should be applied.
+ description: "type indicates which kind
+ of seccomp profile will be applied. Valid
+ options are: \n Localhost - a profile
+ defined in a file on the node should be
+ used. RuntimeDefault - the container runtime
+ default profile should be used. Unconfined
+ - no profile should be applied."
type: string
required:
- type
type: object
windowsOptions:
- description: |-
- The Windows specific settings applied to all containers.
- If unspecified, the options from the PodSecurityContext will be used.
- If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is linux.
+ description: The Windows specific settings applied
+ to all containers. If unspecified, the options
+ from the PodSecurityContext will be used.
+ If set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is linux.
properties:
gmsaCredentialSpec:
- description: |-
- GMSACredentialSpec is where the GMSA admission webhook
- (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
- GMSA credential spec named by the GMSACredentialSpecName field.
+ description: GMSACredentialSpec is where
+ the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa)
+ inlines the contents of the GMSA credential
+ spec named by the GMSACredentialSpecName
+ field.
type: string
gmsaCredentialSpecName:
description: GMSACredentialSpecName is the
name of the GMSA credential spec to use.
type: string
hostProcess:
- description: |-
- HostProcess determines if a container should be run as a 'Host Process' container.
- All of a Pod's containers must have the same effective HostProcess value
- (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
- In addition, if HostProcess is true then HostNetwork must also be set to true.
+ description: HostProcess determines if a
+ container should be run as a 'Host Process'
+ container. All of a Pod's containers must
+ have the same effective HostProcess value
+ (it is not allowed to have a mix of HostProcess
+ containers and non-HostProcess containers).
+ In addition, if HostProcess is true then
+ HostNetwork must also be set to true.
type: boolean
runAsUserName:
- description: |-
- The UserName in Windows to run the entrypoint of the container process.
- Defaults to the user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: The UserName in Windows to
+ run the entrypoint of the container process.
+ Defaults to the user specified in image
+ metadata if unspecified. May also be set
+ in PodSecurityContext. If set in both
+ SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext
+ takes precedence.
type: string
type: object
type: object
startupProbe:
- description: |-
- StartupProbe indicates that the Pod has successfully initialized.
- If specified, no other probes are executed until this completes successfully.
- If this probe fails, the Pod will be restarted, just as if the livenessProbe failed.
- This can be used to provide different probe parameters at the beginning of a Pod's lifecycle,
- when it might take a long time to load data or warm a cache, than during steady-state operation.
- This cannot be updated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'StartupProbe indicates that the Pod
+ has successfully initialized. If specified, no
+ other probes are executed until this completes
+ successfully. If this probe fails, the Pod will
+ be restarted, just as if the livenessProbe failed.
+ This can be used to provide different probe parameters
+ at the beginning of a Pod''s lifecycle, when it
+ might take a long time to load data or warm a
+ cache, than during steady-state operation. This
+ cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -31305,12 +31828,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -31320,8 +31842,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -31332,9 +31854,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -31352,35 +31875,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -31395,76 +31918,87 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
stdin:
- description: |-
- Whether this container should allocate a buffer for stdin in the container runtime. If this
- is not set, reads from stdin in the container will always result in EOF.
- Default is false.
+ description: Whether this container should allocate
+ a buffer for stdin in the container runtime. If
+ this is not set, reads from stdin in the container
+ will always result in EOF. Default is false.
type: boolean
stdinOnce:
- description: |-
- Whether the container runtime should close the stdin channel after it has been opened by
- a single attach. When stdin is true the stdin stream will remain open across multiple attach
- sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
- first client attaches to stdin, and then remains open and accepts data until the client disconnects,
- at which time stdin is closed and remains closed until the container is restarted. If this
- flag is false, a container processes that reads from stdin will never receive an EOF.
- Default is false
+ description: Whether the container runtime should
+ close the stdin channel after it has been opened
+ by a single attach. When stdin is true the stdin
+ stream will remain open across multiple attach
+ sessions. If stdinOnce is set to true, stdin is
+ opened on container start, is empty until the
+ first client attaches to stdin, and then remains
+ open and accepts data until the client disconnects,
+ at which time stdin is closed and remains closed
+ until the container is restarted. If this flag
+ is false, a container processes that reads from
+ stdin will never receive an EOF. Default is false
type: boolean
terminationMessagePath:
- description: |-
- Optional: Path at which the file to which the container's termination message
- will be written is mounted into the container's filesystem.
- Message written is intended to be brief final status, such as an assertion failure message.
- Will be truncated by the node if greater than 4096 bytes. The total message length across
- all containers will be limited to 12kb.
- Defaults to /dev/termination-log.
- Cannot be updated.
+ description: 'Optional: Path at which the file to
+ which the container''s termination message will
+ be written is mounted into the container''s filesystem.
+ Message written is intended to be brief final
+ status, such as an assertion failure message.
+ Will be truncated by the node if greater than
+ 4096 bytes. The total message length across all
+ containers will be limited to 12kb. Defaults to
+ /dev/termination-log. Cannot be updated.'
type: string
terminationMessagePolicy:
- description: |-
- Indicate how the termination message should be populated. File will use the contents of
- terminationMessagePath to populate the container status message on both success and failure.
- FallbackToLogsOnError will use the last chunk of container log output if the termination
- message file is empty and the container exited with an error.
- The log output is limited to 2048 bytes or 80 lines, whichever is smaller.
- Defaults to File.
- Cannot be updated.
+ description: Indicate how the termination message
+ should be populated. File will use the contents
+ of terminationMessagePath to populate the container
+ status message on both success and failure. FallbackToLogsOnError
+ will use the last chunk of container log output
+ if the termination message file is empty and the
+ container exited with an error. The log output
+ is limited to 2048 bytes or 80 lines, whichever
+ is smaller. Defaults to File. Cannot be updated.
type: string
tty:
- description: |-
- Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
- Default is false.
+ description: Whether this container should allocate
+ a TTY for itself, also requires 'stdin' to be
+ true. Default is false.
type: boolean
volumeDevices:
description: volumeDevices is the list of block
@@ -31488,45 +32022,46 @@ spec:
type: object
type: array
volumeMounts:
- description: |-
- Pod volumes to mount into the container's filesystem.
- Cannot be updated.
+ description: Pod volumes to mount into the container's
+ filesystem. Cannot be updated.
items:
description: VolumeMount describes a mounting
of a Volume within a container.
properties:
mountPath:
- description: |-
- Path within the container at which the volume should be mounted. Must
+ description: Path within the container at
+ which the volume should be mounted. Must
not contain ':'.
type: string
mountPropagation:
- description: |-
- mountPropagation determines how mounts are propagated from the host
- to container and the other way around.
- When not set, MountPropagationNone is used.
- This field is beta in 1.10.
+ description: mountPropagation determines how
+ mounts are propagated from the host to container
+ and the other way around. When not set,
+ MountPropagationNone is used. This field
+ is beta in 1.10.
type: string
name:
description: This must match the Name of a
Volume.
type: string
readOnly:
- description: |-
- Mounted read-only if true, read-write otherwise (false or unspecified).
- Defaults to false.
+ description: Mounted read-only if true, read-write
+ otherwise (false or unspecified). Defaults
+ to false.
type: boolean
subPath:
- description: |-
- Path within the volume from which the container's volume should be mounted.
+ description: Path within the volume from which
+ the container's volume should be mounted.
Defaults to "" (volume's root).
type: string
subPathExpr:
- description: |-
- Expanded path within the volume from which the container's volume should be mounted.
- Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.
- Defaults to "" (volume's root).
- SubPathExpr and SubPath are mutually exclusive.
+ description: Expanded path within the volume
+ from which the container's volume should
+ be mounted. Behaves similarly to SubPath
+ but environment variable references $(VAR_NAME)
+ are expanded using the container's environment.
+ Defaults to "" (volume's root). SubPathExpr
+ and SubPath are mutually exclusive.
type: string
required:
- mountPath
@@ -31534,11 +32069,10 @@ spec:
type: object
type: array
workingDir:
- description: |-
- Container's working directory.
- If not specified, the container runtime's default will be used, which
- might be configured in the container image.
- Cannot be updated.
+ description: Container's working directory. If not
+ specified, the container runtime's default will
+ be used, which might be configured in the container
+ image. Cannot be updated.
type: string
required:
- name
@@ -31550,47 +32084,51 @@ spec:
ephemeralContainers:
description: EphemeralContainers
items:
- description: |-
- An EphemeralContainer is a temporary container that you may add to an existing Pod for
- user-initiated activities such as debugging. Ephemeral containers have no resource or
- scheduling guarantees, and they will not be restarted when they exit or when a Pod is
- removed or restarted. The kubelet may evict a Pod if an ephemeral container causes the
- Pod to exceed its resource allocation.
-
-
- To add an ephemeral container, use the ephemeralcontainers subresource of an existing
- Pod. Ephemeral containers may not be removed or restarted.
+ description: "An EphemeralContainer is a temporary container
+ that you may add to an existing Pod for user-initiated
+ activities such as debugging. Ephemeral containers
+ have no resource or scheduling guarantees, and they
+ will not be restarted when they exit or when a Pod
+ is removed or restarted. The kubelet may evict a Pod
+ if an ephemeral container causes the Pod to exceed
+ its resource allocation. \n To add an ephemeral container,
+ use the ephemeralcontainers subresource of an existing
+ Pod. Ephemeral containers may not be removed or restarted."
properties:
args:
- description: |-
- Arguments to the entrypoint.
- The image's CMD is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Arguments to the entrypoint. The image''s
+ CMD is used if this is not provided. Variable
+ references $(VAR_NAME) are expanded using the
+ container''s environment. If a variable cannot
+ be resolved, the reference in the input string
+ will be unchanged. Double $$ are reduced to a
+ single $, which allows for escaping the $(VAR_NAME)
+ syntax: i.e. "$$(VAR_NAME)" will produce the string
+ literal "$(VAR_NAME)". Escaped references will
+ never be expanded, regardless of whether the variable
+ exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
command:
- description: |-
- Entrypoint array. Not executed within a shell.
- The image's ENTRYPOINT is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Entrypoint array. Not executed within
+ a shell. The image''s ENTRYPOINT is used if this
+ is not provided. Variable references $(VAR_NAME)
+ are expanded using the container''s environment.
+ If a variable cannot be resolved, the reference
+ in the input string will be unchanged. Double
+ $$ are reduced to a single $, which allows for
+ escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)"
+ will produce the string literal "$(VAR_NAME)".
+ Escaped references will never be expanded, regardless
+ of whether the variable exists or not. Cannot
+ be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
env:
- description: |-
- List of environment variables to set in the container.
- Cannot be updated.
+ description: List of environment variables to set
+ in the container. Cannot be updated.
items:
description: EnvVar represents an environment
variable present in a Container.
@@ -31600,16 +32138,18 @@ spec:
Must be a C_IDENTIFIER.
type: string
value:
- description: |-
- Variable references $(VAR_NAME) are expanded
- using the previously defined environment variables in the container and
- any service environment variables. If a variable cannot be resolved,
- the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
- "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
- Escaped references will never be expanded, regardless of whether the variable
- exists or not.
- Defaults to "".
+ description: 'Variable references $(VAR_NAME)
+ are expanded using the previously defined
+ environment variables in the container and
+ any service environment variables. If a
+ variable cannot be resolved, the reference
+ in the input string will be unchanged. Double
+ $$ are reduced to a single $, which allows
+ for escaping the $(VAR_NAME) syntax: i.e.
+ "$$(VAR_NAME)" will produce the string literal
+ "$(VAR_NAME)". Escaped references will never
+ be expanded, regardless of whether the variable
+ exists or not. Defaults to "".'
type: string
valueFrom:
description: Source for the environment variable's
@@ -31622,10 +32162,10 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
+ description: 'Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
@@ -31634,11 +32174,12 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
fieldRef:
- description: |-
- Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`,
- spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ description: 'Selects a field of the pod:
+ supports metadata.name, metadata.namespace,
+ `metadata.labels['''']`, `metadata.annotations['''']`,
+ spec.nodeName, spec.serviceAccountName,
+ status.hostIP, status.podIP, status.podIPs.'
properties:
apiVersion:
description: Version of the schema
@@ -31652,11 +32193,13 @@ spec:
required:
- fieldPath
type: object
- x-kubernetes-map-type: atomic
resourceFieldRef:
- description: |-
- Selects a resource of the container: only resources limits and requests
- (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
+ description: 'Selects a resource of the
+ container: only resources limits and
+ requests (limits.cpu, limits.memory,
+ limits.ephemeral-storage, requests.cpu,
+ requests.memory and requests.ephemeral-storage)
+ are currently supported.'
properties:
containerName:
description: 'Container name: required
@@ -31678,7 +32221,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret
in the pod's namespace
@@ -31689,10 +32231,10 @@ spec:
secret key.
type: string
name:
- description: |-
- Name of the referent.
+ description: 'Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret
@@ -31701,20 +32243,21 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
required:
- name
type: object
type: array
envFrom:
- description: |-
- List of sources to populate environment variables in the container.
- The keys defined within a source must be a C_IDENTIFIER. All invalid keys
- will be reported as an event when the container is starting. When a key exists in multiple
- sources, the value associated with the last source will take precedence.
- Values defined by an Env with a duplicate key will take precedence.
- Cannot be updated.
+ description: List of sources to populate environment
+ variables in the container. The keys defined within
+ a source must be a C_IDENTIFIER. All invalid keys
+ will be reported as an event when the container
+ is starting. When a key exists in multiple sources,
+ the value associated with the last source will
+ take precedence. Values defined by an Env with
+ a duplicate key will take precedence. Cannot be
+ updated.
items:
description: EnvFromSource represents the source
of a set of ConfigMaps
@@ -31723,17 +32266,16 @@ spec:
description: The ConfigMap to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
prefix:
description: An optional identifier to prepend
to each key in the ConfigMap. Must be a
@@ -31743,54 +32285,55 @@ spec:
description: The Secret to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret
must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
image:
- description: |-
- Container image name.
- More info: https://kubernetes.io/docs/concepts/containers/images
+ description: 'Container image name. More info: https://kubernetes.io/docs/concepts/containers/images'
type: string
imagePullPolicy:
- description: |-
- Image pull policy.
- One of Always, Never, IfNotPresent.
- Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
+ description: 'Image pull policy. One of Always,
+ Never, IfNotPresent. Defaults to Always if :latest
+ tag is specified, or IfNotPresent otherwise. Cannot
+ be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
description: Lifecycle is not allowed for ephemeral
containers.
properties:
postStart:
- description: |-
- PostStart is called immediately after a container is created. If the handler fails,
- the container is terminated and restarted according to its restart policy.
- Other management of the container blocks until the hook completes.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PostStart is called immediately
+ after a container is created. If the handler
+ fails, the container is terminated and restarted
+ according to its restart policy. Other management
+ of the container blocks until the hook completes.
+ More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to
take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command
+ line to execute inside the container,
+ the working directory for the command is
+ root ('/') in the container's filesystem.
+ The command is simply exec'd, it is
+ not run inside a shell, so traditional
+ shell instructions ('|', etc) won't
+ work. To use a shell, you need to
+ explicitly call out to that shell.
+ Exit status of 0 is treated as live/healthy
+ and non-zero is unhealthy.
items:
type: string
type: array
@@ -31800,9 +32343,10 @@ spec:
request to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to,
+ defaults to the pod IP. You probably
+ want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
description: Custom headers to set in
@@ -31814,9 +32358,11 @@ spec:
probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field
+ name. This will be canonicalized
+ upon output, so case-variant
+ names will be understood as
+ the same header.
type: string
value:
description: The header field
@@ -31835,15 +32381,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -31862,10 +32407,12 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT
+ supported as a LifecycleHandler and kept
+ for the backward compatibility. There
+ are no validation of this field and lifecycle
+ hooks will fail in runtime when tcp handler
+ is specified.
properties:
host:
description: 'Optional: Host name to
@@ -31875,38 +32422,47 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
preStop:
- description: |-
- PreStop is called immediately before a container is terminated due to an
- API request or management event such as liveness/startup probe failure,
- preemption, resource contention, etc. The handler is not called if the
- container crashes or exits. The Pod's termination grace period countdown begins before the
- PreStop hook is executed. Regardless of the outcome of the handler, the
- container will eventually terminate within the Pod's termination grace
- period (unless delayed by finalizers). Other management of the container blocks until the hook completes
- or until the termination grace period is reached.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PreStop is called immediately
+ before a container is terminated due to an
+ API request or management event such as liveness/startup
+ probe failure, preemption, resource contention,
+ etc. The handler is not called if the container
+ crashes or exits. The Pod''s termination grace
+ period countdown begins before the PreStop
+ hook is executed. Regardless of the outcome
+ of the handler, the container will eventually
+ terminate within the Pod''s termination grace
+ period (unless delayed by finalizers). Other
+ management of the container blocks until the
+ hook completes or until the termination grace
+ period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to
take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command
+ line to execute inside the container,
+ the working directory for the command is
+ root ('/') in the container's filesystem.
+ The command is simply exec'd, it is
+ not run inside a shell, so traditional
+ shell instructions ('|', etc) won't
+ work. To use a shell, you need to
+ explicitly call out to that shell.
+ Exit status of 0 is treated as live/healthy
+ and non-zero is unhealthy.
items:
type: string
type: array
@@ -31916,9 +32472,10 @@ spec:
request to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to,
+ defaults to the pod IP. You probably
+ want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
description: Custom headers to set in
@@ -31930,9 +32487,11 @@ spec:
probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field
+ name. This will be canonicalized
+ upon output, so case-variant
+ names will be understood as
+ the same header.
type: string
value:
description: The header field
@@ -31951,15 +32510,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -31978,10 +32536,12 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT
+ supported as a LifecycleHandler and kept
+ for the backward compatibility. There
+ are no validation of this field and lifecycle
+ hooks will fail in runtime when tcp handler
+ is specified.
properties:
host:
description: 'Optional: Host name to
@@ -31991,10 +32551,10 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
@@ -32009,20 +32569,25 @@ spec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -32035,12 +32600,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -32050,8 +32614,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -32062,9 +32626,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -32082,35 +32647,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -32125,40 +32690,46 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
name:
- description: |-
- Name of the ephemeral container specified as a DNS_LABEL.
- This name must be unique among all containers, init containers and ephemeral containers.
+ description: Name of the ephemeral container specified
+ as a DNS_LABEL. This name must be unique among
+ all containers, init containers and ephemeral
+ containers.
type: string
ports:
description: Ports are not allowed for ephemeral
@@ -32168,9 +32739,9 @@ spec:
port in a single container.
properties:
containerPort:
- description: |-
- Number of port to expose on the pod's IP address.
- This must be a valid port number, 0 < x < 65536.
+ description: Number of port to expose on the
+ pod's IP address. This must be a valid port
+ number, 0 < x < 65536.
format: int32
type: integer
hostIP:
@@ -32178,24 +32749,24 @@ spec:
port to.
type: string
hostPort:
- description: |-
- Number of port to expose on the host.
- If specified, this must be a valid port number, 0 < x < 65536.
- If HostNetwork is specified, this must match ContainerPort.
+ description: Number of port to expose on the
+ host. If specified, this must be a valid
+ port number, 0 < x < 65536. If HostNetwork
+ is specified, this must match ContainerPort.
Most containers do not need this.
format: int32
type: integer
name:
- description: |-
- If specified, this must be an IANA_SVC_NAME and unique within the pod. Each
- named port in a pod must have a unique name. Name for the port that can be
- referred to by services.
+ description: If specified, this must be an
+ IANA_SVC_NAME and unique within the pod.
+ Each named port in a pod must have a unique
+ name. Name for the port that can be referred
+ to by services.
type: string
protocol:
default: TCP
- description: |-
- Protocol for port. Must be UDP, TCP, or SCTP.
- Defaults to "TCP".
+ description: Protocol for port. Must be UDP,
+ TCP, or SCTP. Defaults to "TCP".
type: string
required:
- containerPort
@@ -32213,20 +32784,25 @@ spec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -32239,12 +32815,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -32254,8 +32829,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -32266,9 +32841,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -32286,35 +32862,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -32329,33 +32905,38 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
@@ -32366,14 +32947,14 @@ spec:
resource resize policy for the container.
properties:
resourceName:
- description: |-
- Name of the resource to which this resource resize policy applies.
- Supported values: cpu, memory.
+ description: 'Name of the resource to which
+ this resource resize policy applies. Supported
+ values: cpu, memory.'
type: string
restartPolicy:
- description: |-
- Restart policy to apply when specified resource is resized.
- If not specified, it defaults to NotRequired.
+ description: Restart policy to apply when
+ specified resource is resized. If not specified,
+ it defaults to NotRequired.
type: string
required:
- resourceName
@@ -32382,30 +32963,27 @@ spec:
type: array
x-kubernetes-list-type: atomic
resources:
- description: |-
- Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources
+ description: Resources are not allowed for ephemeral
+ containers. Ephemeral containers use spare resources
already allocated to the pod.
properties:
claims:
- description: |-
- Claims lists the names of resources, defined in spec.resourceClaims,
- that are used by this container.
-
-
- This is an alpha field and requires enabling the
- DynamicResourceAllocation feature gate.
-
-
- This field is immutable. It can only be set for containers.
+ description: "Claims lists the names of resources,
+ defined in spec.resourceClaims, that are used
+ by this container. \n This is an alpha field
+ and requires enabling the DynamicResourceAllocation
+ feature gate. \n This field is immutable.
+ It can only be set for containers."
items:
description: ResourceClaim references one
entry in PodSpec.ResourceClaims.
properties:
name:
- description: |-
- Name must match the name of one entry in pod.spec.resourceClaims of
- the Pod where this field is used. It makes that resource available
- inside a container.
+ description: Name must match the name
+ of one entry in pod.spec.resourceClaims
+ of the Pod where this field is used.
+ It makes that resource available inside
+ a container.
type: string
required:
- name
@@ -32421,9 +32999,8 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Limits describes the maximum amount of compute resources allowed.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Limits describes the maximum amount
+ of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -32432,40 +33009,43 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Requests describes the minimum amount of compute resources required.
- If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
- otherwise to an implementation-defined value. Requests cannot exceed Limits.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Requests describes the minimum
+ amount of compute resources required. If Requests
+ is omitted for a container, it defaults to
+ Limits if that is explicitly specified, otherwise
+ to an implementation-defined value. Requests
+ cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
restartPolicy:
- description: |-
- Restart policy for the container to manage the restart behavior of each
- container within a pod.
- This may only be set for init containers. You cannot set this field on
- ephemeral containers.
+ description: Restart policy for the container to
+ manage the restart behavior of each container
+ within a pod. This may only be set for init containers.
+ You cannot set this field on ephemeral containers.
type: string
securityContext:
- description: |-
- Optional: SecurityContext defines the security options the ephemeral container should be run with.
- If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
+ description: 'Optional: SecurityContext defines
+ the security options the ephemeral container should
+ be run with. If set, the fields of SecurityContext
+ override the equivalent fields of PodSecurityContext.'
properties:
allowPrivilegeEscalation:
- description: |-
- AllowPrivilegeEscalation controls whether a process can gain more
- privileges than its parent process. This bool directly controls if
- the no_new_privs flag will be set on the container process.
- AllowPrivilegeEscalation is true always when the container is:
- 1) run as Privileged
- 2) has CAP_SYS_ADMIN
- Note that this field cannot be set when spec.os.name is windows.
+ description: 'AllowPrivilegeEscalation controls
+ whether a process can gain more privileges
+ than its parent process. This bool directly
+ controls if the no_new_privs flag will be
+ set on the container process. AllowPrivilegeEscalation
+ is true always when the container is: 1) run
+ as Privileged 2) has CAP_SYS_ADMIN Note that
+ this field cannot be set when spec.os.name
+ is windows.'
type: boolean
capabilities:
- description: |-
- The capabilities to add/drop when running containers.
- Defaults to the default set of capabilities granted by the container runtime.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The capabilities to add/drop when
+ running containers. Defaults to the default
+ set of capabilities granted by the container
+ runtime. Note that this field cannot be set
+ when spec.os.name is windows.
properties:
add:
description: Added capabilities
@@ -32483,60 +33063,69 @@ spec:
type: array
type: object
privileged:
- description: |-
- Run container in privileged mode.
- Processes in privileged containers are essentially equivalent to root on the host.
- Defaults to false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Run container in privileged mode.
+ Processes in privileged containers are essentially
+ equivalent to root on the host. Defaults to
+ false. Note that this field cannot be set
+ when spec.os.name is windows.
type: boolean
procMount:
- description: |-
- procMount denotes the type of proc mount to use for the containers.
- The default is DefaultProcMount which uses the container runtime defaults for
- readonly paths and masked paths.
- This requires the ProcMountType feature flag to be enabled.
- Note that this field cannot be set when spec.os.name is windows.
+ description: procMount denotes the type of proc
+ mount to use for the containers. The default
+ is DefaultProcMount which uses the container
+ runtime defaults for readonly paths and masked
+ paths. This requires the ProcMountType feature
+ flag to be enabled. Note that this field cannot
+ be set when spec.os.name is windows.
type: string
readOnlyRootFilesystem:
- description: |-
- Whether this container has a read-only root filesystem.
- Default is false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Whether this container has a read-only
+ root filesystem. Default is false. Note that
+ this field cannot be set when spec.os.name
+ is windows.
type: boolean
runAsGroup:
- description: |-
- The GID to run the entrypoint of the container process.
- Uses runtime default if unset.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The GID to run the entrypoint of
+ the container process. Uses runtime default
+ if unset. May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is windows.
format: int64
type: integer
runAsNonRoot:
- description: |-
- Indicates that the container must run as a non-root user.
- If true, the Kubelet will validate the image at runtime to ensure that it
- does not run as UID 0 (root) and fail to start the container if it does.
- If unset or false, no such validation will be performed.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: Indicates that the container must
+ run as a non-root user. If true, the Kubelet
+ will validate the image at runtime to ensure
+ that it does not run as UID 0 (root) and fail
+ to start the container if it does. If unset
+ or false, no such validation will be performed.
+ May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence.
type: boolean
runAsUser:
- description: |-
- The UID to run the entrypoint of the container process.
- Defaults to user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The UID to run the entrypoint of
+ the container process. Defaults to user specified
+ in image metadata if unspecified. May also
+ be set in PodSecurityContext. If set in both
+ SecurityContext and PodSecurityContext, the
+ value specified in SecurityContext takes precedence.
+ Note that this field cannot be set when spec.os.name
+ is windows.
format: int64
type: integer
seLinuxOptions:
- description: |-
- The SELinux context to be applied to the container.
- If unspecified, the container runtime will allocate a random SELinux context for each
- container. May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The SELinux context to be applied
+ to the container. If unspecified, the container
+ runtime will allocate a random SELinux context
+ for each container. May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is windows.
properties:
level:
description: Level is SELinux level label
@@ -32556,62 +33145,74 @@ spec:
type: string
type: object
seccompProfile:
- description: |-
- The seccomp options to use by this container. If seccomp options are
- provided at both the pod & container level, the container options
- override the pod options.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The seccomp options to use by this
+ container. If seccomp options are provided
+ at both the pod & container level, the container
+ options override the pod options. Note that
+ this field cannot be set when spec.os.name
+ is windows.
properties:
localhostProfile:
- description: |-
- localhostProfile indicates a profile defined in a file on the node should be used.
- The profile must be preconfigured on the node to work.
- Must be a descending path, relative to the kubelet's configured seccomp profile location.
- Must be set if type is "Localhost". Must NOT be set for any other type.
+ description: localhostProfile indicates
+ a profile defined in a file on the node
+ should be used. The profile must be preconfigured
+ on the node to work. Must be a descending
+ path, relative to the kubelet's configured
+ seccomp profile location. Must be set
+ if type is "Localhost". Must NOT be set
+ for any other type.
type: string
type:
- description: |-
- type indicates which kind of seccomp profile will be applied.
- Valid options are:
-
-
- Localhost - a profile defined in a file on the node should be used.
- RuntimeDefault - the container runtime default profile should be used.
- Unconfined - no profile should be applied.
+ description: "type indicates which kind
+ of seccomp profile will be applied. Valid
+ options are: \n Localhost - a profile
+ defined in a file on the node should be
+ used. RuntimeDefault - the container runtime
+ default profile should be used. Unconfined
+ - no profile should be applied."
type: string
required:
- type
type: object
windowsOptions:
- description: |-
- The Windows specific settings applied to all containers.
- If unspecified, the options from the PodSecurityContext will be used.
- If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is linux.
+ description: The Windows specific settings applied
+ to all containers. If unspecified, the options
+ from the PodSecurityContext will be used.
+ If set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is linux.
properties:
gmsaCredentialSpec:
- description: |-
- GMSACredentialSpec is where the GMSA admission webhook
- (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
- GMSA credential spec named by the GMSACredentialSpecName field.
+ description: GMSACredentialSpec is where
+ the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa)
+ inlines the contents of the GMSA credential
+ spec named by the GMSACredentialSpecName
+ field.
type: string
gmsaCredentialSpecName:
description: GMSACredentialSpecName is the
name of the GMSA credential spec to use.
type: string
hostProcess:
- description: |-
- HostProcess determines if a container should be run as a 'Host Process' container.
- All of a Pod's containers must have the same effective HostProcess value
- (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
- In addition, if HostProcess is true then HostNetwork must also be set to true.
+ description: HostProcess determines if a
+ container should be run as a 'Host Process'
+ container. All of a Pod's containers must
+ have the same effective HostProcess value
+ (it is not allowed to have a mix of HostProcess
+ containers and non-HostProcess containers).
+ In addition, if HostProcess is true then
+ HostNetwork must also be set to true.
type: boolean
runAsUserName:
- description: |-
- The UserName in Windows to run the entrypoint of the container process.
- Defaults to the user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: The UserName in Windows to
+ run the entrypoint of the container process.
+ Defaults to the user specified in image
+ metadata if unspecified. May also be set
+ in PodSecurityContext. If set in both
+ SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext
+ takes precedence.
type: string
type: object
type: object
@@ -32623,20 +33224,25 @@ spec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -32649,12 +33255,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -32664,8 +33269,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -32676,9 +33281,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -32696,35 +33302,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -32739,86 +33345,98 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
stdin:
- description: |-
- Whether this container should allocate a buffer for stdin in the container runtime. If this
- is not set, reads from stdin in the container will always result in EOF.
- Default is false.
+ description: Whether this container should allocate
+ a buffer for stdin in the container runtime. If
+ this is not set, reads from stdin in the container
+ will always result in EOF. Default is false.
type: boolean
stdinOnce:
- description: |-
- Whether the container runtime should close the stdin channel after it has been opened by
- a single attach. When stdin is true the stdin stream will remain open across multiple attach
- sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
- first client attaches to stdin, and then remains open and accepts data until the client disconnects,
- at which time stdin is closed and remains closed until the container is restarted. If this
- flag is false, a container processes that reads from stdin will never receive an EOF.
- Default is false
+ description: Whether the container runtime should
+ close the stdin channel after it has been opened
+ by a single attach. When stdin is true the stdin
+ stream will remain open across multiple attach
+ sessions. If stdinOnce is set to true, stdin is
+ opened on container start, is empty until the
+ first client attaches to stdin, and then remains
+ open and accepts data until the client disconnects,
+ at which time stdin is closed and remains closed
+ until the container is restarted. If this flag
+ is false, a container processes that reads from
+ stdin will never receive an EOF. Default is false
type: boolean
targetContainerName:
- description: |-
- If set, the name of the container from PodSpec that this ephemeral container targets.
- The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container.
- If not set then the ephemeral container uses the namespaces configured in the Pod spec.
-
-
- The container runtime must implement support for this feature. If the runtime does not
- support namespace targeting then the result of setting this field is undefined.
+ description: "If set, the name of the container
+ from PodSpec that this ephemeral container targets.
+ The ephemeral container will be run in the namespaces
+ (IPC, PID, etc) of this container. If not set
+ then the ephemeral container uses the namespaces
+ configured in the Pod spec. \n The container runtime
+ must implement support for this feature. If the
+ runtime does not support namespace targeting then
+ the result of setting this field is undefined."
type: string
terminationMessagePath:
- description: |-
- Optional: Path at which the file to which the container's termination message
- will be written is mounted into the container's filesystem.
- Message written is intended to be brief final status, such as an assertion failure message.
- Will be truncated by the node if greater than 4096 bytes. The total message length across
- all containers will be limited to 12kb.
- Defaults to /dev/termination-log.
- Cannot be updated.
+ description: 'Optional: Path at which the file to
+ which the container''s termination message will
+ be written is mounted into the container''s filesystem.
+ Message written is intended to be brief final
+ status, such as an assertion failure message.
+ Will be truncated by the node if greater than
+ 4096 bytes. The total message length across all
+ containers will be limited to 12kb. Defaults to
+ /dev/termination-log. Cannot be updated.'
type: string
terminationMessagePolicy:
- description: |-
- Indicate how the termination message should be populated. File will use the contents of
- terminationMessagePath to populate the container status message on both success and failure.
- FallbackToLogsOnError will use the last chunk of container log output if the termination
- message file is empty and the container exited with an error.
- The log output is limited to 2048 bytes or 80 lines, whichever is smaller.
- Defaults to File.
- Cannot be updated.
+ description: Indicate how the termination message
+ should be populated. File will use the contents
+ of terminationMessagePath to populate the container
+ status message on both success and failure. FallbackToLogsOnError
+ will use the last chunk of container log output
+ if the termination message file is empty and the
+ container exited with an error. The log output
+ is limited to 2048 bytes or 80 lines, whichever
+ is smaller. Defaults to File. Cannot be updated.
type: string
tty:
- description: |-
- Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
- Default is false.
+ description: Whether this container should allocate
+ a TTY for itself, also requires 'stdin' to be
+ true. Default is false.
type: boolean
volumeDevices:
description: volumeDevices is the list of block
@@ -32842,45 +33460,47 @@ spec:
type: object
type: array
volumeMounts:
- description: |-
- Pod volumes to mount into the container's filesystem. Subpath mounts are not allowed for ephemeral containers.
- Cannot be updated.
+ description: Pod volumes to mount into the container's
+ filesystem. Subpath mounts are not allowed for
+ ephemeral containers. Cannot be updated.
items:
description: VolumeMount describes a mounting
of a Volume within a container.
properties:
mountPath:
- description: |-
- Path within the container at which the volume should be mounted. Must
+ description: Path within the container at
+ which the volume should be mounted. Must
not contain ':'.
type: string
mountPropagation:
- description: |-
- mountPropagation determines how mounts are propagated from the host
- to container and the other way around.
- When not set, MountPropagationNone is used.
- This field is beta in 1.10.
+ description: mountPropagation determines how
+ mounts are propagated from the host to container
+ and the other way around. When not set,
+ MountPropagationNone is used. This field
+ is beta in 1.10.
type: string
name:
description: This must match the Name of a
Volume.
type: string
readOnly:
- description: |-
- Mounted read-only if true, read-write otherwise (false or unspecified).
- Defaults to false.
+ description: Mounted read-only if true, read-write
+ otherwise (false or unspecified). Defaults
+ to false.
type: boolean
subPath:
- description: |-
- Path within the volume from which the container's volume should be mounted.
+ description: Path within the volume from which
+ the container's volume should be mounted.
Defaults to "" (volume's root).
type: string
subPathExpr:
- description: |-
- Expanded path within the volume from which the container's volume should be mounted.
- Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.
- Defaults to "" (volume's root).
- SubPathExpr and SubPath are mutually exclusive.
+ description: Expanded path within the volume
+ from which the container's volume should
+ be mounted. Behaves similarly to SubPath
+ but environment variable references $(VAR_NAME)
+ are expanded using the container's environment.
+ Defaults to "" (volume's root). SubPathExpr
+ and SubPath are mutually exclusive.
type: string
required:
- mountPath
@@ -32888,11 +33508,10 @@ spec:
type: object
type: array
workingDir:
- description: |-
- Container's working directory.
- If not specified, the container runtime's default will be used, which
- might be configured in the container image.
- Cannot be updated.
+ description: Container's working directory. If not
+ specified, the container runtime's default will
+ be used, which might be configured in the container
+ image. Cannot be updated.
type: string
required:
- name
@@ -32905,35 +33524,39 @@ spec:
want to run within a pod.
properties:
args:
- description: |-
- Arguments to the entrypoint.
- The container image's CMD is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Arguments to the entrypoint. The container
+ image''s CMD is used if this is not provided.
+ Variable references $(VAR_NAME) are expanded using
+ the container''s environment. If a variable cannot
+ be resolved, the reference in the input string
+ will be unchanged. Double $$ are reduced to a
+ single $, which allows for escaping the $(VAR_NAME)
+ syntax: i.e. "$$(VAR_NAME)" will produce the string
+ literal "$(VAR_NAME)". Escaped references will
+ never be expanded, regardless of whether the variable
+ exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
command:
- description: |-
- Entrypoint array. Not executed within a shell.
- The container image's ENTRYPOINT is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Entrypoint array. Not executed within
+ a shell. The container image''s ENTRYPOINT is
+ used if this is not provided. Variable references
+ $(VAR_NAME) are expanded using the container''s
+ environment. If a variable cannot be resolved,
+ the reference in the input string will be unchanged.
+ Double $$ are reduced to a single $, which allows
+ for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)"
+ will produce the string literal "$(VAR_NAME)".
+ Escaped references will never be expanded, regardless
+ of whether the variable exists or not. Cannot
+ be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
env:
- description: |-
- List of environment variables to set in the container.
- Cannot be updated.
+ description: List of environment variables to set
+ in the container. Cannot be updated.
items:
description: EnvVar represents an environment
variable present in a Container.
@@ -32943,16 +33566,18 @@ spec:
Must be a C_IDENTIFIER.
type: string
value:
- description: |-
- Variable references $(VAR_NAME) are expanded
- using the previously defined environment variables in the container and
- any service environment variables. If a variable cannot be resolved,
- the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
- "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
- Escaped references will never be expanded, regardless of whether the variable
- exists or not.
- Defaults to "".
+ description: 'Variable references $(VAR_NAME)
+ are expanded using the previously defined
+ environment variables in the container and
+ any service environment variables. If a
+ variable cannot be resolved, the reference
+ in the input string will be unchanged. Double
+ $$ are reduced to a single $, which allows
+ for escaping the $(VAR_NAME) syntax: i.e.
+ "$$(VAR_NAME)" will produce the string literal
+ "$(VAR_NAME)". Escaped references will never
+ be expanded, regardless of whether the variable
+ exists or not. Defaults to "".'
type: string
valueFrom:
description: Source for the environment variable's
@@ -32965,10 +33590,10 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
+ description: 'Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
@@ -32977,11 +33602,12 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
fieldRef:
- description: |-
- Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`,
- spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ description: 'Selects a field of the pod:
+ supports metadata.name, metadata.namespace,
+ `metadata.labels['''']`, `metadata.annotations['''']`,
+ spec.nodeName, spec.serviceAccountName,
+ status.hostIP, status.podIP, status.podIPs.'
properties:
apiVersion:
description: Version of the schema
@@ -32995,11 +33621,13 @@ spec:
required:
- fieldPath
type: object
- x-kubernetes-map-type: atomic
resourceFieldRef:
- description: |-
- Selects a resource of the container: only resources limits and requests
- (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
+ description: 'Selects a resource of the
+ container: only resources limits and
+ requests (limits.cpu, limits.memory,
+ limits.ephemeral-storage, requests.cpu,
+ requests.memory and requests.ephemeral-storage)
+ are currently supported.'
properties:
containerName:
description: 'Container name: required
@@ -33021,7 +33649,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret
in the pod's namespace
@@ -33032,10 +33659,10 @@ spec:
secret key.
type: string
name:
- description: |-
- Name of the referent.
+ description: 'Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret
@@ -33044,20 +33671,21 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
required:
- name
type: object
type: array
envFrom:
- description: |-
- List of sources to populate environment variables in the container.
- The keys defined within a source must be a C_IDENTIFIER. All invalid keys
- will be reported as an event when the container is starting. When a key exists in multiple
- sources, the value associated with the last source will take precedence.
- Values defined by an Env with a duplicate key will take precedence.
- Cannot be updated.
+ description: List of sources to populate environment
+ variables in the container. The keys defined within
+ a source must be a C_IDENTIFIER. All invalid keys
+ will be reported as an event when the container
+ is starting. When a key exists in multiple sources,
+ the value associated with the last source will
+ take precedence. Values defined by an Env with
+ a duplicate key will take precedence. Cannot be
+ updated.
items:
description: EnvFromSource represents the source
of a set of ConfigMaps
@@ -33066,17 +33694,16 @@ spec:
description: The ConfigMap to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
prefix:
description: An optional identifier to prepend
to each key in the ConfigMap. Must be a
@@ -33086,57 +33713,59 @@ spec:
description: The Secret to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret
must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
image:
- description: |-
- Container image name.
- More info: https://kubernetes.io/docs/concepts/containers/images
- This field is optional to allow higher level config management to default or override
- container images in workload controllers like Deployments and StatefulSets.
+ description: 'Container image name. More info: https://kubernetes.io/docs/concepts/containers/images
+ This field is optional to allow higher level config
+ management to default or override container images
+ in workload controllers like Deployments and StatefulSets.'
type: string
imagePullPolicy:
- description: |-
- Image pull policy.
- One of Always, Never, IfNotPresent.
- Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
+ description: 'Image pull policy. One of Always,
+ Never, IfNotPresent. Defaults to Always if :latest
+ tag is specified, or IfNotPresent otherwise. Cannot
+ be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
- description: |-
- Actions that the management system should take in response to container lifecycle events.
- Cannot be updated.
+ description: Actions that the management system
+ should take in response to container lifecycle
+ events. Cannot be updated.
properties:
postStart:
- description: |-
- PostStart is called immediately after a container is created. If the handler fails,
- the container is terminated and restarted according to its restart policy.
- Other management of the container blocks until the hook completes.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PostStart is called immediately
+ after a container is created. If the handler
+ fails, the container is terminated and restarted
+ according to its restart policy. Other management
+ of the container blocks until the hook completes.
+ More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to
take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command
+ line to execute inside the container,
+ the working directory for the command is
+ root ('/') in the container's filesystem.
+ The command is simply exec'd, it is
+ not run inside a shell, so traditional
+ shell instructions ('|', etc) won't
+ work. To use a shell, you need to
+ explicitly call out to that shell.
+ Exit status of 0 is treated as live/healthy
+ and non-zero is unhealthy.
items:
type: string
type: array
@@ -33146,9 +33775,10 @@ spec:
request to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to,
+ defaults to the pod IP. You probably
+ want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
description: Custom headers to set in
@@ -33160,9 +33790,11 @@ spec:
probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field
+ name. This will be canonicalized
+ upon output, so case-variant
+ names will be understood as
+ the same header.
type: string
value:
description: The header field
@@ -33181,15 +33813,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -33208,10 +33839,12 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT
+ supported as a LifecycleHandler and kept
+ for the backward compatibility. There
+ are no validation of this field and lifecycle
+ hooks will fail in runtime when tcp handler
+ is specified.
properties:
host:
description: 'Optional: Host name to
@@ -33221,38 +33854,47 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
preStop:
- description: |-
- PreStop is called immediately before a container is terminated due to an
- API request or management event such as liveness/startup probe failure,
- preemption, resource contention, etc. The handler is not called if the
- container crashes or exits. The Pod's termination grace period countdown begins before the
- PreStop hook is executed. Regardless of the outcome of the handler, the
- container will eventually terminate within the Pod's termination grace
- period (unless delayed by finalizers). Other management of the container blocks until the hook completes
- or until the termination grace period is reached.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PreStop is called immediately
+ before a container is terminated due to an
+ API request or management event such as liveness/startup
+ probe failure, preemption, resource contention,
+ etc. The handler is not called if the container
+ crashes or exits. The Pod''s termination grace
+ period countdown begins before the PreStop
+ hook is executed. Regardless of the outcome
+ of the handler, the container will eventually
+ terminate within the Pod''s termination grace
+ period (unless delayed by finalizers). Other
+ management of the container blocks until the
+ hook completes or until the termination grace
+ period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to
take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command
+ line to execute inside the container,
+ the working directory for the command is
+ root ('/') in the container's filesystem.
+ The command is simply exec'd, it is
+ not run inside a shell, so traditional
+ shell instructions ('|', etc) won't
+ work. To use a shell, you need to
+ explicitly call out to that shell.
+ Exit status of 0 is treated as live/healthy
+ and non-zero is unhealthy.
items:
type: string
type: array
@@ -33262,9 +33904,10 @@ spec:
request to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to,
+ defaults to the pod IP. You probably
+ want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
description: Custom headers to set in
@@ -33276,9 +33919,11 @@ spec:
probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field
+ name. This will be canonicalized
+ upon output, so case-variant
+ names will be understood as
+ the same header.
type: string
value:
description: The header field
@@ -33297,15 +33942,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -33324,10 +33968,12 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT
+ supported as a LifecycleHandler and kept
+ for the backward compatibility. There
+ are no validation of this field and lifecycle
+ hooks will fail in runtime when tcp handler
+ is specified.
properties:
host:
description: 'Optional: Host name to
@@ -33337,10 +33983,10 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
@@ -33348,30 +33994,33 @@ spec:
type: object
type: object
livenessProbe:
- description: |-
- Periodic probe of container liveness.
+ 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
+ Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -33384,12 +34033,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -33399,8 +34047,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -33411,9 +34059,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -33431,35 +34080,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -33474,59 +34123,63 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
name:
- description: |-
- Name of the container specified as a DNS_LABEL.
- Each container in a pod must have a unique name (DNS_LABEL).
- Cannot be updated.
+ description: Name of the container specified as
+ a DNS_LABEL. Each container in a pod must have
+ a unique name (DNS_LABEL). Cannot be updated.
type: string
ports:
- description: |-
- List of ports to expose from the container. Not specifying a port here
- DOES NOT prevent that port from being exposed. Any port which is
- listening on the default "0.0.0.0" address inside a container will be
- accessible from the network.
- Modifying this array with strategic merge patch may corrupt the data.
- For more information See https://github.com/kubernetes/kubernetes/issues/108255.
+ description: List of ports to expose from the container.
+ Not specifying a port here DOES NOT prevent that
+ port from being exposed. Any port which is listening
+ on the default "0.0.0.0" address inside a container
+ will be accessible from the network. Modifying
+ this array with strategic merge patch may corrupt
+ the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255.
Cannot be updated.
items:
description: ContainerPort represents a network
port in a single container.
properties:
containerPort:
- description: |-
- Number of port to expose on the pod's IP address.
- This must be a valid port number, 0 < x < 65536.
+ description: Number of port to expose on the
+ pod's IP address. This must be a valid port
+ number, 0 < x < 65536.
format: int32
type: integer
hostIP:
@@ -33534,24 +34187,24 @@ spec:
port to.
type: string
hostPort:
- description: |-
- Number of port to expose on the host.
- If specified, this must be a valid port number, 0 < x < 65536.
- If HostNetwork is specified, this must match ContainerPort.
+ description: Number of port to expose on the
+ host. If specified, this must be a valid
+ port number, 0 < x < 65536. If HostNetwork
+ is specified, this must match ContainerPort.
Most containers do not need this.
format: int32
type: integer
name:
- description: |-
- If specified, this must be an IANA_SVC_NAME and unique within the pod. Each
- named port in a pod must have a unique name. Name for the port that can be
- referred to by services.
+ description: If specified, this must be an
+ IANA_SVC_NAME and unique within the pod.
+ Each named port in a pod must have a unique
+ name. Name for the port that can be referred
+ to by services.
type: string
protocol:
default: TCP
- description: |-
- Protocol for port. Must be UDP, TCP, or SCTP.
- Defaults to "TCP".
+ description: Protocol for port. Must be UDP,
+ TCP, or SCTP. Defaults to "TCP".
type: string
required:
- containerPort
@@ -33562,30 +34215,34 @@ spec:
- protocol
x-kubernetes-list-type: map
readinessProbe:
- description: |-
- Periodic probe of container service readiness.
- Container will be removed from service endpoints if the probe fails.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Periodic probe of container service
+ readiness. Container will be removed from service
+ endpoints if the probe fails. Cannot be updated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -33598,12 +34255,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -33613,8 +34269,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -33625,9 +34281,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -33645,35 +34302,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -33688,33 +34345,38 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
@@ -33725,14 +34387,14 @@ spec:
resource resize policy for the container.
properties:
resourceName:
- description: |-
- Name of the resource to which this resource resize policy applies.
- Supported values: cpu, memory.
+ description: 'Name of the resource to which
+ this resource resize policy applies. Supported
+ values: cpu, memory.'
type: string
restartPolicy:
- description: |-
- Restart policy to apply when specified resource is resized.
- If not specified, it defaults to NotRequired.
+ description: Restart policy to apply when
+ specified resource is resized. If not specified,
+ it defaults to NotRequired.
type: string
required:
- resourceName
@@ -33741,31 +34403,26 @@ spec:
type: array
x-kubernetes-list-type: atomic
resources:
- description: |-
- Compute Resources required by this container.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Compute Resources required by this
+ container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
properties:
claims:
- description: |-
- Claims lists the names of resources, defined in spec.resourceClaims,
- that are used by this container.
-
-
- This is an alpha field and requires enabling the
- DynamicResourceAllocation feature gate.
-
-
- This field is immutable. It can only be set for containers.
+ description: "Claims lists the names of resources,
+ defined in spec.resourceClaims, that are used
+ by this container. \n This is an alpha field
+ and requires enabling the DynamicResourceAllocation
+ feature gate. \n This field is immutable.
+ It can only be set for containers."
items:
description: ResourceClaim references one
entry in PodSpec.ResourceClaims.
properties:
name:
- description: |-
- Name must match the name of one entry in pod.spec.resourceClaims of
- the Pod where this field is used. It makes that resource available
- inside a container.
+ description: Name must match the name
+ of one entry in pod.spec.resourceClaims
+ of the Pod where this field is used.
+ It makes that resource available inside
+ a container.
type: string
required:
- name
@@ -33781,9 +34438,8 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Limits describes the maximum amount of compute resources allowed.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Limits describes the maximum amount
+ of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -33792,52 +34448,61 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Requests describes the minimum amount of compute resources required.
- If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
- otherwise to an implementation-defined value. Requests cannot exceed Limits.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Requests describes the minimum
+ amount of compute resources required. If Requests
+ is omitted for a container, it defaults to
+ Limits if that is explicitly specified, otherwise
+ to an implementation-defined value. Requests
+ cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
restartPolicy:
- description: |-
- RestartPolicy defines the restart behavior of individual containers in a pod.
- This field may only be set for init containers, and the only allowed value is "Always".
- For non-init containers or when this field is not specified,
- the restart behavior is defined by the Pod's restart policy and the container type.
- Setting the RestartPolicy as "Always" for the init container will have the following effect:
- this init container will be continually restarted on
- exit until all regular containers have terminated. Once all regular
- containers have completed, all init containers with restartPolicy "Always"
- will be shut down. This lifecycle differs from normal init containers and
- is often referred to as a "sidecar" container. Although this init
- container still starts in the init container sequence, it does not wait
- for the container to complete before proceeding to the next init
- container. Instead, the next init container starts immediately after this
- init container is started, or after any startupProbe has successfully
- completed.
+ description: 'RestartPolicy defines the restart
+ behavior of individual containers in a pod. This
+ field may only be set for init containers, and
+ the only allowed value is "Always". For non-init
+ containers or when this field is not specified,
+ the restart behavior is defined by the Pod''s
+ restart policy and the container type. Setting
+ the RestartPolicy as "Always" for the init container
+ will have the following effect: this init container
+ will be continually restarted on exit until all
+ regular containers have terminated. Once all regular
+ containers have completed, all init containers
+ with restartPolicy "Always" will be shut down.
+ This lifecycle differs from normal init containers
+ and is often referred to as a "sidecar" container.
+ Although this init container still starts in the
+ init container sequence, it does not wait for
+ the container to complete before proceeding to
+ the next init container. Instead, the next init
+ container starts immediately after this init container
+ is started, or after any startupProbe has successfully
+ completed.'
type: string
securityContext:
- description: |-
- SecurityContext defines the security options the container should be run with.
- If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
- More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
+ description: 'SecurityContext defines the security
+ options the container should be run with. If set,
+ the fields of SecurityContext override the equivalent
+ fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
properties:
allowPrivilegeEscalation:
- description: |-
- AllowPrivilegeEscalation controls whether a process can gain more
- privileges than its parent process. This bool directly controls if
- the no_new_privs flag will be set on the container process.
- AllowPrivilegeEscalation is true always when the container is:
- 1) run as Privileged
- 2) has CAP_SYS_ADMIN
- Note that this field cannot be set when spec.os.name is windows.
+ description: 'AllowPrivilegeEscalation controls
+ whether a process can gain more privileges
+ than its parent process. This bool directly
+ controls if the no_new_privs flag will be
+ set on the container process. AllowPrivilegeEscalation
+ is true always when the container is: 1) run
+ as Privileged 2) has CAP_SYS_ADMIN Note that
+ this field cannot be set when spec.os.name
+ is windows.'
type: boolean
capabilities:
- description: |-
- The capabilities to add/drop when running containers.
- Defaults to the default set of capabilities granted by the container runtime.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The capabilities to add/drop when
+ running containers. Defaults to the default
+ set of capabilities granted by the container
+ runtime. Note that this field cannot be set
+ when spec.os.name is windows.
properties:
add:
description: Added capabilities
@@ -33855,60 +34520,69 @@ spec:
type: array
type: object
privileged:
- description: |-
- Run container in privileged mode.
- Processes in privileged containers are essentially equivalent to root on the host.
- Defaults to false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Run container in privileged mode.
+ Processes in privileged containers are essentially
+ equivalent to root on the host. Defaults to
+ false. Note that this field cannot be set
+ when spec.os.name is windows.
type: boolean
procMount:
- description: |-
- procMount denotes the type of proc mount to use for the containers.
- The default is DefaultProcMount which uses the container runtime defaults for
- readonly paths and masked paths.
- This requires the ProcMountType feature flag to be enabled.
- Note that this field cannot be set when spec.os.name is windows.
+ description: procMount denotes the type of proc
+ mount to use for the containers. The default
+ is DefaultProcMount which uses the container
+ runtime defaults for readonly paths and masked
+ paths. This requires the ProcMountType feature
+ flag to be enabled. Note that this field cannot
+ be set when spec.os.name is windows.
type: string
readOnlyRootFilesystem:
- description: |-
- Whether this container has a read-only root filesystem.
- Default is false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Whether this container has a read-only
+ root filesystem. Default is false. Note that
+ this field cannot be set when spec.os.name
+ is windows.
type: boolean
runAsGroup:
- description: |-
- The GID to run the entrypoint of the container process.
- Uses runtime default if unset.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The GID to run the entrypoint of
+ the container process. Uses runtime default
+ if unset. May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is windows.
format: int64
type: integer
runAsNonRoot:
- description: |-
- Indicates that the container must run as a non-root user.
- If true, the Kubelet will validate the image at runtime to ensure that it
- does not run as UID 0 (root) and fail to start the container if it does.
- If unset or false, no such validation will be performed.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: Indicates that the container must
+ run as a non-root user. If true, the Kubelet
+ will validate the image at runtime to ensure
+ that it does not run as UID 0 (root) and fail
+ to start the container if it does. If unset
+ or false, no such validation will be performed.
+ May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence.
type: boolean
runAsUser:
- description: |-
- The UID to run the entrypoint of the container process.
- Defaults to user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The UID to run the entrypoint of
+ the container process. Defaults to user specified
+ in image metadata if unspecified. May also
+ be set in PodSecurityContext. If set in both
+ SecurityContext and PodSecurityContext, the
+ value specified in SecurityContext takes precedence.
+ Note that this field cannot be set when spec.os.name
+ is windows.
format: int64
type: integer
seLinuxOptions:
- description: |-
- The SELinux context to be applied to the container.
- If unspecified, the container runtime will allocate a random SELinux context for each
- container. May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The SELinux context to be applied
+ to the container. If unspecified, the container
+ runtime will allocate a random SELinux context
+ for each container. May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is windows.
properties:
level:
description: Level is SELinux level label
@@ -33928,93 +34602,112 @@ spec:
type: string
type: object
seccompProfile:
- description: |-
- The seccomp options to use by this container. If seccomp options are
- provided at both the pod & container level, the container options
- override the pod options.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The seccomp options to use by this
+ container. If seccomp options are provided
+ at both the pod & container level, the container
+ options override the pod options. Note that
+ this field cannot be set when spec.os.name
+ is windows.
properties:
localhostProfile:
- description: |-
- localhostProfile indicates a profile defined in a file on the node should be used.
- The profile must be preconfigured on the node to work.
- Must be a descending path, relative to the kubelet's configured seccomp profile location.
- Must be set if type is "Localhost". Must NOT be set for any other type.
+ description: localhostProfile indicates
+ a profile defined in a file on the node
+ should be used. The profile must be preconfigured
+ on the node to work. Must be a descending
+ path, relative to the kubelet's configured
+ seccomp profile location. Must be set
+ if type is "Localhost". Must NOT be set
+ for any other type.
type: string
type:
- description: |-
- type indicates which kind of seccomp profile will be applied.
- Valid options are:
-
-
- Localhost - a profile defined in a file on the node should be used.
- RuntimeDefault - the container runtime default profile should be used.
- Unconfined - no profile should be applied.
+ description: "type indicates which kind
+ of seccomp profile will be applied. Valid
+ options are: \n Localhost - a profile
+ defined in a file on the node should be
+ used. RuntimeDefault - the container runtime
+ default profile should be used. Unconfined
+ - no profile should be applied."
type: string
required:
- type
type: object
windowsOptions:
- description: |-
- The Windows specific settings applied to all containers.
- If unspecified, the options from the PodSecurityContext will be used.
- If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is linux.
+ description: The Windows specific settings applied
+ to all containers. If unspecified, the options
+ from the PodSecurityContext will be used.
+ If set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is linux.
properties:
gmsaCredentialSpec:
- description: |-
- GMSACredentialSpec is where the GMSA admission webhook
- (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
- GMSA credential spec named by the GMSACredentialSpecName field.
+ description: GMSACredentialSpec is where
+ the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa)
+ inlines the contents of the GMSA credential
+ spec named by the GMSACredentialSpecName
+ field.
type: string
gmsaCredentialSpecName:
description: GMSACredentialSpecName is the
name of the GMSA credential spec to use.
type: string
hostProcess:
- description: |-
- HostProcess determines if a container should be run as a 'Host Process' container.
- All of a Pod's containers must have the same effective HostProcess value
- (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
- In addition, if HostProcess is true then HostNetwork must also be set to true.
+ description: HostProcess determines if a
+ container should be run as a 'Host Process'
+ container. All of a Pod's containers must
+ have the same effective HostProcess value
+ (it is not allowed to have a mix of HostProcess
+ containers and non-HostProcess containers).
+ In addition, if HostProcess is true then
+ HostNetwork must also be set to true.
type: boolean
runAsUserName:
- description: |-
- The UserName in Windows to run the entrypoint of the container process.
- Defaults to the user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: The UserName in Windows to
+ run the entrypoint of the container process.
+ Defaults to the user specified in image
+ metadata if unspecified. May also be set
+ in PodSecurityContext. If set in both
+ SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext
+ takes precedence.
type: string
type: object
type: object
startupProbe:
- description: |-
- StartupProbe indicates that the Pod has successfully initialized.
- If specified, no other probes are executed until this completes successfully.
- If this probe fails, the Pod will be restarted, just as if the livenessProbe failed.
- This can be used to provide different probe parameters at the beginning of a Pod's lifecycle,
- when it might take a long time to load data or warm a cache, than during steady-state operation.
- This cannot be updated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'StartupProbe indicates that the Pod
+ has successfully initialized. If specified, no
+ other probes are executed until this completes
+ successfully. If this probe fails, the Pod will
+ be restarted, just as if the livenessProbe failed.
+ This can be used to provide different probe parameters
+ at the beginning of a Pod''s lifecycle, when it
+ might take a long time to load data or warm a
+ cache, than during steady-state operation. This
+ cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -34027,12 +34720,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -34042,8 +34734,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -34054,9 +34746,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -34074,35 +34767,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -34117,76 +34810,87 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
stdin:
- description: |-
- Whether this container should allocate a buffer for stdin in the container runtime. If this
- is not set, reads from stdin in the container will always result in EOF.
- Default is false.
+ description: Whether this container should allocate
+ a buffer for stdin in the container runtime. If
+ this is not set, reads from stdin in the container
+ will always result in EOF. Default is false.
type: boolean
stdinOnce:
- description: |-
- Whether the container runtime should close the stdin channel after it has been opened by
- a single attach. When stdin is true the stdin stream will remain open across multiple attach
- sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
- first client attaches to stdin, and then remains open and accepts data until the client disconnects,
- at which time stdin is closed and remains closed until the container is restarted. If this
- flag is false, a container processes that reads from stdin will never receive an EOF.
- Default is false
+ description: Whether the container runtime should
+ close the stdin channel after it has been opened
+ by a single attach. When stdin is true the stdin
+ stream will remain open across multiple attach
+ sessions. If stdinOnce is set to true, stdin is
+ opened on container start, is empty until the
+ first client attaches to stdin, and then remains
+ open and accepts data until the client disconnects,
+ at which time stdin is closed and remains closed
+ until the container is restarted. If this flag
+ is false, a container processes that reads from
+ stdin will never receive an EOF. Default is false
type: boolean
terminationMessagePath:
- description: |-
- Optional: Path at which the file to which the container's termination message
- will be written is mounted into the container's filesystem.
- Message written is intended to be brief final status, such as an assertion failure message.
- Will be truncated by the node if greater than 4096 bytes. The total message length across
- all containers will be limited to 12kb.
- Defaults to /dev/termination-log.
- Cannot be updated.
+ description: 'Optional: Path at which the file to
+ which the container''s termination message will
+ be written is mounted into the container''s filesystem.
+ Message written is intended to be brief final
+ status, such as an assertion failure message.
+ Will be truncated by the node if greater than
+ 4096 bytes. The total message length across all
+ containers will be limited to 12kb. Defaults to
+ /dev/termination-log. Cannot be updated.'
type: string
terminationMessagePolicy:
- description: |-
- Indicate how the termination message should be populated. File will use the contents of
- terminationMessagePath to populate the container status message on both success and failure.
- FallbackToLogsOnError will use the last chunk of container log output if the termination
- message file is empty and the container exited with an error.
- The log output is limited to 2048 bytes or 80 lines, whichever is smaller.
- Defaults to File.
- Cannot be updated.
+ description: Indicate how the termination message
+ should be populated. File will use the contents
+ of terminationMessagePath to populate the container
+ status message on both success and failure. FallbackToLogsOnError
+ will use the last chunk of container log output
+ if the termination message file is empty and the
+ container exited with an error. The log output
+ is limited to 2048 bytes or 80 lines, whichever
+ is smaller. Defaults to File. Cannot be updated.
type: string
tty:
- description: |-
- Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
- Default is false.
+ description: Whether this container should allocate
+ a TTY for itself, also requires 'stdin' to be
+ true. Default is false.
type: boolean
volumeDevices:
description: volumeDevices is the list of block
@@ -34210,45 +34914,46 @@ spec:
type: object
type: array
volumeMounts:
- description: |-
- Pod volumes to mount into the container's filesystem.
- Cannot be updated.
+ description: Pod volumes to mount into the container's
+ filesystem. Cannot be updated.
items:
description: VolumeMount describes a mounting
of a Volume within a container.
properties:
mountPath:
- description: |-
- Path within the container at which the volume should be mounted. Must
+ description: Path within the container at
+ which the volume should be mounted. Must
not contain ':'.
type: string
mountPropagation:
- description: |-
- mountPropagation determines how mounts are propagated from the host
- to container and the other way around.
- When not set, MountPropagationNone is used.
- This field is beta in 1.10.
+ description: mountPropagation determines how
+ mounts are propagated from the host to container
+ and the other way around. When not set,
+ MountPropagationNone is used. This field
+ is beta in 1.10.
type: string
name:
description: This must match the Name of a
Volume.
type: string
readOnly:
- description: |-
- Mounted read-only if true, read-write otherwise (false or unspecified).
- Defaults to false.
+ description: Mounted read-only if true, read-write
+ otherwise (false or unspecified). Defaults
+ to false.
type: boolean
subPath:
- description: |-
- Path within the volume from which the container's volume should be mounted.
+ description: Path within the volume from which
+ the container's volume should be mounted.
Defaults to "" (volume's root).
type: string
subPathExpr:
- description: |-
- Expanded path within the volume from which the container's volume should be mounted.
- Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.
- Defaults to "" (volume's root).
- SubPathExpr and SubPath are mutually exclusive.
+ description: Expanded path within the volume
+ from which the container's volume should
+ be mounted. Behaves similarly to SubPath
+ but environment variable references $(VAR_NAME)
+ are expanded using the container's environment.
+ Defaults to "" (volume's root). SubPathExpr
+ and SubPath are mutually exclusive.
type: string
required:
- mountPath
@@ -34256,11 +34961,10 @@ spec:
type: object
type: array
workingDir:
- description: |-
- Container's working directory.
- If not specified, the container runtime's default will be used, which
- might be configured in the container image.
- Cannot be updated.
+ description: Container's working directory. If not
+ specified, the container runtime's default will
+ be used, which might be configured in the container
+ image. Cannot be updated.
type: string
required:
- name
@@ -34278,68 +34982,69 @@ spec:
description: 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.
- Note that this field cannot be set when spec.os.name is windows.
+ description: "A special supplemental group that applies
+ to all containers in a pod. Some volume types allow
+ the Kubelet to change the ownership of that volume
+ to be owned by the pod: \n 1. The owning GID will
+ be the FSGroup 2. The setgid bit is set (new files
+ created in the volume will be owned by FSGroup)
+ 3. The permission bits are OR'd with rw-rw---- \n
+ If unset, the Kubelet will not modify the ownership
+ and permissions of any volume. Note that this field
+ cannot be set when spec.os.name is windows."
format: int64
type: integer
fsGroupChangePolicy:
- description: |-
- fsGroupChangePolicy defines behavior of changing ownership and permission of the volume
- before being exposed inside Pod. This field will only apply to
- volume types which support fsGroup based ownership(and permissions).
- It will have no effect on ephemeral volume types such as: secret, configmaps
- and emptydir.
- Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used.
- Note that this field cannot be set when spec.os.name is windows.
+ description: 'fsGroupChangePolicy defines behavior
+ of changing ownership and permission of the volume
+ before being exposed inside Pod. This field will
+ only apply to volume types which support fsGroup
+ based ownership(and permissions). It will have no
+ effect on ephemeral volume types such as: secret,
+ configmaps and emptydir. Valid values are "OnRootMismatch"
+ and "Always". If not specified, "Always" is used.
+ Note that this field cannot be set when spec.os.name
+ is windows.'
type: string
runAsGroup:
- description: |-
- The GID to run the entrypoint of the container process.
- Uses runtime default if unset.
- May also be set in SecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence
- for that container.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The GID to run the entrypoint of the
+ container process. Uses runtime default if unset.
+ May also be set in SecurityContext. If set in both
+ SecurityContext and PodSecurityContext, the value
+ specified in SecurityContext takes precedence for
+ that container. Note that this field cannot be set
+ when spec.os.name is windows.
format: int64
type: integer
runAsNonRoot:
- description: |-
- Indicates that the container must run as a non-root user.
- If true, the Kubelet will validate the image at runtime to ensure that it
- does not run as UID 0 (root) and fail to start the container if it does.
- If unset or false, no such validation will be performed.
- May also be set in SecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: Indicates that the container must run
+ as a non-root user. If true, the Kubelet will validate
+ the image at runtime to ensure that it does not
+ run as UID 0 (root) and fail to start the container
+ if it does. If unset or false, no such validation
+ will be performed. May also be set in SecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence.
type: boolean
runAsUser:
- description: |-
- The UID to run the entrypoint of the container process.
- Defaults to user specified in image metadata if unspecified.
- May also be set in SecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence
- for that container.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The UID to run the entrypoint of the
+ container process. Defaults to user specified in
+ image metadata if unspecified. May also be set in
+ SecurityContext. If set in both SecurityContext
+ and PodSecurityContext, the value specified in SecurityContext
+ takes precedence for that container. Note that this
+ field cannot be set when spec.os.name is windows.
format: int64
type: integer
seLinuxOptions:
- description: |-
- The SELinux context to be applied to all containers.
- If unspecified, the container runtime will allocate a random SELinux context for each
- container. May also be set in SecurityContext. If set in
- both SecurityContext and PodSecurityContext, the value specified in SecurityContext
- takes precedence for that container.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The SELinux context to be applied to
+ all containers. If unspecified, the container runtime
+ will allocate a random SELinux context for each
+ container. May also be set in SecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence
+ for that container. Note that this field cannot
+ be set when spec.os.name is windows.
properties:
level:
description: Level is SELinux level label that
@@ -34359,48 +35064,52 @@ spec:
type: string
type: object
seccompProfile:
- description: |-
- The seccomp options to use by the containers in this pod.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The seccomp options to use by the containers
+ in this pod. Note that this field cannot be set
+ when spec.os.name is windows.
properties:
localhostProfile:
- description: |-
- localhostProfile indicates a profile defined in a file on the node should be used.
- The profile must be preconfigured on the node to work.
- Must be a descending path, relative to the kubelet's configured seccomp profile location.
- Must be set if type is "Localhost". Must NOT be set for any other type.
+ description: localhostProfile indicates a profile
+ defined in a file on the node should be used.
+ The profile must be preconfigured on the node
+ to work. Must be a descending path, relative
+ to the kubelet's configured seccomp profile
+ location. Must be set if type is "Localhost".
+ Must NOT be set for any other type.
type: string
type:
- description: |-
- type indicates which kind of seccomp profile will be applied.
- Valid options are:
-
-
- Localhost - a profile defined in a file on the node should be used.
- RuntimeDefault - the container runtime default profile should be used.
- Unconfined - no profile should be applied.
+ description: "type indicates which kind of seccomp
+ profile will be applied. Valid options are:
+ \n Localhost - a profile defined in a file on
+ the node should be used. RuntimeDefault - the
+ container runtime default profile should be
+ used. Unconfined - no profile should be applied."
type: string
required:
- type
type: object
supplementalGroups:
- description: |-
- A list of groups applied to the first process run in each container, in addition
- to the container's primary GID, the fsGroup (if specified), and group memberships
- defined in the container image for the uid of the container process. If unspecified,
- no additional groups are added to any container. Note that group memberships
- defined in the container image for the uid of the container process are still effective,
- even if they are not included in this list.
- Note that this field cannot be set when spec.os.name is windows.
+ description: A list of groups applied to the first
+ process run in each container, in addition to the
+ container's primary GID, the fsGroup (if specified),
+ and group memberships defined in the container image
+ for the uid of the container process. If unspecified,
+ no additional groups are added to any container.
+ Note that group memberships defined in the container
+ image for the uid of the container process are still
+ effective, even if they are not included in this
+ list. Note that this field cannot be set when spec.os.name
+ is windows.
items:
format: int64
type: integer
type: array
sysctls:
- description: |-
- Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported
- sysctls (by the container runtime) might fail to launch.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Sysctls hold a list of namespaced sysctls
+ used for the pod. Pods with unsupported sysctls
+ (by the container runtime) might fail to launch.
+ Note that this field cannot be set when spec.os.name
+ is windows.
items:
description: Sysctl defines a kernel parameter to
be set
@@ -34417,35 +35126,42 @@ spec:
type: object
type: array
windowsOptions:
- description: |-
- The Windows specific settings applied to all containers.
- If unspecified, the options within a container's SecurityContext will be used.
- If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is linux.
+ description: The Windows specific settings applied
+ to all containers. If unspecified, the options within
+ a container's SecurityContext will be used. If set
+ in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence.
+ Note that this field cannot be set when spec.os.name
+ is linux.
properties:
gmsaCredentialSpec:
- description: |-
- GMSACredentialSpec is where the GMSA admission webhook
- (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
- GMSA credential spec named by the GMSACredentialSpecName field.
+ description: GMSACredentialSpec is where the GMSA
+ admission webhook (https://github.com/kubernetes-sigs/windows-gmsa)
+ inlines the contents of the GMSA credential
+ spec named by the GMSACredentialSpecName field.
type: string
gmsaCredentialSpecName:
description: GMSACredentialSpecName is the name
of the GMSA credential spec to use.
type: string
hostProcess:
- description: |-
- HostProcess determines if a container should be run as a 'Host Process' container.
- All of a Pod's containers must have the same effective HostProcess value
- (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
- In addition, if HostProcess is true then HostNetwork must also be set to true.
+ description: HostProcess determines if a container
+ should be run as a 'Host Process' container.
+ All of a Pod's containers must have the same
+ effective HostProcess value (it is not allowed
+ to have a mix of HostProcess containers and
+ non-HostProcess containers). In addition, if
+ HostProcess is true then HostNetwork must also
+ be set to true.
type: boolean
runAsUserName:
- description: |-
- The UserName in Windows to run the entrypoint of the container process.
- Defaults to the user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: The UserName in Windows to run the
+ entrypoint of the container process. Defaults
+ to the user specified in image metadata if unspecified.
+ May also be set in PodSecurityContext. If set
+ in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence.
type: string
type: object
type: object
@@ -34460,34 +35176,38 @@ spec:
to spread matching pods among the given topology.
properties:
labelSelector:
- description: |-
- LabelSelector is used to find matching pods.
- Pods that match this label selector are counted to determine the number of pods
- in their corresponding topology domain.
+ description: LabelSelector is used to find matching
+ pods. Pods that match this label selector are
+ counted to determine the number of pods in their
+ corresponding topology domain.
properties:
matchExpressions:
description: matchExpressions is a list of label
selector requirements. The requirements are
ANDed.
items:
- description: |-
- A label selector requirement is a selector that contains values, a key, and an operator that
- relates the key and values.
+ description: A label selector requirement
+ is a selector that contains values, a key,
+ and an operator that relates the key and
+ values.
properties:
key:
description: key is the label key that
the selector applies to.
type: string
operator:
- description: |-
- operator represents a key's relationship to a set of values.
- Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents a key's
+ relationship to a set of values. Valid
+ operators are In, NotIn, Exists and
+ DoesNotExist.
type: string
values:
- description: |-
- values is an array of string values. If the operator is In or NotIn,
- the values array must be non-empty. If the operator is Exists or DoesNotExist,
- the values array must be empty. This array is replaced during a strategic
+ description: values is an array of string
+ values. If the operator is In or NotIn,
+ the values array must be non-empty.
+ If the operator is Exists or DoesNotExist,
+ the values array must be empty. This
+ array is replaced during a strategic
merge patch.
items:
type: string
@@ -34500,134 +35220,146 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: |-
- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions, whose key field is "key", the
- operator is "In", and the values array contains only "value". The requirements are ANDed.
+ description: matchLabels is a map of {key,value}
+ pairs. A single {key,value} in the matchLabels
+ map is equivalent to an element of matchExpressions,
+ whose key field is "key", the operator is
+ "In", and the values array contains only "value".
+ The requirements are ANDed.
type: object
type: object
- x-kubernetes-map-type: atomic
matchLabelKeys:
- description: |-
- MatchLabelKeys is a set of pod label keys to select the pods over which
- spreading will be calculated. The keys are used to lookup values from the
- incoming pod labels, those key-value labels are ANDed with labelSelector
- to select the group of existing pods over which spreading will be calculated
- for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.
- MatchLabelKeys cannot be set when LabelSelector isn't set.
- Keys that don't exist in the incoming pod labels will
- be ignored. A null or empty list means only match against labelSelector.
-
-
- This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).
+ description: "MatchLabelKeys is a set of pod label
+ keys to select the pods over which spreading will
+ be calculated. The keys are used to lookup values
+ from the incoming pod labels, those key-value
+ labels are ANDed with labelSelector to select
+ the group of existing pods over which spreading
+ will be calculated for the incoming pod. The same
+ key is forbidden to exist in both MatchLabelKeys
+ and LabelSelector. MatchLabelKeys cannot be set
+ when LabelSelector isn't set. Keys that don't
+ exist in the incoming pod labels will be ignored.
+ A null or empty list means only match against
+ labelSelector. \n This is a beta field and requires
+ the MatchLabelKeysInPodTopologySpread feature
+ gate to be enabled (enabled by default)."
items:
type: string
type: array
x-kubernetes-list-type: atomic
maxSkew:
- description: |-
- MaxSkew describes the degree to which pods may be unevenly distributed.
- When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference
- between the number of matching pods in the target topology and the global minimum.
- The global minimum is the minimum number of matching pods in an eligible domain
- or zero if the number of eligible domains is less than MinDomains.
- For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same
- labelSelector spread as 2/2/1:
- In this case, the global minimum is 1.
- | zone1 | zone2 | zone3 |
- | P P | P P | P |
- - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2;
- scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2)
- violate MaxSkew(1).
- - if MaxSkew is 2, incoming pod can be scheduled onto any zone.
- When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence
- to topologies that satisfy it.
- It's a required field. Default value is 1 and 0 is not allowed.
+ description: 'MaxSkew describes the degree to which
+ pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`,
+ it is the maximum permitted difference between
+ the number of matching pods in the target topology
+ and the global minimum. The global minimum is
+ the minimum number of matching pods in an eligible
+ domain or zero if the number of eligible domains
+ is less than MinDomains. For example, in a 3-zone
+ cluster, MaxSkew is set to 1, and pods with the
+ same labelSelector spread as 2/2/1: In this case,
+ the global minimum is 1. | zone1 | zone2 | zone3
+ | | P P | P P | P | - if MaxSkew is 1,
+ incoming pod can only be scheduled to zone3 to
+ become 2/2/2; scheduling it onto zone1(zone2)
+ would make the ActualSkew(3-1) on zone1(zone2)
+ violate MaxSkew(1). - if MaxSkew is 2, incoming
+ pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`,
+ it is used to give higher precedence to topologies
+ that satisfy it. It''s a required field. Default
+ value is 1 and 0 is not allowed.'
format: int32
type: integer
minDomains:
- description: |-
- MinDomains indicates a minimum number of eligible domains.
- When the number of eligible domains with matching topology keys is less than minDomains,
- Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed.
- And when the number of eligible domains with matching topology keys equals or greater than minDomains,
- this value has no effect on scheduling.
- As a result, when the number of eligible domains is less than minDomains,
- scheduler won't schedule more than maxSkew Pods to those domains.
- If value is nil, the constraint behaves as if MinDomains is equal to 1.
- Valid values are integers greater than 0.
- When value is not nil, WhenUnsatisfiable must be DoNotSchedule.
-
-
- For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same
- labelSelector spread as 2/2/2:
- | zone1 | zone2 | zone3 |
- | P P | P P | P P |
- The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0.
- In this situation, new pod with the same labelSelector cannot be scheduled,
- because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones,
- it will violate MaxSkew.
-
-
- This is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default).
+ description: "MinDomains indicates a minimum number
+ of eligible domains. When the number of eligible
+ domains with matching topology keys is less than
+ minDomains, Pod Topology Spread treats \"global
+ minimum\" as 0, and then the calculation of Skew
+ is performed. And when the number of eligible
+ domains with matching topology keys equals or
+ greater than minDomains, this value has no effect
+ on scheduling. As a result, when the number of
+ eligible domains is less than minDomains, scheduler
+ won't schedule more than maxSkew Pods to those
+ domains. If value is nil, the constraint behaves
+ as if MinDomains is equal to 1. Valid values are
+ integers greater than 0. When value is not nil,
+ WhenUnsatisfiable must be DoNotSchedule. \n For
+ example, in a 3-zone cluster, MaxSkew is set to
+ 2, MinDomains is set to 5 and pods with the same
+ labelSelector spread as 2/2/2: | zone1 | zone2
+ | zone3 | | P P | P P | P P | The number
+ of domains is less than 5(MinDomains), so \"global
+ minimum\" is treated as 0. In this situation,
+ new pod with the same labelSelector cannot be
+ scheduled, because computed skew will be 3(3 -
+ 0) if new Pod is scheduled to any of the three
+ zones, it will violate MaxSkew. \n This is a beta
+ field and requires the MinDomainsInPodTopologySpread
+ feature gate to be enabled (enabled by default)."
format: int32
type: integer
nodeAffinityPolicy:
- description: |-
- NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector
- when calculating pod topology spread skew. Options are:
- - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations.
- - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.
-
-
- If this value is nil, the behavior is equivalent to the Honor policy.
- This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
+ description: "NodeAffinityPolicy indicates how we
+ will treat Pod's nodeAffinity/nodeSelector when
+ calculating pod topology spread skew. Options
+ are: - Honor: only nodes matching nodeAffinity/nodeSelector
+ are included in the calculations. - Ignore: nodeAffinity/nodeSelector
+ are ignored. All nodes are included in the calculations.
+ \n If this value is nil, the behavior is equivalent
+ to the Honor policy. This is a beta-level feature
+ default enabled by the NodeInclusionPolicyInPodTopologySpread
+ feature flag."
type: string
nodeTaintsPolicy:
- description: |-
- NodeTaintsPolicy indicates how we will treat node taints when calculating
- pod topology spread skew. Options are:
- - Honor: nodes without taints, along with tainted nodes for which the incoming pod
- has a toleration, are included.
- - Ignore: node taints are ignored. All nodes are included.
-
-
- If this value is nil, the behavior is equivalent to the Ignore policy.
- This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
+ description: "NodeTaintsPolicy indicates how we
+ will treat node taints when calculating pod topology
+ spread skew. Options are: - Honor: nodes without
+ taints, along with tainted nodes for which the
+ incoming pod has a toleration, are included. -
+ Ignore: node taints are ignored. All nodes are
+ included. \n If this value is nil, the behavior
+ is equivalent to the Ignore policy. This is a
+ beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread
+ feature flag."
type: string
topologyKey:
- description: |-
- TopologyKey is the key of node labels. Nodes that have a label with this key
- and identical values are considered to be in the same topology.
- We consider each as a "bucket", and try to put balanced number
- of pods into each bucket.
- We define a domain as a particular instance of a topology.
- Also, we define an eligible domain as a domain whose nodes meet the requirements of
- nodeAffinityPolicy and nodeTaintsPolicy.
- e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology.
- And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology.
- It's a required field.
+ description: TopologyKey is the key of node labels.
+ Nodes that have a label with this key and identical
+ values are considered to be in the same topology.
+ We consider each as a "bucket", and
+ try to put balanced number of pods into each bucket.
+ We define a domain as a particular instance of
+ a topology. Also, we define an eligible domain
+ as a domain whose nodes meet the requirements
+ of nodeAffinityPolicy and nodeTaintsPolicy. e.g.
+ If TopologyKey is "kubernetes.io/hostname", each
+ Node is a domain of that topology. And, if TopologyKey
+ is "topology.kubernetes.io/zone", each zone is
+ a domain of that topology. It's a required field.
type: string
whenUnsatisfiable:
- description: |-
- WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy
- the spread constraint.
- - DoNotSchedule (default) tells the scheduler not to schedule it.
- - ScheduleAnyway tells the scheduler to schedule the pod in any location,
- but giving higher precedence to topologies that would help reduce the
- skew.
- A constraint is considered "Unsatisfiable" for an incoming pod
- if and only if every possible node assignment for that pod would violate
- "MaxSkew" on some topology.
- For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same
- labelSelector spread as 3/1/1:
- | zone1 | zone2 | zone3 |
- | P P P | P | P |
- If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled
- to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies
- MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler
- won't make it *more* imbalanced.
- It's a required field.
+ description: 'WhenUnsatisfiable indicates how to
+ deal with a pod if it doesn''t satisfy the spread
+ constraint. - DoNotSchedule (default) tells the
+ scheduler not to schedule it. - ScheduleAnyway
+ tells the scheduler to schedule the pod in any
+ location, but giving higher precedence to topologies
+ that would help reduce the skew. A constraint
+ is considered "Unsatisfiable" for an incoming
+ pod if and only if every possible node assignment
+ for that pod would violate "MaxSkew" on some topology.
+ For example, in a 3-zone cluster, MaxSkew is set
+ to 1, and pods with the same labelSelector spread
+ as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P |
+ If WhenUnsatisfiable is set to DoNotSchedule,
+ incoming pod can only be scheduled to zone2(zone3)
+ to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3)
+ satisfies MaxSkew(1). In other words, the cluster
+ can still be imbalanced, but scheduler won''t
+ make it *more* imbalanced. It''s a required field.'
type: string
required:
- maxSkew
@@ -34642,36 +35374,40 @@ spec:
that may be accessed by any container in the pod.
properties:
awsElasticBlockStore:
- description: |-
- awsElasticBlockStore represents an AWS Disk resource that is attached to a
- kubelet's host machine and then exposed to the pod.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ description: 'awsElasticBlockStore represents an
+ AWS Disk resource that is attached to a kubelet''s
+ host machine and then exposed to the pod. More
+ info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
properties:
fsType:
- description: |-
- fsType is the filesystem type of the volume that you want to mount.
- Tip: Ensure that the filesystem type is supported by the host operating system.
- Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
- TODO: how do we prevent errors in the filesystem from compromising the machine
+ description: 'fsType is the filesystem type
+ of the volume that you want to mount. Tip:
+ Ensure that the filesystem type is supported
+ by the host operating system. Examples: "ext4",
+ "xfs", "ntfs". Implicitly inferred to be "ext4"
+ if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
partition:
- description: |-
- partition is the partition in the volume that you want to mount.
- If omitted, the default is to mount by volume name.
- Examples: For volume /dev/sda1, you specify the partition as "1".
- Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
+ description: 'partition is the partition in
+ the volume that you want to mount. If omitted,
+ the default is to mount by volume name. Examples:
+ For volume /dev/sda1, you specify the partition
+ as "1". Similarly, the volume partition for
+ /dev/sda is "0" (or you can leave the property
+ empty).'
format: int32
type: integer
readOnly:
- description: |-
- readOnly value true will force the readOnly setting in VolumeMounts.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ description: 'readOnly value true will force
+ the readOnly setting in VolumeMounts. More
+ info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
type: boolean
volumeID:
- description: |-
- volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume).
- More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ description: 'volumeID is unique ID of the persistent
+ disk resource in AWS (Amazon EBS volume).
+ More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
type: string
required:
- volumeID
@@ -34693,10 +35429,11 @@ spec:
in the blob storage
type: string
fsType:
- description: |-
- fsType is Filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: fsType is Filesystem type to mount.
+ Must be a filesystem type supported by the
+ host operating system. Ex. "ext4", "xfs",
+ "ntfs". Implicitly inferred to be "ext4" if
+ unspecified.
type: string
kind:
description: 'kind expected values are Shared:
@@ -34706,9 +35443,9 @@ spec:
set). defaults to shared'
type: string
readOnly:
- description: |-
- readOnly Defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: readOnly Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
required:
- diskName
@@ -34720,9 +35457,9 @@ spec:
pod.
properties:
readOnly:
- description: |-
- readOnly defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: readOnly defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
secretName:
description: secretName is the name of secret
@@ -34741,9 +35478,9 @@ spec:
the host that shares a pod's lifetime
properties:
monitors:
- description: |-
- monitors is Required: Monitors is a collection of Ceph monitors
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ description: 'monitors is Required: Monitors
+ is a collection of Ceph monitors More info:
+ https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
items:
type: string
type: array
@@ -34753,72 +35490,68 @@ spec:
default is /'
type: string
readOnly:
- description: |-
- readOnly is Optional: Defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ description: 'readOnly is Optional: Defaults
+ to false (read/write). ReadOnly here will
+ force the ReadOnly setting in VolumeMounts.
+ More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
type: boolean
secretFile:
- description: |-
- secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ description: 'secretFile is Optional: SecretFile
+ is the path to key ring for User, default
+ is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
type: string
secretRef:
- description: |-
- secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty.
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ description: 'secretRef is Optional: SecretRef
+ is reference to the authentication secret
+ for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
user:
- description: |-
- user is optional: User is the rados user name, default is admin
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ description: 'user is optional: User is the
+ rados user name, default is admin More info:
+ https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
type: string
required:
- monitors
type: object
cinder:
- description: |-
- cinder represents a cinder volume attached and mounted on kubelets host machine.
- More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ description: 'cinder represents a cinder volume
+ attached and mounted on kubelets host machine.
+ More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
properties:
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ description: 'fsType is the filesystem type
+ to mount. Must be a filesystem type supported
+ by the host operating system. Examples: "ext4",
+ "xfs", "ntfs". Implicitly inferred to be "ext4"
+ if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
type: string
readOnly:
- description: |-
- readOnly defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
- More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ description: 'readOnly defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
type: boolean
secretRef:
- description: |-
- secretRef is optional: points to a secret object containing parameters used to connect
- to OpenStack.
+ description: 'secretRef is optional: points
+ to a secret object containing parameters used
+ to connect to OpenStack.'
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
volumeID:
- description: |-
- volumeID used to identify the volume in cinder.
- More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ description: 'volumeID used to identify the
+ volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
type: string
required:
- volumeID
@@ -34828,25 +35561,31 @@ spec:
should populate this volume
properties:
defaultMode:
- description: |-
- defaultMode is optional: mode bits used to set permissions on created files by default.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- Defaults to 0644.
- Directories within the path are not affected by this setting.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'defaultMode is optional: mode
+ bits used to set permissions on created files
+ by default. Must be an octal value between
+ 0000 and 0777 or a decimal value between 0
+ and 511. YAML accepts both octal and decimal
+ values, JSON requires decimal values for mode
+ bits. Defaults to 0644. Directories within
+ the path are not affected by this setting.
+ This might be in conflict with other options
+ that affect the file mode, like fsGroup, and
+ the result can be other mode bits set.'
format: int32
type: integer
items:
- description: |-
- items if unspecified, each key-value pair in the Data field of the referenced
- ConfigMap will be projected into the volume as a file whose name is the
- key and content is the value. If specified, the listed keys will be
- projected into the specified paths, and unlisted keys will not be
- present. If a key is specified which is not present in the ConfigMap,
- the volume setup will error unless it is marked optional. Paths must be
- relative and may not contain the '..' path or start with '..'.
+ description: items if unspecified, each key-value
+ pair in the Data field of the referenced ConfigMap
+ will be projected into the volume as a file
+ whose name is the key and content is the value.
+ If specified, the listed keys will be projected
+ into the specified paths, and unlisted keys
+ will not be present. If a key is specified
+ which is not present in the ConfigMap, the
+ volume setup will error unless it is marked
+ optional. Paths must be relative and may not
+ contain the '..' path or start with '..'.
items:
description: Maps a string key to a path within
a volume.
@@ -34855,21 +35594,26 @@ spec:
description: key is the key to project.
type: string
mode:
- description: |-
- mode is Optional: mode bits used to set permissions on this file.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'mode is Optional: mode bits
+ used to set permissions on this file.
+ Must be an octal value between 0000
+ and 0777 or a decimal value between
+ 0 and 511. YAML accepts both octal and
+ decimal values, JSON requires decimal
+ values for mode bits. If not specified,
+ the volume defaultMode will be used.
+ This might be in conflict with other
+ options that affect the file mode, like
+ fsGroup, and the result can be other
+ mode bits set.'
format: int32
type: integer
path:
- description: |-
- path is the relative path of the file to map the key to.
- May not be an absolute path.
- May not contain the path element '..'.
- May not start with the string '..'.
+ description: path is the relative path
+ of the file to map the key to. May not
+ be an absolute path. May not contain
+ the path element '..'. May not start
+ with the string '..'.
type: string
required:
- key
@@ -34877,60 +35621,62 @@ spec:
type: object
type: array
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: optional specify whether the ConfigMap
or its keys must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
csi:
description: csi (Container Storage Interface) represents
ephemeral storage that is handled by certain external
CSI drivers (Beta feature).
properties:
driver:
- description: |-
- driver is the name of the CSI driver that handles this volume.
- Consult with your admin for the correct name as registered in the cluster.
+ description: driver is the name of the CSI driver
+ that handles this volume. Consult with your
+ admin for the correct name as registered in
+ the cluster.
type: string
fsType:
- description: |-
- fsType to mount. Ex. "ext4", "xfs", "ntfs".
- If not provided, the empty value is passed to the associated CSI driver
- which will determine the default filesystem to apply.
+ description: fsType to mount. Ex. "ext4", "xfs",
+ "ntfs". If not provided, the empty value is
+ passed to the associated CSI driver which
+ will determine the default filesystem to apply.
type: string
nodePublishSecretRef:
- description: |-
- nodePublishSecretRef is a reference to the secret object containing
- sensitive information to pass to the CSI driver to complete the CSI
- NodePublishVolume and NodeUnpublishVolume calls.
- This field is optional, and may be empty if no secret is required. If the
- secret object contains more than one secret, all secret references are passed.
+ description: nodePublishSecretRef is a reference
+ to the secret object containing sensitive
+ information to pass to the CSI driver to complete
+ the CSI NodePublishVolume and NodeUnpublishVolume
+ calls. This field is optional, and may be
+ empty if no secret is required. If the secret
+ object contains more than one secret, all
+ secret references are passed.
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
readOnly:
- description: |-
- readOnly specifies a read-only configuration for the volume.
- Defaults to false (read/write).
+ description: readOnly specifies a read-only
+ configuration for the volume. Defaults to
+ false (read/write).
type: boolean
volumeAttributes:
additionalProperties:
type: string
- description: |-
- volumeAttributes stores driver-specific properties that are passed to the CSI
- driver. Consult your driver's documentation for supported values.
+ description: volumeAttributes stores driver-specific
+ properties that are passed to the CSI driver.
+ Consult your driver's documentation for supported
+ values.
type: object
required:
- driver
@@ -34940,15 +35686,18 @@ spec:
about the pod that should populate this volume
properties:
defaultMode:
- description: |-
- Optional: mode bits to use on created files by default. Must be a
- Optional: mode bits used to set permissions on created files by default.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- Defaults to 0644.
- Directories within the path are not affected by this setting.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'Optional: mode bits to use on
+ created files by default. Must be a Optional:
+ mode bits used to set permissions on created
+ files by default. Must be an octal value between
+ 0000 and 0777 or a decimal value between 0
+ and 511. YAML accepts both octal and decimal
+ values, JSON requires decimal values for mode
+ bits. Defaults to 0644. Directories within
+ the path are not affected by this setting.
+ This might be in conflict with other options
+ that affect the file mode, like fsGroup, and
+ the result can be other mode bits set.'
format: int32
type: integer
items:
@@ -34976,15 +35725,19 @@ spec:
required:
- fieldPath
type: object
- x-kubernetes-map-type: atomic
mode:
- description: |-
- Optional: mode bits used to set permissions on this file, must be an octal value
- between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'Optional: mode bits used
+ to set permissions on this file, must
+ be an octal value between 0000 and 0777
+ or a decimal value between 0 and 511.
+ YAML accepts both octal and decimal
+ values, JSON requires decimal values
+ for mode bits. If not specified, the
+ volume defaultMode will be used. This
+ might be in conflict with other options
+ that affect the file mode, like fsGroup,
+ and the result can be other mode bits
+ set.'
format: int32
type: integer
path:
@@ -34996,9 +35749,11 @@ spec:
must not start with ''..'''
type: string
resourceFieldRef:
- description: |-
- Selects a resource of the container: only resources limits and requests
- (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
+ description: 'Selects a resource of the
+ container: only resources limits and
+ requests (limits.cpu, limits.memory,
+ requests.cpu and requests.memory) are
+ currently supported.'
properties:
containerName:
description: 'Container name: required
@@ -35020,132 +35775,134 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
required:
- path
type: object
type: array
type: object
emptyDir:
- description: |-
- emptyDir represents a temporary directory that shares a pod's lifetime.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
+ description: 'emptyDir represents a temporary directory
+ that shares a pod''s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
properties:
medium:
- description: |-
- medium represents what type of storage medium should back this directory.
- The default is "" which means to use the node's default medium.
- Must be an empty string (default) or Memory.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
+ description: 'medium represents what type of
+ storage medium should back this directory.
+ The default is "" which means to use the node''s
+ default medium. Must be an empty string (default)
+ or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
type: string
sizeLimit:
anyOf:
- type: integer
- type: string
- description: |-
- sizeLimit is the total amount of local storage required for this EmptyDir volume.
- The size limit is also applicable for memory medium.
- The maximum usage on memory medium EmptyDir would be the minimum value between
- the SizeLimit specified here and the sum of memory limits of all containers in a pod.
- The default is nil which means that the limit is undefined.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
+ description: 'sizeLimit is the total amount
+ of local storage required for this EmptyDir
+ volume. The size limit is also applicable
+ for memory medium. The maximum usage on memory
+ medium EmptyDir would be the minimum value
+ between the SizeLimit specified here and the
+ sum of memory limits of all containers in
+ a pod. The default is nil which means that
+ the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
type: object
ephemeral:
- description: |-
- ephemeral represents a volume that is handled by a cluster storage driver.
- The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts,
- and deleted when the pod is removed.
-
-
- Use this if:
+ description: "ephemeral represents a volume that
+ is handled by a cluster storage driver. The volume's
+ lifecycle is tied to the pod that defines it -
+ it will be created before the pod starts, and
+ deleted when the pod is removed. \n Use this if:
a) the volume is only needed while the pod runs,
- b) features of normal volumes like restoring from snapshot or capacity
- tracking are needed,
- c) the storage driver is specified through a storage class, and
- d) the storage driver supports dynamic volume provisioning through
- a PersistentVolumeClaim (see EphemeralVolumeSource for more
- information on the connection between this volume type
- and PersistentVolumeClaim).
-
-
- Use PersistentVolumeClaim or one of the vendor-specific
- APIs for volumes that persist for longer than the lifecycle
- of an individual pod.
-
-
- Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to
- be used that way - see the documentation of the driver for
- more information.
-
-
- A pod can use both types of ephemeral volumes and
- persistent volumes at the same time.
+ b) features of normal volumes like restoring from
+ snapshot or capacity tracking are needed, c)
+ the storage driver is specified through a storage
+ class, and d) the storage driver supports dynamic
+ volume provisioning through a PersistentVolumeClaim
+ (see EphemeralVolumeSource for more information
+ on the connection between this volume type and
+ PersistentVolumeClaim). \n Use PersistentVolumeClaim
+ or one of the vendor-specific APIs for volumes
+ that persist for longer than the lifecycle of
+ an individual pod. \n Use CSI for light-weight
+ local ephemeral volumes if the CSI driver is meant
+ to be used that way - see the documentation of
+ the driver for more information. \n A pod can
+ use both types of ephemeral volumes and persistent
+ volumes at the same time."
properties:
volumeClaimTemplate:
- description: |-
- Will be used to create a stand-alone PVC to provision the volume.
- The pod in which this EphemeralVolumeSource is embedded will be the
- owner of the PVC, i.e. the PVC will be deleted together with the
- pod. The name of the PVC will be `-` where
- `` is the name from the `PodSpec.Volumes` array
- entry. Pod validation will reject the pod if the concatenated name
+ description: "Will be used to create a stand-alone
+ PVC to provision the volume. The pod in which
+ this EphemeralVolumeSource is embedded will
+ be the owner of the PVC, i.e. the PVC will
+ be deleted together with the pod. The name
+ of the PVC will be `-`
+ where `` is the name from the
+ `PodSpec.Volumes` array entry. Pod validation
+ will reject the pod if the concatenated name
is not valid for a PVC (for example, too long).
-
-
- An existing PVC with that name that is not owned by the pod
- will *not* be used for the pod to avoid using an unrelated
- volume by mistake. Starting the pod is then blocked until
- the unrelated PVC is removed. If such a pre-created PVC is
- meant to be used by the pod, the PVC has to updated with an
- owner reference to the pod once the pod exists. Normally
- this should not be necessary, but it may be useful when
- manually reconstructing a broken cluster.
-
-
- This field is read-only and no changes will be made by Kubernetes
- to the PVC after it has been created.
-
-
- Required, must not be nil.
+ \n An existing PVC with that name that is
+ not owned by the pod will *not* be used for
+ the pod to avoid using an unrelated volume
+ by mistake. Starting the pod is then blocked
+ until the unrelated PVC is removed. If such
+ a pre-created PVC is meant to be used by the
+ pod, the PVC has to updated with an owner
+ reference to the pod once the pod exists.
+ Normally this should not be necessary, but
+ it may be useful when manually reconstructing
+ a broken cluster. \n This field is read-only
+ and no changes will be made by Kubernetes
+ to the PVC after it has been created. \n Required,
+ must not be nil."
properties:
metadata:
- description: |-
- May contain labels and annotations that will be copied into the PVC
- when creating it. No other fields are allowed and will be rejected during
- validation.
+ description: May contain labels and annotations
+ that will be copied into the PVC when
+ creating it. No other fields are allowed
+ and will be rejected during validation.
type: object
spec:
- description: |-
- The specification for the PersistentVolumeClaim. The entire content is
- copied unchanged into the PVC that gets created from this
+ description: The specification for the PersistentVolumeClaim.
+ The entire content is copied unchanged
+ into the PVC that gets created from this
template. The same fields as in a PersistentVolumeClaim
are also valid here.
properties:
accessModes:
- description: |-
- accessModes contains the desired access modes the volume should have.
- More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
+ description: 'accessModes contains the
+ desired access modes the volume should
+ have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
items:
type: string
type: array
dataSource:
- description: |-
- dataSource field can be used to specify either:
- * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
+ description: 'dataSource field can be
+ used to specify either: * An existing
+ VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
* An existing PVC (PersistentVolumeClaim)
- If the provisioner or an external controller can support the specified data source,
- it will create a new volume based on the contents of the specified data source.
- When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,
- and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.
- If the namespace is specified, then dataSourceRef will not be copied to dataSource.
+ If the provisioner or an external
+ controller can support the specified
+ data source, it will create a new
+ volume based on the contents of the
+ specified data source. When the AnyVolumeDataSource
+ feature gate is enabled, dataSource
+ contents will be copied to dataSourceRef,
+ and dataSourceRef contents will be
+ copied to dataSource when dataSourceRef.namespace
+ is not specified. If the namespace
+ is specified, then dataSourceRef will
+ not be copied to dataSource.'
properties:
apiGroup:
- description: |-
- APIGroup is the group for the resource being referenced.
- If APIGroup is not specified, the specified Kind must be in the core API group.
- For any other third-party types, APIGroup is required.
+ description: APIGroup is the group
+ for the resource being referenced.
+ If APIGroup is not specified,
+ the specified Kind must be in
+ the core API group. For any other
+ third-party types, APIGroup is
+ required.
type: string
kind:
description: Kind is the type of
@@ -35159,38 +35916,57 @@ spec:
- kind
- name
type: object
- x-kubernetes-map-type: atomic
dataSourceRef:
- description: |-
- dataSourceRef specifies the object from which to populate the volume with data, if a non-empty
- volume is desired. This may be any object from a non-empty API group (non
- core object) or a PersistentVolumeClaim object.
- When this field is specified, volume binding will only succeed if the type of
- the specified object matches some installed volume populator or dynamic
- provisioner.
- This field will replace the functionality of the dataSource field and as such
- if both fields are non-empty, they must have the same value. For backwards
- compatibility, when namespace isn't specified in dataSourceRef,
- both fields (dataSource and dataSourceRef) will be set to the same
- value automatically if one of them is empty and the other is non-empty.
- When namespace is specified in dataSourceRef,
- dataSource isn't set to the same value and must be empty.
- There are three important differences between dataSource and dataSourceRef:
- * While dataSource only allows two specific types of objects, dataSourceRef
- allows any non-core object, as well as PersistentVolumeClaim objects.
- * While dataSource ignores disallowed values (dropping them), dataSourceRef
- preserves all values, and generates an error if a disallowed value is
- specified.
- * While dataSource only allows local objects, dataSourceRef allows objects
- in any namespaces.
- (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
- (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
+ description: 'dataSourceRef specifies
+ the object from which to populate
+ the volume with data, if a non-empty
+ volume is desired. This may be any
+ object from a non-empty API group
+ (non core object) or a PersistentVolumeClaim
+ object. When this field is specified,
+ volume binding will only succeed if
+ the type of the specified object matches
+ some installed volume populator or
+ dynamic provisioner. This field will
+ replace the functionality of the dataSource
+ field and as such if both fields are
+ non-empty, they must have the same
+ value. For backwards compatibility,
+ when namespace isn''t specified in
+ dataSourceRef, both fields (dataSource
+ and dataSourceRef) will be set to
+ the same value automatically if one
+ of them is empty and the other is
+ non-empty. When namespace is specified
+ in dataSourceRef, dataSource isn''t
+ set to the same value and must be
+ empty. There are three important differences
+ between dataSource and dataSourceRef:
+ * While dataSource only allows two
+ specific types of objects, dataSourceRef allows
+ any non-core object, as well as PersistentVolumeClaim
+ objects. * While dataSource ignores
+ disallowed values (dropping them),
+ dataSourceRef preserves all values,
+ and generates an error if a disallowed
+ value is specified. * While dataSource
+ only allows local objects, dataSourceRef
+ allows objects in any namespaces.
+ (Beta) Using this field requires the
+ AnyVolumeDataSource feature gate to
+ be enabled. (Alpha) Using the namespace
+ field of dataSourceRef requires the
+ CrossNamespaceVolumeDataSource feature
+ gate to be enabled.'
properties:
apiGroup:
- description: |-
- APIGroup is the group for the resource being referenced.
- If APIGroup is not specified, the specified Kind must be in the core API group.
- For any other third-party types, APIGroup is required.
+ description: APIGroup is the group
+ for the resource being referenced.
+ If APIGroup is not specified,
+ the specified Kind must be in
+ the core API group. For any other
+ third-party types, APIGroup is
+ required.
type: string
kind:
description: Kind is the type of
@@ -35201,22 +35977,32 @@ spec:
resource being referenced
type: string
namespace:
- description: |-
- Namespace is the namespace of resource being referenced
- Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.
- (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
+ description: Namespace is the namespace
+ of resource being referenced Note
+ that when a namespace is specified,
+ a gateway.networking.k8s.io/ReferenceGrant
+ object is required in the referent
+ namespace to allow that namespace's
+ owner to accept the reference.
+ See the ReferenceGrant documentation
+ for details. (Alpha) This field
+ requires the CrossNamespaceVolumeDataSource
+ feature gate to be enabled.
type: string
required:
- kind
- name
type: object
resources:
- description: |-
- resources represents the minimum resources the volume should have.
- If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements
- that are lower than previous value but must still be higher than capacity recorded in the
- status field of the claim.
- More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
+ description: 'resources represents the
+ minimum resources the volume should
+ have. If RecoverVolumeExpansionFailure
+ feature is enabled users are allowed
+ to specify resource requirements that
+ are lower than previous value but
+ must still be higher than capacity
+ recorded in the status field of the
+ claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
properties:
limits:
additionalProperties:
@@ -35225,9 +36011,9 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Limits describes the maximum amount of compute resources allowed.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Limits describes the
+ maximum amount of compute resources
+ allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -35236,11 +36022,15 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Requests describes the minimum amount of compute resources required.
- If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
- otherwise to an implementation-defined value. Requests cannot exceed Limits.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Requests describes
+ the minimum amount of compute
+ resources required. If Requests
+ is omitted for a container, it
+ defaults to Limits if that is
+ explicitly specified, otherwise
+ to an implementation-defined value.
+ Requests cannot exceed Limits.
+ More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
selector:
@@ -35252,9 +36042,11 @@ spec:
a list of label selector requirements.
The requirements are ANDed.
items:
- description: |-
- A label selector requirement is a selector that contains values, a key, and an operator that
- relates the key and values.
+ description: A label selector
+ requirement is a selector that
+ contains values, a key, and
+ an operator that relates the
+ key and values.
properties:
key:
description: key is the label
@@ -35262,16 +36054,23 @@ spec:
to.
type: string
operator:
- description: |-
- operator represents a key's relationship to a set of values.
- Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents
+ a key's relationship to
+ a set of values. Valid operators
+ are In, NotIn, Exists and
+ DoesNotExist.
type: string
values:
- description: |-
- values is an array of string values. If the operator is In or NotIn,
- the values array must be non-empty. If the operator is Exists or DoesNotExist,
- the values array must be empty. This array is replaced during a strategic
- merge patch.
+ description: values is an
+ array of string values.
+ If the operator is In or
+ NotIn, the values array
+ must be non-empty. If the
+ operator is Exists or DoesNotExist,
+ the values array must be
+ empty. This array is replaced
+ during a strategic merge
+ patch.
items:
type: string
type: array
@@ -35283,37 +36082,55 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: |-
- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions, whose key field is "key", the
- operator is "In", and the values array contains only "value". The requirements are ANDed.
+ description: matchLabels is a map
+ of {key,value} pairs. A single
+ {key,value} in the matchLabels
+ map is equivalent to an element
+ of matchExpressions, whose key
+ field is "key", the operator is
+ "In", and the values array contains
+ only "value". The requirements
+ are ANDed.
type: object
type: object
- x-kubernetes-map-type: atomic
storageClassName:
- description: |-
- storageClassName is the name of the StorageClass required by the claim.
- More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
+ description: 'storageClassName is the
+ name of the StorageClass required
+ by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
type: string
volumeAttributesClassName:
- description: |-
- volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.
- If specified, the CSI driver will create or update the volume with the attributes defined
- in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,
- it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass
- will be applied to the claim but it's not allowed to reset this field to empty string once it is set.
- If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass
- will be set by the persistentvolume controller if it exists.
- If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be
- set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource
- exists.
+ description: 'volumeAttributesClassName
+ may be used to set the VolumeAttributesClass
+ used by this claim. If specified,
+ the CSI driver will create or update
+ the volume with the attributes defined
+ in the corresponding VolumeAttributesClass.
+ This has a different purpose than
+ storageClassName, it can be changed
+ after the claim is created. An empty
+ string value means that no VolumeAttributesClass
+ will be applied to the claim but it''s
+ not allowed to reset this field to
+ empty string once it is set. If unspecified
+ and the PersistentVolumeClaim is unbound,
+ the default VolumeAttributesClass
+ will be set by the persistentvolume
+ controller if it exists. If the resource
+ referred to by volumeAttributesClass
+ does not exist, this PersistentVolumeClaim
+ will be set to a Pending state, as
+ reflected by the modifyVolumeStatus
+ field, until such as a resource exists.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass
- (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.
+ (Alpha) Using this field requires
+ the VolumeAttributesClass feature
+ gate to be enabled.'
type: string
volumeMode:
- description: |-
- volumeMode defines what type of volume is required by the claim.
- Value of Filesystem is implied when not included in claim spec.
+ description: volumeMode defines what
+ type of volume is required by the
+ claim. Value of Filesystem is implied
+ when not included in claim spec.
type: string
volumeName:
description: volumeName is the binding
@@ -35331,11 +36148,12 @@ spec:
then exposed to the pod.
properties:
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- TODO: how do we prevent errors in the filesystem from compromising the machine
+ description: 'fsType is the filesystem type
+ to mount. Must be a filesystem type supported
+ by the host operating system. Ex. "ext4",
+ "xfs", "ntfs". Implicitly inferred to be "ext4"
+ if unspecified. TODO: how do we prevent errors
+ in the filesystem from compromising the machine'
type: string
lun:
description: 'lun is Optional: FC target lun
@@ -35343,9 +36161,9 @@ spec:
format: int32
type: integer
readOnly:
- description: |-
- readOnly is Optional: Defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: 'readOnly is Optional: Defaults
+ to false (read/write). ReadOnly here will
+ force the ReadOnly setting in VolumeMounts.'
type: boolean
targetWWNs:
description: 'targetWWNs is Optional: FC target
@@ -35354,27 +36172,29 @@ spec:
type: string
type: array
wwids:
- description: |-
- wwids Optional: FC volume world wide identifiers (wwids)
- Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
+ description: 'wwids Optional: FC volume world
+ wide identifiers (wwids) Either wwids or combination
+ of targetWWNs and lun must be set, but not
+ both simultaneously.'
items:
type: string
type: array
type: object
flexVolume:
- description: |-
- flexVolume represents a generic volume resource that is
- provisioned/attached using an exec based plugin.
+ description: flexVolume represents a generic volume
+ resource that is provisioned/attached using an
+ exec based plugin.
properties:
driver:
description: driver is the name of the driver
to use for this volume.
type: string
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
+ description: fsType is the filesystem type to
+ mount. Must be a filesystem type supported
+ by the host operating system. Ex. "ext4",
+ "xfs", "ntfs". The default filesystem depends
+ on FlexVolume script.
type: string
options:
additionalProperties:
@@ -35383,26 +36203,26 @@ spec:
holds extra command options if any.'
type: object
readOnly:
- description: |-
- readOnly is Optional: defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: 'readOnly is Optional: defaults
+ to false (read/write). ReadOnly here will
+ force the ReadOnly setting in VolumeMounts.'
type: boolean
secretRef:
- description: |-
- secretRef is Optional: secretRef is reference to the secret object containing
- sensitive information to pass to the plugin scripts. This may be
- empty if no secret object is specified. If the secret object
- contains more than one secret, all secrets are passed to the plugin
- scripts.
+ description: 'secretRef is Optional: secretRef
+ is reference to the secret object containing
+ sensitive information to pass to the plugin
+ scripts. This may be empty if no secret object
+ is specified. If the secret object contains
+ more than one secret, all secrets are passed
+ to the plugin scripts.'
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
required:
- driver
type: object
@@ -35412,9 +36232,9 @@ spec:
on the Flocker control service being running
properties:
datasetName:
- description: |-
- datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker
- should be considered as deprecated
+ description: datasetName is Name of the dataset
+ stored as metadata -> name on the dataset
+ for Flocker should be considered as deprecated
type: string
datasetUUID:
description: datasetUUID is the UUID of the
@@ -35423,55 +36243,59 @@ spec:
type: string
type: object
gcePersistentDisk:
- description: |-
- gcePersistentDisk represents a GCE Disk resource that is attached to a
- kubelet's host machine and then exposed to the pod.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ description: 'gcePersistentDisk represents a GCE
+ Disk resource that is attached to a kubelet''s
+ host machine and then exposed to the pod. More
+ info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
properties:
fsType:
- description: |-
- fsType is filesystem type of the volume that you want to mount.
- Tip: Ensure that the filesystem type is supported by the host operating system.
- Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
- TODO: how do we prevent errors in the filesystem from compromising the machine
+ description: 'fsType is filesystem type of the
+ volume that you want to mount. Tip: Ensure
+ that the filesystem type is supported by the
+ host operating system. Examples: "ext4", "xfs",
+ "ntfs". Implicitly inferred to be "ext4" if
+ unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
partition:
- description: |-
- partition is the partition in the volume that you want to mount.
- If omitted, the default is to mount by volume name.
- Examples: For volume /dev/sda1, you specify the partition as "1".
- Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ description: 'partition is the partition in
+ the volume that you want to mount. If omitted,
+ the default is to mount by volume name. Examples:
+ For volume /dev/sda1, you specify the partition
+ as "1". Similarly, the volume partition for
+ /dev/sda is "0" (or you can leave the property
+ empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
format: int32
type: integer
pdName:
- description: |-
- pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ description: 'pdName is unique name of the PD
+ resource in GCE. Used to identify the disk
+ in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
type: string
readOnly:
- description: |-
- readOnly here will force the ReadOnly setting in VolumeMounts.
- Defaults to false.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ description: 'readOnly here will force the ReadOnly
+ setting in VolumeMounts. Defaults to false.
+ More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
type: boolean
required:
- pdName
type: object
gitRepo:
- description: |-
- gitRepo represents a git repository at a particular revision.
- DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an
- EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir
- into the Pod's container.
+ description: 'gitRepo represents a git repository
+ at a particular revision. DEPRECATED: GitRepo
+ is deprecated. To provision a container with a
+ git repo, mount an EmptyDir into an InitContainer
+ that clones the repo using git, then mount the
+ EmptyDir into the Pod''s container.'
properties:
directory:
- description: |-
- directory is the target directory name.
- Must not contain or start with '..'. If '.' is supplied, the volume directory will be the
- git repository. Otherwise, if specified, the volume will contain the git repository in
- the subdirectory with the given name.
+ description: directory is the target directory
+ name. Must not contain or start with '..'. If
+ '.' is supplied, the volume directory will
+ be the git repository. Otherwise, if specified,
+ the volume will contain the git repository
+ in the subdirectory with the given name.
type: string
repository:
description: repository is the URL
@@ -35484,61 +36308,55 @@ spec:
- repository
type: object
glusterfs:
- description: |-
- glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.
- More info: https://examples.k8s.io/volumes/glusterfs/README.md
+ description: 'glusterfs represents a Glusterfs mount
+ on the host that shares a pod''s lifetime. More
+ info: https://examples.k8s.io/volumes/glusterfs/README.md'
properties:
endpoints:
- description: |-
- endpoints is the endpoint name that details Glusterfs topology.
- More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
+ description: 'endpoints is the endpoint name
+ that details Glusterfs topology. More info:
+ https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: string
path:
- description: |-
- path is the Glusterfs volume path.
- More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
+ description: 'path is the Glusterfs volume path.
+ More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: string
readOnly:
- description: |-
- readOnly here will force the Glusterfs volume to be mounted with read-only permissions.
- Defaults to false.
- More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
+ description: 'readOnly here will force the Glusterfs
+ volume to be mounted with read-only permissions.
+ Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: boolean
required:
- endpoints
- path
type: object
hostPath:
- description: |-
- hostPath represents a pre-existing file or directory on the host
- machine that is directly exposed to the container. This is generally
- used for system agents or other privileged things that are allowed
- to see the host machine. Most containers will NOT need this.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
- ---
- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not
- mount host directories as read/write.
+ description: 'hostPath represents a pre-existing
+ file or directory on the host machine that is
+ directly exposed to the container. This is generally
+ used for system agents or other privileged things
+ that are allowed to see the host machine. Most
+ containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
+ --- TODO(jonesdl) We need to restrict who can
+ use host directory mounts and who can/can not
+ mount host directories as read/write.'
properties:
path:
- description: |-
- path of the directory on the host.
- If the path is a symlink, it will follow the link to the real path.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
+ description: 'path of the directory on the host.
+ If the path is a symlink, it will follow the
+ link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
type: string
type:
- description: |-
- type for HostPath Volume
- Defaults to ""
- More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
+ description: 'type for HostPath Volume Defaults
+ to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
type: string
required:
- path
type: object
iscsi:
- description: |-
- iscsi represents an ISCSI Disk resource that is attached to a
- kubelet's host machine and then exposed to the pod.
- More info: https://examples.k8s.io/volumes/iscsi/README.md
+ description: 'iscsi represents an ISCSI Disk resource
+ that is attached to a kubelet''s host machine
+ and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md'
properties:
chapAuthDiscovery:
description: chapAuthDiscovery defines whether
@@ -35549,27 +36367,30 @@ spec:
support iSCSI Session CHAP authentication
type: boolean
fsType:
- description: |-
- fsType is the filesystem type of the volume that you want to mount.
- Tip: Ensure that the filesystem type is supported by the host operating system.
- Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
- TODO: how do we prevent errors in the filesystem from compromising the machine
+ description: 'fsType is the filesystem type
+ of the volume that you want to mount. Tip:
+ Ensure that the filesystem type is supported
+ by the host operating system. Examples: "ext4",
+ "xfs", "ntfs". Implicitly inferred to be "ext4"
+ if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
initiatorName:
- description: |-
- initiatorName is the custom iSCSI Initiator Name.
- If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface
- : will be created for the connection.
+ description: initiatorName is the custom iSCSI
+ Initiator Name. If initiatorName is specified
+ with iscsiInterface simultaneously, new iSCSI
+ interface : will
+ be created for the connection.
type: string
iqn:
description: iqn is the target iSCSI Qualified
Name.
type: string
iscsiInterface:
- description: |-
- iscsiInterface is the interface Name that uses an iSCSI transport.
- Defaults to 'default' (tcp).
+ description: iscsiInterface is the interface
+ Name that uses an iSCSI transport. Defaults
+ to 'default' (tcp).
type: string
lun:
description: lun represents iSCSI Target Lun
@@ -35577,33 +36398,33 @@ spec:
format: int32
type: integer
portals:
- description: |-
- portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port
- is other than default (typically TCP ports 860 and 3260).
+ description: portals is the iSCSI Target Portal
+ List. The portal is either an IP or ip_addr:port
+ if the port is other than default (typically
+ TCP ports 860 and 3260).
items:
type: string
type: array
readOnly:
- description: |-
- readOnly here will force the ReadOnly setting in VolumeMounts.
- Defaults to false.
+ description: readOnly here will force the ReadOnly
+ setting in VolumeMounts. Defaults to false.
type: boolean
secretRef:
description: secretRef is the CHAP Secret for
iSCSI target and initiator authentication
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
targetPortal:
- description: |-
- targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port
- is other than default (typically TCP ports 860 and 3260).
+ description: targetPortal is iSCSI Target Portal.
+ The Portal is either an IP or ip_addr:port
+ if the port is other than default (typically
+ TCP ports 860 and 3260).
type: string
required:
- iqn
@@ -35611,51 +36432,44 @@ spec:
- targetPortal
type: object
name:
- description: |-
- name of the volume.
- Must be a DNS_LABEL and unique within the pod.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ description: 'name of the volume. Must be a DNS_LABEL
+ and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
type: string
nfs:
- description: |-
- nfs represents an NFS mount on the host that shares a pod's lifetime
- More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ description: 'nfs represents an NFS mount on the
+ host that shares a pod''s lifetime More info:
+ https://kubernetes.io/docs/concepts/storage/volumes#nfs'
properties:
path:
- description: |-
- path that is exported by the NFS server.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ description: 'path that is exported by the NFS
+ server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: string
readOnly:
- description: |-
- readOnly here will force the NFS export to be mounted with read-only permissions.
- Defaults to false.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ description: 'readOnly here will force the NFS
+ export to be mounted with read-only permissions.
+ Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: boolean
server:
- description: |-
- server is the hostname or IP address of the NFS server.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ description: 'server is the hostname or IP address
+ of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: string
required:
- path
- server
type: object
persistentVolumeClaim:
- description: |-
- persistentVolumeClaimVolumeSource represents a reference to a
- PersistentVolumeClaim in the same namespace.
- More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
+ description: 'persistentVolumeClaimVolumeSource
+ represents a reference to a PersistentVolumeClaim
+ in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
properties:
claimName:
- description: |-
- claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.
- More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
+ description: 'claimName is the name of a PersistentVolumeClaim
+ in the same namespace as the pod using this
+ volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
type: string
readOnly:
- description: |-
- readOnly Will force the ReadOnly setting in VolumeMounts.
- Default false.
+ description: readOnly Will force the ReadOnly
+ setting in VolumeMounts. Default false.
type: boolean
required:
- claimName
@@ -35666,10 +36480,11 @@ spec:
host machine
properties:
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: fsType is the filesystem type to
+ mount. Must be a filesystem type supported
+ by the host operating system. Ex. "ext4",
+ "xfs", "ntfs". Implicitly inferred to be "ext4"
+ if unspecified.
type: string
pdID:
description: pdID is the ID that identifies
@@ -35683,15 +36498,16 @@ spec:
volume attached and mounted on kubelets host machine
properties:
fsType:
- description: |-
- fSType represents the filesystem type to mount
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
+ description: fSType represents the filesystem
+ type to mount Must be a filesystem type supported
+ by the host operating system. Ex. "ext4",
+ "xfs". Implicitly inferred to be "ext4" if
+ unspecified.
type: string
readOnly:
- description: |-
- readOnly defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: readOnly defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
volumeID:
description: volumeID uniquely identifies a
@@ -35705,13 +36521,16 @@ spec:
secrets, configmaps, and downward API
properties:
defaultMode:
- description: |-
- defaultMode are the mode bits used to set permissions on created files by default.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- Directories within the path are not affected by this setting.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: defaultMode are the mode bits used
+ to set permissions on created files by default.
+ Must be an octal value between 0000 and 0777
+ or a decimal value between 0 and 511. YAML
+ accepts both octal and decimal values, JSON
+ requires decimal values for mode bits. Directories
+ within the path are not affected by this setting.
+ This might be in conflict with other options
+ that affect the file mode, like fsGroup, and
+ the result can be other mode bits set.
format: int32
type: integer
sources:
@@ -35721,30 +36540,31 @@ spec:
along with other supported volume types
properties:
clusterTrustBundle:
- description: |-
- ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field
- of ClusterTrustBundle objects in an auto-updating file.
-
-
- Alpha, gated by the ClusterTrustBundleProjection feature gate.
-
-
- ClusterTrustBundle objects can either be selected by name, or by the
- combination of signer name and a label selector.
-
-
- Kubelet performs aggressive normalization of the PEM contents written
- into the pod filesystem. Esoteric PEM features such as inter-block
- comments and block headers are stripped. Certificates are deduplicated.
- The ordering of certificates within the file is arbitrary, and Kubelet
- may change the order over time.
+ description: "ClusterTrustBundle allows
+ a pod to access the `.spec.trustBundle`
+ field of ClusterTrustBundle objects
+ in an auto-updating file. \n Alpha,
+ gated by the ClusterTrustBundleProjection
+ feature gate. \n ClusterTrustBundle
+ objects can either be selected by name,
+ or by the combination of signer name
+ and a label selector. \n Kubelet performs
+ aggressive normalization of the PEM
+ contents written into the pod filesystem.
+ \ Esoteric PEM features such as inter-block
+ comments and block headers are stripped.
+ \ Certificates are deduplicated. The
+ ordering of certificates within the
+ file is arbitrary, and Kubelet may change
+ the order over time."
properties:
labelSelector:
- description: |-
- Select all ClusterTrustBundles that match this label selector. Only has
- effect if signerName is set. Mutually-exclusive with name. If unset,
- interpreted as "match nothing". If set but empty, interpreted as "match
- everything".
+ description: Select all ClusterTrustBundles
+ that match this label selector. Only
+ has effect if signerName is set. Mutually-exclusive
+ with name. If unset, interpreted
+ as "match nothing". If set but
+ empty, interpreted as "match everything".
properties:
matchExpressions:
description: matchExpressions
@@ -35752,9 +36572,11 @@ spec:
requirements. The requirements
are ANDed.
items:
- description: |-
- A label selector requirement is a selector that contains values, a key, and an operator that
- relates the key and values.
+ description: A label selector
+ requirement is a selector
+ that contains values, a key,
+ and an operator that relates
+ the key and values.
properties:
key:
description: key is the
@@ -35762,16 +36584,23 @@ spec:
applies to.
type: string
operator:
- description: |-
- operator represents a key's relationship to a set of values.
- Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents
+ a key's relationship to
+ a set of values. Valid
+ operators are In, NotIn,
+ Exists and DoesNotExist.
type: string
values:
- description: |-
- values is an array of string values. If the operator is In or NotIn,
- the values array must be non-empty. If the operator is Exists or DoesNotExist,
- the values array must be empty. This array is replaced during a strategic
- merge patch.
+ description: values is an
+ array of string values.
+ If the operator is In
+ or NotIn, the values array
+ must be non-empty. If
+ the operator is Exists
+ or DoesNotExist, the values
+ array must be empty. This
+ array is replaced during
+ a strategic merge patch.
items:
type: string
type: array
@@ -35783,35 +36612,42 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: |-
- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions, whose key field is "key", the
- operator is "In", and the values array contains only "value". The requirements are ANDed.
+ description: matchLabels is a
+ map of {key,value} pairs. A
+ single {key,value} in the matchLabels
+ map is equivalent to an element
+ of matchExpressions, whose key
+ field is "key", the operator
+ is "In", and the values array
+ contains only "value". The requirements
+ are ANDed.
type: object
type: object
- x-kubernetes-map-type: atomic
name:
- description: |-
- Select a single ClusterTrustBundle by object name. Mutually-exclusive
+ description: Select a single ClusterTrustBundle
+ by object name. Mutually-exclusive
with signerName and labelSelector.
type: string
optional:
- description: |-
- If true, don't block pod startup if the referenced ClusterTrustBundle(s)
- aren't available. If using name, then the named ClusterTrustBundle is
- allowed not to exist. If using signerName, then the combination of
- signerName and labelSelector is allowed to match zero
- ClusterTrustBundles.
+ description: If true, don't block
+ pod startup if the referenced ClusterTrustBundle(s)
+ aren't available. If using name,
+ then the named ClusterTrustBundle
+ is allowed not to exist. If using
+ signerName, then the combination
+ of signerName and labelSelector
+ is allowed to match zero ClusterTrustBundles.
type: boolean
path:
description: Relative path from the
volume root to write the bundle.
type: string
signerName:
- description: |-
- Select all ClusterTrustBundles that match this signer name.
- Mutually-exclusive with name. The contents of all selected
- ClusterTrustBundles will be unified and deduplicated.
+ description: Select all ClusterTrustBundles
+ that match this signer name. Mutually-exclusive
+ with name. The contents of all
+ selected ClusterTrustBundles will
+ be unified and deduplicated.
type: string
required:
- path
@@ -35821,14 +36657,21 @@ spec:
the configMap data to project
properties:
items:
- description: |-
- items if unspecified, each key-value pair in the Data field of the referenced
- ConfigMap will be projected into the volume as a file whose name is the
- key and content is the value. If specified, the listed keys will be
- projected into the specified paths, and unlisted keys will not be
- present. If a key is specified which is not present in the ConfigMap,
- the volume setup will error unless it is marked optional. Paths must be
- relative and may not contain the '..' path or start with '..'.
+ description: items if unspecified,
+ each key-value pair in the Data
+ field of the referenced ConfigMap
+ will be projected into the volume
+ as a file whose name is the key
+ and content is the value. If specified,
+ the listed keys will be projected
+ into the specified paths, and unlisted
+ keys will not be present. If a key
+ is specified which is not present
+ in the ConfigMap, the volume setup
+ will error unless it is marked optional.
+ Paths must be relative and may not
+ contain the '..' path or start with
+ '..'.
items:
description: Maps a string key to
a path within a volume.
@@ -35838,21 +36681,30 @@ spec:
to project.
type: string
mode:
- description: |-
- mode is Optional: mode bits used to set permissions on this file.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'mode is Optional:
+ mode bits used to set permissions
+ on this file. Must be an octal
+ value between 0000 and 0777
+ or a decimal value between
+ 0 and 511. YAML accepts both
+ octal and decimal values,
+ JSON requires decimal values
+ for mode bits. If not specified,
+ the volume defaultMode will
+ be used. This might be in
+ conflict with other options
+ that affect the file mode,
+ like fsGroup, and the result
+ can be other mode bits set.'
format: int32
type: integer
path:
- description: |-
- path is the relative path of the file to map the key to.
- May not be an absolute path.
- May not contain the path element '..'.
- May not start with the string '..'.
+ description: path is the relative
+ path of the file to map the
+ key to. May not be an absolute
+ path. May not contain the
+ path element '..'. May not
+ start with the string '..'.
type: string
required:
- key
@@ -35860,10 +36712,10 @@ spec:
type: object
type: array
name:
- description: |-
- Name of the referent.
+ description: 'Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: optional specify whether
@@ -35871,7 +36723,6 @@ spec:
defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
downwardAPI:
description: downwardAPI information about
the downwardAPI data to project
@@ -35904,15 +36755,22 @@ spec:
required:
- fieldPath
type: object
- x-kubernetes-map-type: atomic
mode:
- description: |-
- Optional: mode bits used to set permissions on this file, must be an octal value
- between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'Optional: mode
+ bits used to set permissions
+ on this file, must be an octal
+ value between 0000 and 0777
+ or a decimal value between
+ 0 and 511. YAML accepts both
+ octal and decimal values,
+ JSON requires decimal values
+ for mode bits. If not specified,
+ the volume defaultMode will
+ be used. This might be in
+ conflict with other options
+ that affect the file mode,
+ like fsGroup, and the result
+ can be other mode bits set.'
format: int32
type: integer
path:
@@ -35926,9 +36784,12 @@ spec:
start with ''..'''
type: string
resourceFieldRef:
- description: |-
- Selects a resource of the container: only resources limits and requests
- (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
+ description: 'Selects a resource
+ of the container: only resources
+ limits and requests (limits.cpu,
+ limits.memory, requests.cpu
+ and requests.memory) are currently
+ supported.'
properties:
containerName:
description: 'Container
@@ -35952,7 +36813,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
required:
- path
type: object
@@ -35963,14 +36823,21 @@ spec:
the secret data to project
properties:
items:
- description: |-
- items if unspecified, each key-value pair in the Data field of the referenced
- Secret will be projected into the volume as a file whose name is the
- key and content is the value. If specified, the listed keys will be
- projected into the specified paths, and unlisted keys will not be
- present. If a key is specified which is not present in the Secret,
- the volume setup will error unless it is marked optional. Paths must be
- relative and may not contain the '..' path or start with '..'.
+ description: items if unspecified,
+ each key-value pair in the Data
+ field of the referenced Secret will
+ be projected into the volume as
+ a file whose name is the key and
+ content is the value. If specified,
+ the listed keys will be projected
+ into the specified paths, and unlisted
+ keys will not be present. If a key
+ is specified which is not present
+ in the Secret, the volume setup
+ will error unless it is marked optional.
+ Paths must be relative and may not
+ contain the '..' path or start with
+ '..'.
items:
description: Maps a string key to
a path within a volume.
@@ -35980,21 +36847,30 @@ spec:
to project.
type: string
mode:
- description: |-
- mode is Optional: mode bits used to set permissions on this file.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'mode is Optional:
+ mode bits used to set permissions
+ on this file. Must be an octal
+ value between 0000 and 0777
+ or a decimal value between
+ 0 and 511. YAML accepts both
+ octal and decimal values,
+ JSON requires decimal values
+ for mode bits. If not specified,
+ the volume defaultMode will
+ be used. This might be in
+ conflict with other options
+ that affect the file mode,
+ like fsGroup, and the result
+ can be other mode bits set.'
format: int32
type: integer
path:
- description: |-
- path is the relative path of the file to map the key to.
- May not be an absolute path.
- May not contain the path element '..'.
- May not start with the string '..'.
+ description: path is the relative
+ path of the file to map the
+ key to. May not be an absolute
+ path. May not contain the
+ path element '..'. May not
+ start with the string '..'.
type: string
required:
- key
@@ -36002,10 +36878,10 @@ spec:
type: object
type: array
name:
- description: |-
- Name of the referent.
+ description: 'Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: optional field specify
@@ -36013,33 +36889,40 @@ spec:
be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
serviceAccountToken:
description: serviceAccountToken is information
about the serviceAccountToken data to
project
properties:
audience:
- description: |-
- audience is the intended audience of the token. A recipient of a token
- must identify itself with an identifier specified in the audience of the
- token, and otherwise should reject the token. The audience defaults to the
- identifier of the apiserver.
+ description: audience is the intended
+ audience of the token. A recipient
+ of a token must identify itself
+ with an identifier specified in
+ the audience of the token, and otherwise
+ should reject the token. The audience
+ defaults to the identifier of the
+ apiserver.
type: string
expirationSeconds:
- description: |-
- expirationSeconds is the requested duration of validity of the service
- account token. As the token approaches expiration, the kubelet volume
- plugin will proactively rotate the service account token. The kubelet will
- start trying to rotate the token if the token is older than 80 percent of
- its time to live or if the token is older than 24 hours.Defaults to 1 hour
+ description: expirationSeconds is
+ the requested duration of validity
+ of the service account token. As
+ the token approaches expiration,
+ the kubelet volume plugin will proactively
+ rotate the service account token.
+ The kubelet will start trying to
+ rotate the token if the token is
+ older than 80 percent of its time
+ to live or if the token is older
+ than 24 hours.Defaults to 1 hour
and must be at least 10 minutes.
format: int64
type: integer
path:
- description: |-
- path is the path relative to the mount point of the file to project the
- token into.
+ description: path is the path relative
+ to the mount point of the file to
+ project the token into.
type: string
required:
- path
@@ -36052,30 +36935,30 @@ spec:
on the host that shares a pod's lifetime
properties:
group:
- description: |-
- group to map volume access to
- Default is no group
+ description: group to map volume access to Default
+ is no group
type: string
readOnly:
- description: |-
- readOnly here will force the Quobyte volume to be mounted with read-only permissions.
+ description: readOnly here will force the Quobyte
+ volume to be mounted with read-only permissions.
Defaults to false.
type: boolean
registry:
- description: |-
- registry represents a single or multiple Quobyte Registry services
- specified as a string as host:port pair (multiple entries are separated with commas)
- which acts as the central registry for volumes
+ description: registry represents a single or
+ multiple Quobyte Registry services specified
+ as a string as host:port pair (multiple entries
+ are separated with commas) which acts as the
+ central registry for volumes
type: string
tenant:
- description: |-
- tenant owning the given Quobyte volume in the Backend
- Used with dynamically provisioned Quobyte volumes, value is set by the plugin
+ description: tenant owning the given Quobyte
+ volume in the Backend Used with dynamically
+ provisioned Quobyte volumes, value is set
+ by the plugin
type: string
user:
- description: |-
- user to map volume access to
- Defaults to serivceaccount user
+ description: user to map volume access to Defaults
+ to serivceaccount user
type: string
volume:
description: volume is a string that references
@@ -36086,68 +36969,59 @@ spec:
- volume
type: object
rbd:
- description: |-
- rbd represents a Rados Block Device mount on the host that shares a pod's lifetime.
- More info: https://examples.k8s.io/volumes/rbd/README.md
+ description: 'rbd represents a Rados Block Device
+ mount on the host that shares a pod''s lifetime.
+ More info: https://examples.k8s.io/volumes/rbd/README.md'
properties:
fsType:
- description: |-
- fsType is the filesystem type of the volume that you want to mount.
- Tip: Ensure that the filesystem type is supported by the host operating system.
- Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd
- TODO: how do we prevent errors in the filesystem from compromising the machine
+ description: 'fsType is the filesystem type
+ of the volume that you want to mount. Tip:
+ Ensure that the filesystem type is supported
+ by the host operating system. Examples: "ext4",
+ "xfs", "ntfs". Implicitly inferred to be "ext4"
+ if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
image:
- description: |-
- image is the rados image name.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'image is the rados image name.
+ More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
keyring:
- description: |-
- keyring is the path to key ring for RBDUser.
- Default is /etc/ceph/keyring.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'keyring is the path to key ring
+ for RBDUser. Default is /etc/ceph/keyring.
+ More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
monitors:
- description: |-
- monitors is a collection of Ceph monitors.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'monitors is a collection of Ceph
+ monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
items:
type: string
type: array
pool:
- description: |-
- pool is the rados pool name.
- Default is rbd.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'pool is the rados pool name. Default
+ is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
readOnly:
- description: |-
- readOnly here will force the ReadOnly setting in VolumeMounts.
- Defaults to false.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'readOnly here will force the ReadOnly
+ setting in VolumeMounts. Defaults to false.
+ More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: boolean
secretRef:
- description: |-
- secretRef is name of the authentication secret for RBDUser. If provided
- overrides keyring.
- Default is nil.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'secretRef is name of the authentication
+ secret for RBDUser. If provided overrides
+ keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
user:
- description: |-
- user is the rados user name.
- Default is admin.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'user is the rados user name. Default
+ is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
required:
- image
@@ -36158,11 +37032,10 @@ spec:
volume attached and mounted on Kubernetes nodes.
properties:
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs".
- Default is "xfs".
+ description: fsType is the filesystem type to
+ mount. Must be a filesystem type supported
+ by the host operating system. Ex. "ext4",
+ "xfs", "ntfs". Default is "xfs".
type: string
gateway:
description: gateway is the host address of
@@ -36174,31 +37047,31 @@ spec:
storage.
type: string
readOnly:
- description: |-
- readOnly Defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: readOnly Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
secretRef:
- description: |-
- secretRef references to the secret for ScaleIO user and other
- sensitive information. If this is not provided, Login operation will fail.
+ description: secretRef references to the secret
+ for ScaleIO user and other sensitive information.
+ If this is not provided, Login operation will
+ fail.
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
sslEnabled:
description: sslEnabled Flag enable/disable
SSL communication with Gateway, default false
type: boolean
storageMode:
- description: |-
- storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.
- Default is ThinProvisioned.
+ description: storageMode indicates whether the
+ storage for a volume should be ThickProvisioned
+ or ThinProvisioned. Default is ThinProvisioned.
type: string
storagePool:
description: storagePool is the ScaleIO Storage
@@ -36209,9 +37082,9 @@ spec:
system as configured in ScaleIO.
type: string
volumeName:
- description: |-
- volumeName is the name of a volume already created in the ScaleIO system
- that is associated with this volume source.
+ description: volumeName is the name of a volume
+ already created in the ScaleIO system that
+ is associated with this volume source.
type: string
required:
- gateway
@@ -36219,30 +37092,35 @@ spec:
- system
type: object
secret:
- description: |-
- secret represents a secret that should populate this volume.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
+ description: 'secret represents a secret that should
+ populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
properties:
defaultMode:
- description: |-
- defaultMode is Optional: mode bits used to set permissions on created files by default.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values
- for mode bits. Defaults to 0644.
- Directories within the path are not affected by this setting.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'defaultMode is Optional: mode
+ bits used to set permissions on created files
+ by default. Must be an octal value between
+ 0000 and 0777 or a decimal value between 0
+ and 511. YAML accepts both octal and decimal
+ values, JSON requires decimal values for mode
+ bits. Defaults to 0644. Directories within
+ the path are not affected by this setting.
+ This might be in conflict with other options
+ that affect the file mode, like fsGroup, and
+ the result can be other mode bits set.'
format: int32
type: integer
items:
- description: |-
- items If unspecified, each key-value pair in the Data field of the referenced
- Secret will be projected into the volume as a file whose name is the
- key and content is the value. If specified, the listed keys will be
- projected into the specified paths, and unlisted keys will not be
- present. If a key is specified which is not present in the Secret,
- the volume setup will error unless it is marked optional. Paths must be
- relative and may not contain the '..' path or start with '..'.
+ description: items If unspecified, each key-value
+ pair in the Data field of the referenced Secret
+ will be projected into the volume as a file
+ whose name is the key and content is the value.
+ If specified, the listed keys will be projected
+ into the specified paths, and unlisted keys
+ will not be present. If a key is specified
+ which is not present in the Secret, the volume
+ setup will error unless it is marked optional.
+ Paths must be relative and may not contain
+ the '..' path or start with '..'.
items:
description: Maps a string key to a path within
a volume.
@@ -36251,21 +37129,26 @@ spec:
description: key is the key to project.
type: string
mode:
- description: |-
- mode is Optional: mode bits used to set permissions on this file.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'mode is Optional: mode bits
+ used to set permissions on this file.
+ Must be an octal value between 0000
+ and 0777 or a decimal value between
+ 0 and 511. YAML accepts both octal and
+ decimal values, JSON requires decimal
+ values for mode bits. If not specified,
+ the volume defaultMode will be used.
+ This might be in conflict with other
+ options that affect the file mode, like
+ fsGroup, and the result can be other
+ mode bits set.'
format: int32
type: integer
path:
- description: |-
- path is the relative path of the file to map the key to.
- May not be an absolute path.
- May not contain the path element '..'.
- May not start with the string '..'.
+ description: path is the relative path
+ of the file to map the key to. May not
+ be an absolute path. May not contain
+ the path element '..'. May not start
+ with the string '..'.
type: string
required:
- key
@@ -36277,9 +37160,9 @@ spec:
the Secret or its keys must be defined
type: boolean
secretName:
- description: |-
- secretName is the name of the secret in the pod's namespace to use.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
+ description: 'secretName is the name of the
+ secret in the pod''s namespace to use. More
+ info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
type: string
type: object
storageos:
@@ -36287,42 +37170,45 @@ spec:
attached and mounted on Kubernetes nodes.
properties:
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: fsType is the filesystem type to
+ mount. Must be a filesystem type supported
+ by the host operating system. Ex. "ext4",
+ "xfs", "ntfs". Implicitly inferred to be "ext4"
+ if unspecified.
type: string
readOnly:
- description: |-
- readOnly defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: readOnly defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
secretRef:
- description: |-
- secretRef specifies the secret to use for obtaining the StorageOS API
- credentials. If not specified, default values will be attempted.
+ description: secretRef specifies the secret
+ to use for obtaining the StorageOS API credentials. If
+ not specified, default values will be attempted.
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
volumeName:
- description: |-
- volumeName is the human-readable name of the StorageOS volume. Volume
- names are only unique within a namespace.
+ description: volumeName is the human-readable
+ name of the StorageOS volume. Volume names
+ are only unique within a namespace.
type: string
volumeNamespace:
- description: |-
- volumeNamespace specifies the scope of the volume within StorageOS. If no
- namespace is specified then the Pod's namespace will be used. This allows the
- Kubernetes name scoping to be mirrored within StorageOS for tighter integration.
- Set VolumeName to any name to override the default behaviour.
- Set to "default" if you are not using namespaces within StorageOS.
- Namespaces that do not pre-exist within StorageOS will be created.
+ description: volumeNamespace specifies the scope
+ of the volume within StorageOS. If no namespace
+ is specified then the Pod's namespace will
+ be used. This allows the Kubernetes name
+ scoping to be mirrored within StorageOS for
+ tighter integration. Set VolumeName to any
+ name to override the default behaviour. Set
+ to "default" if you are not using namespaces
+ within StorageOS. Namespaces that do not pre-exist
+ within StorageOS will be created.
type: string
type: object
vsphereVolume:
@@ -36330,10 +37216,11 @@ spec:
volume attached and mounted on kubelets host machine
properties:
fsType:
- description: |-
- fsType is filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: fsType is filesystem type to mount.
+ Must be a filesystem type supported by the
+ host operating system. Ex. "ext4", "xfs",
+ "ntfs". Implicitly inferred to be "ext4" if
+ unspecified.
type: string
storagePolicyID:
description: storagePolicyID is the storage
@@ -36384,9 +37271,8 @@ spec:
description: The configuration of Affinity trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -36405,9 +37291,9 @@ spec:
integration in the same node (default `false`).
type: boolean
podAffinityLabels:
- description: |-
- Defines a set of pods (namely those matching the label selector, relative to the given namespace) that the
- integration pod(s) should be co-located with.
+ description: Defines a set of pods (namely those matching
+ the label selector, relative to the given namespace)
+ that the integration pod(s) should be co-located with.
items:
type: string
type: array
@@ -36416,9 +37302,10 @@ spec:
integration in the same node (default `false`).
type: boolean
podAntiAffinityLabels:
- description: |-
- Defines a set of pods (namely those matching the label selector, relative to the given namespace) that the
- integration pod(s) should not be co-located with.
+ description: Defines a set of pods (namely those matching
+ the label selector, relative to the given namespace)
+ that the integration pod(s) should not be co-located
+ with.
items:
type: string
type: array
@@ -36433,14 +37320,14 @@ spec:
use for the builder pod.
type: object
baseImage:
- description: |-
- Specify a base image. In order to have the application working properly it must be a container image which has a Java JDK
- installed and ready to use on path (ie `/usr/bin/java`).
+ description: Specify a base image. In order to have the
+ application working properly it must be a container
+ image which has a Java JDK installed and ready to use
+ on path (ie `/usr/bin/java`).
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -36451,21 +37338,28 @@ spec:
reuse existing containers (default `true`)
type: boolean
limitCPU:
- description: |-
- When using `pod` strategy, the maximum amount of CPU required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the maximum amount
+ of CPU required by the pod builder. Deprecated: use
+ TasksRequestCPU instead with task name `builder`.'
type: string
limitMemory:
- description: |-
- When using `pod` strategy, the maximum amount of memory required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the maximum amount
+ of memory required by the pod builder. Deprecated: use
+ TasksRequestCPU instead with task name `builder`.'
type: string
mavenProfiles:
- description: |-
- A list of references pointing to configmaps/secrets that contains a maven profile.
- This configmap/secret is a resource of the IntegrationKit created, therefore it needs to be present in the namespace where the operator is going to create the IntegrationKit.
- The content of the maven profile is expected to be a text containing a valid maven profile starting with `` and ending with `` that will be integrated as an inline profile in the POM.
- Syntax: [configmap|secret]:name[/key], where name represents the resource name, key optionally represents the resource key to be filtered (default key value = profile.xml).
+ description: 'A list of references pointing to configmaps/secrets
+ that contains a maven profile. This configmap/secret
+ is a resource of the IntegrationKit created, therefore
+ it needs to be present in the namespace where the operator
+ is going to create the IntegrationKit. The content of
+ the maven profile is expected to be a text containing
+ a valid maven profile starting with `` and
+ ending with `` that will be integrated as
+ an inline profile in the POM. Syntax: [configmap|secret]:name[/key],
+ where name represents the resource name, key optionally
+ represents the resource key to be filtered (default
+ key value = profile.xml).'
items:
type: string
type: array
@@ -36497,14 +37391,14 @@ spec:
type: string
type: array
requestCPU:
- description: |-
- When using `pod` strategy, the minimum amount of CPU required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the minimum amount
+ of CPU required by the pod builder. Deprecated: use
+ TasksRequestCPU instead with task name `builder`.'
type: string
requestMemory:
- description: |-
- When using `pod` strategy, the minimum amount of memory required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the minimum amount
+ of memory required by the pod builder. Deprecated: use
+ TasksRequestCPU instead with task name `builder`.'
type: string
strategy:
description: The strategy to use, either `pod` or `routine`
@@ -36520,10 +37414,11 @@ spec:
type: string
type: array
tasksFilter:
- description: |-
- A list of tasks sorted by the order of execution in a csv format, ie, `,,...`.
- Mind that you must include also the operator tasks (`builder`, `quarkus-native`, `package`, `jib`, `s2i`)
- if you need to execute them. Useful only with `pod` strategy.
+ description: A list of tasks sorted by the order of execution
+ in a csv format, ie, `,,...`.
+ Mind that you must include also the operator tasks (`builder`,
+ `quarkus-native`, `package`, `jib`, `s2i`) if you need
+ to execute them. Useful only with `pod` strategy.
type: string
tasksLimitCPU:
description: A list of limit cpu configuration for the
@@ -36550,18 +37445,17 @@ spec:
type: string
type: array
verbose:
- description: |-
- Enable verbose logging on build components that support it (e.g. Kaniko build pod).
- Deprecated no longer in use
+ description: Enable verbose logging on build components
+ that support it (e.g. Kaniko build pod). Deprecated
+ no longer in use
type: boolean
type: object
camel:
description: The configuration of Camel trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -36574,10 +37468,12 @@ spec:
type: string
type: array
runtimeVersion:
- description: |-
- The camel-k-runtime version to use for the integration. It overrides the default version set in the Integration Platform.
- You can use a fixed version (for example "3.2.3") or a semantic version (for example "3.x") which will try to resolve
- to the best matching Catalog existing on the cluster.
+ description: The camel-k-runtime version to use for the
+ integration. It overrides the default version set in
+ the Integration Platform. You can use a fixed version
+ (for example "3.2.3") or a semantic version (for example
+ "3.x") which will try to resolve to the best matching
+ Catalog existing on the cluster.
type: string
type: object
container:
@@ -36607,9 +37503,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -36620,10 +37515,14 @@ spec:
kubernetes Service.
type: boolean
image:
- description: |-
- The main container image to use for the Integration. When using this parameter the operator will create a synthetic IntegrationKit which
- won't be able to execute traits requiring CamelCatalog. If the container image you're using is coming from an IntegrationKit, use instead
- Integration `.spec.integrationKit` parameter. If you're moving the Integration across environments, you will also need to create an "external" IntegrationKit.
+ description: The main container image to use for the Integration.
+ When using this parameter the operator will create a
+ synthetic IntegrationKit which won't be able to execute
+ traits requiring CamelCatalog. If the container image
+ you're using is coming from an IntegrationKit, use instead
+ Integration `.spec.integrationKit` parameter. If you're
+ moving the Integration across environments, you will
+ also need to create an "external" IntegrationKit.
type: string
imagePullPolicy:
description: 'The pull policy: Always|Never|IfNotPresent'
@@ -36691,52 +37590,52 @@ spec:
description: The configuration of Cron trait
properties:
activeDeadlineSeconds:
- description: |-
- Specifies the duration in seconds, relative to the start time, that the job
- may be continuously active before it is considered to be failed.
- It defaults to 60s.
+ description: Specifies the duration in seconds, relative
+ to the start time, that the job may be continuously
+ active before it is considered to be failed. It defaults
+ to 60s.
format: int64
type: integer
auto:
- description: |-
- Automatically deploy the integration as CronJob when all routes are
- either starting from a periodic consumer (only `cron`, `timer` and `quartz` are supported) or a passive consumer (e.g. `direct` is a passive consumer).
-
-
- It's required that all periodic consumers have the same period, and it can be expressed as cron schedule (e.g. `1m` can be expressed as `0/1 * * * *`,
- while `35m` or `50s` cannot).
+ description: "Automatically deploy the integration as
+ CronJob when all routes are either starting from a periodic
+ consumer (only `cron`, `timer` and `quartz` are supported)
+ or a passive consumer (e.g. `direct` is a passive consumer).
+ \n It's required that all periodic consumers have the
+ same period, and it can be expressed as cron schedule
+ (e.g. `1m` can be expressed as `0/1 * * * *`, while
+ `35m` or `50s` cannot)."
type: boolean
backoffLimit:
- description: |-
- Specifies the number of retries before marking the job failed.
- It defaults to 2.
+ description: Specifies the number of retries before marking
+ the job failed. It defaults to 2.
format: int32
type: integer
components:
- description: |-
- A comma separated list of the Camel components that need to be customized in order for them to work when the schedule is triggered externally by Kubernetes.
- A specific customizer is activated for each specified component. E.g. for the `timer` component, the `cron-timer` customizer is
- activated (it's present in the `org.apache.camel.k:camel-k-cron` library).
-
-
- Supported components are currently: `cron`, `timer` and `quartz`.
+ description: "A comma separated list of the Camel components
+ that need to be customized in order for them to work
+ when the schedule is triggered externally by Kubernetes.
+ A specific customizer is activated for each specified
+ component. E.g. for the `timer` component, the `cron-timer`
+ customizer is activated (it's present in the `org.apache.camel.k:camel-k-cron`
+ library). \n Supported components are currently: `cron`,
+ `timer` and `quartz`."
type: string
concurrencyPolicy:
- description: |-
- Specifies how to treat concurrent executions of a Job.
- Valid values are:
- - "Allow": allows CronJobs to run concurrently;
- - "Forbid" (default): forbids concurrent runs, skipping next run if previous run hasn't finished yet;
- - "Replace": cancels currently running job and replaces it with a new one
+ description: 'Specifies how to treat concurrent executions
+ of a Job. Valid values are: - "Allow": allows CronJobs
+ to run concurrently; - "Forbid" (default): forbids concurrent
+ runs, skipping next run if previous run hasn''t finished
+ yet; - "Replace": cancels currently running job and
+ replaces it with a new one'
enum:
- Allow
- Forbid
- Replace
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -36744,19 +37643,19 @@ spec:
All traits share this common property.
type: boolean
fallback:
- description: |-
- Use the default Camel implementation of the `cron` endpoint (`quartz`) instead of trying to materialize the integration
- as Kubernetes CronJob.
+ description: Use the default Camel implementation of the
+ `cron` endpoint (`quartz`) instead of trying to materialize
+ the integration as Kubernetes CronJob.
type: boolean
schedule:
- description: |-
- The CronJob schedule for the whole integration. If multiple routes are declared, they must have the same schedule for this
- mechanism to work correctly.
+ description: The CronJob schedule for the whole integration.
+ If multiple routes are declared, they must have the
+ same schedule for this mechanism to work correctly.
type: string
startingDeadlineSeconds:
- description: |-
- Optional deadline in seconds for starting the job if it misses scheduled
- time for any reason. Missed jobs executions will be counted as failed ones.
+ description: Optional deadline in seconds for starting
+ the job if it misses scheduled time for any reason. Missed
+ jobs executions will be counted as failed ones.
format: int64
type: integer
timeZone:
@@ -36767,9 +37666,8 @@ spec:
description: The configuration of Dependencies trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -36780,9 +37678,8 @@ spec:
description: The configuration of Deployer trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -36798,51 +37695,49 @@ spec:
- knative-service
type: string
useSSA:
- description: |-
- Use server-side apply to update the owned resources (default `true`).
- Note that it automatically falls back to client-side patching, if SSA is not available, e.g., on old Kubernetes clusters.
+ description: Use server-side apply to update the owned
+ resources (default `true`). Note that it automatically
+ falls back to client-side patching, if SSA is not available,
+ e.g., on old Kubernetes clusters.
type: boolean
type: object
deployment:
description: The configuration of Deployment trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
description: 'Deprecated: no longer in use.'
type: boolean
progressDeadlineSeconds:
- description: |-
- The maximum time in seconds for the deployment to make progress before it
- is considered to be failed. It defaults to `60s`.
+ description: The maximum time in seconds for the deployment
+ to make progress before it is considered to be failed.
+ It defaults to `60s`.
format: int32
type: integer
rollingUpdateMaxSurge:
anyOf:
- type: integer
- type: string
- description: |-
- The maximum number of pods that can be scheduled above the desired number of
- pods.
- Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
- This can not be 0 if MaxUnavailable is 0.
- Absolute number is calculated from percentage by rounding up.
- Defaults to `25%`.
+ description: 'The maximum number of pods that can be scheduled
+ above the desired number of pods. Value can be an absolute
+ number (ex: 5) or a percentage of desired pods (ex:
+ 10%). This can not be 0 if MaxUnavailable is 0. Absolute
+ number is calculated from percentage by rounding up.
+ Defaults to `25%`.'
x-kubernetes-int-or-string: true
rollingUpdateMaxUnavailable:
anyOf:
- type: integer
- type: string
- description: |-
- The maximum number of pods that can be unavailable during the update.
- Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
- Absolute number is calculated from percentage by rounding down.
- This can not be 0 if MaxSurge is 0.
- Defaults to `25%`.
+ description: 'The maximum number of pods that can be unavailable
+ during the update. Value can be an absolute number (ex:
+ 5) or a percentage of desired pods (ex: 10%). Absolute
+ number is calculated from percentage by rounding down.
+ This can not be 0 if MaxSurge is 0. Defaults to `25%`.'
x-kubernetes-int-or-string: true
strategy:
description: The deployment strategy to use to replace
@@ -36856,9 +37751,8 @@ spec:
description: The configuration of Environment trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
containerMeta:
@@ -36873,11 +37767,12 @@ spec:
and `NO_PROXY` environment variables (default `true`)
type: boolean
vars:
- description: |-
- A list of environment variables to be added to the integration container.
- The syntax is either VAR=VALUE or VAR=[configmap|secret]:name/key, where name represents the resource name,
- and key represents the resource key to be mapped as and environment variable.
- These take precedence over any previously defined environment variables.
+ description: A list of environment variables to be added
+ to the integration container. The syntax is either VAR=VALUE
+ or VAR=[configmap|secret]:name/key, where name represents
+ the resource name, and key represents the resource key
+ to be mapped as and environment variable. These take
+ precedence over any previously defined environment variables.
items:
type: string
type: array
@@ -36886,9 +37781,8 @@ spec:
description: The configuration of Error Handler trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -36903,15 +37797,14 @@ spec:
description: The configuration of GC trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
discoveryCache:
- description: |-
- Discovery client cache to be used, either `disabled`, `disk` or `memory` (default `memory`).
- Deprecated: to be removed from trait configuration.
+ description: 'Discovery client cache to be used, either
+ `disabled`, `disk` or `memory` (default `memory`). Deprecated:
+ to be removed from trait configuration.'
enum:
- disabled
- disk
@@ -36926,9 +37819,8 @@ spec:
description: The configuration of Health trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -37050,19 +37942,17 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to the ingress.
- This can be used to set controller specific annotations, e.g., when using the NGINX Ingress controller:
- See https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md
+ description: 'The annotations added to the ingress. This
+ can be used to set controller specific annotations,
+ e.g., when using the NGINX Ingress controller: See https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md'
type: object
auto:
description: To automatically add an ingress whenever
the integration uses an HTTP endpoint consumer.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -37072,14 +37962,18 @@ spec:
host:
description: To configure the host exposed by the ingress.
type: string
+ ingressClassName:
+ description: The Ingress class name as defined by the
+ Ingress spec See https://kubernetes.io/docs/concepts/services-networking/ingress/
+ type: string
path:
description: To configure the path exposed by the ingress
(default `/`).
type: string
pathType:
- description: |-
- To configure the path type exposed by the ingress.
- One of `Exact`, `Prefix`, `ImplementationSpecific` (default to `Prefix`).
+ description: To configure the path type exposed by the
+ ingress. One of `Exact`, `Prefix`, `ImplementationSpecific`
+ (default to `Prefix`).
enum:
- Exact
- Prefix
@@ -37104,9 +37998,8 @@ spec:
default).
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -37123,23 +38016,25 @@ spec:
description: The configuration of Jolokia trait
properties:
CACert:
- description: |-
- The PEM encoded CA certification file path, used to verify client certificates,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt` for OpenShift).
+ description: The PEM encoded CA certification file path,
+ used to verify client certificates, applicable when
+ `protocol` is `https` and `use-ssl-client-authentication`
+ is `true` (default `/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt`
+ for OpenShift).
type: string
clientPrincipal:
- description: |-
- The principal(s) which must be given in a client certificate to allow access to the Jolokia endpoint,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `clientPrincipal=cn=system:master-proxy`, `cn=hawtio-online.hawtio.svc` and `cn=fuse-console.fuse.svc` for OpenShift).
+ description: The principal(s) which must be given in a
+ client certificate to allow access to the Jolokia endpoint,
+ applicable when `protocol` is `https` and `use-ssl-client-authentication`
+ is `true` (default `clientPrincipal=cn=system:master-proxy`,
+ `cn=hawtio-online.hawtio.svc` and `cn=fuse-console.fuse.svc`
+ for OpenShift).
items:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
discoveryEnabled:
@@ -37150,20 +38045,20 @@ spec:
All traits share this common property.
type: boolean
extendedClientCheck:
- description: |-
- Mandate the client certificate contains a client flag in the extended key usage section,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `true` for OpenShift).
+ description: Mandate the client certificate contains a
+ client flag in the extended key usage section, applicable
+ when `protocol` is `https` and `use-ssl-client-authentication`
+ is `true` (default `true` for OpenShift).
type: boolean
host:
- description: |-
- The Host address to which the Jolokia agent should bind to. If `"\*"` or `"0.0.0.0"` is given,
- the servers binds to every network interface (default `"*"`).
+ description: The Host address to which the Jolokia agent
+ should bind to. If `"\*"` or `"0.0.0.0"` is given, the
+ servers binds to every network interface (default `"*"`).
type: string
options:
- description: |-
- A list of additional Jolokia options as defined
- in https://jolokia.org/reference/html/agents.html#agent-jvm-config[JVM agent configuration options]
+ description: A list of additional Jolokia options as defined
+ in https://jolokia.org/reference/html/agents.html#agent-jvm-config[JVM
+ agent configuration options]
items:
type: string
type: array
@@ -37194,9 +38089,8 @@ spec:
separator)
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
debug:
@@ -37225,9 +38119,9 @@ spec:
type: string
type: array
printCommand:
- description: |-
- Prints the command used the start the JVM in the container logs (default `true`)
- Deprecated: no longer in use.
+ description: 'Prints the command used the start the JVM
+ in the container logs (default `true`) Deprecated: no
+ longer in use.'
type: boolean
type: object
kamelets:
@@ -37238,9 +38132,8 @@ spec:
and their default configuration (enabled by default)
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -37273,16 +38166,16 @@ spec:
description: Enable automatic discovery of all trait properties.
type: boolean
channelSinks:
- description: |-
- List of channels used as destination of integration routes.
- Can contain simple channel names or full Camel URIs.
+ description: List of channels used as destination of integration
+ routes. Can contain simple channel names or full Camel
+ URIs.
items:
type: string
type: array
channelSources:
- description: |-
- List of channels used as source of integration routes.
- Can contain simple channel names or full Camel URIs.
+ description: List of channels used as source of integration
+ routes. Can contain simple channel names or full Camel
+ URIs.
items:
type: string
type: array
@@ -37291,9 +38184,8 @@ spec:
configuration in JSON format.
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -37301,9 +38193,9 @@ spec:
All traits share this common property.
type: boolean
endpointSinks:
- description: |-
- List of endpoints used as destination of integration routes.
- Can contain simple endpoint names or full Camel URIs.
+ description: List of endpoints used as destination of
+ integration routes. Can contain simple endpoint names
+ or full Camel URIs.
items:
type: string
type: array
@@ -37314,49 +38206,56 @@ spec:
type: string
type: array
eventSinks:
- description: |-
- List of event types that the integration will produce.
- Can contain simple event types or full Camel URIs (to use a specific broker).
+ description: List of event types that the integration
+ will produce. Can contain simple event types or full
+ Camel URIs (to use a specific broker).
items:
type: string
type: array
eventSources:
- description: |-
- List of event types that the integration will be subscribed to.
- Can contain simple event types or full Camel URIs (to use a specific broker different from "default").
+ description: List of event types that the integration
+ will be subscribed to. Can contain simple event types
+ or full Camel URIs (to use a specific broker different
+ from "default").
items:
type: string
type: array
filterEventType:
- description: |-
- Enables the default filtering for the Knative trigger using the event type
- If this is true, the created Knative trigger uses the event type as a filter on the event stream when no other filter criteria is given. (default: true)
+ description: 'Enables the default filtering for the Knative
+ trigger using the event type If this is true, the created
+ Knative trigger uses the event type as a filter on the
+ event stream when no other filter criteria is given.
+ (default: true)'
type: boolean
filterSourceChannels:
- description: |-
- Enables filtering on events based on the header "ce-knativehistory". Since this header has been removed in newer versions of
- Knative, filtering is disabled by default.
+ description: Enables filtering on events based on the
+ header "ce-knativehistory". Since this header has been
+ removed in newer versions of Knative, filtering is disabled
+ by default.
type: boolean
filters:
- description: |-
- Sets filter attributes on the event stream (such as event type, source, subject and so on).
- A list of key-value pairs that represent filter attributes and its values.
- The syntax is KEY=VALUE, e.g., `source="my.source"`.
- Filter attributes get set on the Knative trigger that is being created as part of this integration.
+ description: Sets filter attributes on the event stream
+ (such as event type, source, subject and so on). A list
+ of key-value pairs that represent filter attributes
+ and its values. The syntax is KEY=VALUE, e.g., `source="my.source"`.
+ Filter attributes get set on the Knative trigger that
+ is being created as part of this integration.
items:
type: string
type: array
namespaceLabel:
- description: |-
- Enables the camel-k-operator to set the "bindings.knative.dev/include=true" label to the namespace
- As Knative requires this label to perform injection of K_SINK URL into the service.
- If this is false, the integration pod may start and fail, read the SinkBinding Knative documentation. (default: true)
+ description: 'Enables the camel-k-operator to set the
+ "bindings.knative.dev/include=true" label to the namespace
+ As Knative requires this label to perform injection
+ of K_SINK URL into the service. If this is false, the
+ integration pod may start and fail, read the SinkBinding
+ Knative documentation. (default: true)'
type: boolean
sinkBinding:
- description: |-
- Allows binding the integration to a sink via a Knative SinkBinding resource.
- This can be used when the integration targets a single sink.
- It's enabled by default when the integration targets a single sink
+ description: Allows binding the integration to a sink
+ via a Knative SinkBinding resource. This can be used
+ when the integration targets a single sink. It's enabled
+ by default when the integration targets a single sink
(except when the integration is owned by a Knative source).
type: boolean
type: object
@@ -37366,47 +38265,41 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to route.
- This can be used to set knative service specific annotations
- CLI usage example: -t "knative-service.annotations.'haproxy.router.openshift.io/balance'=true"
+ description: 'The annotations added to route. This can
+ be used to set knative service specific annotations
+ CLI usage example: -t "knative-service.annotations.''haproxy.router.openshift.io/balance''=true"'
type: object
auto:
- description: |-
- Automatically deploy the integration as Knative service when all conditions hold:
-
-
- * Integration is using the Knative profile
- * All routes are either starting from an HTTP based consumer or a passive consumer (e.g. `direct` is a passive consumer)
+ description: "Automatically deploy the integration as
+ Knative service when all conditions hold: \n * Integration
+ is using the Knative profile * All routes are either
+ starting from an HTTP based consumer or a passive consumer
+ (e.g. `direct` is a passive consumer)"
type: boolean
autoscalingMetric:
- description: |-
- Configures the Knative autoscaling metric property (e.g. to set `concurrency` based or `cpu` based autoscaling).
-
-
- Refer to the Knative documentation for more information.
+ description: "Configures the Knative autoscaling metric
+ property (e.g. to set `concurrency` based or `cpu` based
+ autoscaling). \n Refer to the Knative documentation
+ for more information."
type: string
autoscalingTarget:
- description: |-
- Sets the allowed concurrency level or CPU percentage (depending on the autoscaling metric) for each Pod.
-
-
- Refer to the Knative documentation for more information.
+ description: "Sets the allowed concurrency level or CPU
+ percentage (depending on the autoscaling metric) for
+ each Pod. \n Refer to the Knative documentation for
+ more information."
type: integer
class:
- description: |-
- Configures the Knative autoscaling class property (e.g. to set `hpa.autoscaling.knative.dev` or `kpa.autoscaling.knative.dev` autoscaling).
-
-
- Refer to the Knative documentation for more information.
+ description: "Configures the Knative autoscaling class
+ property (e.g. to set `hpa.autoscaling.knative.dev`
+ or `kpa.autoscaling.knative.dev` autoscaling). \n Refer
+ to the Knative documentation for more information."
enum:
- kpa.autoscaling.knative.dev
- hpa.autoscaling.knative.dev
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -37414,43 +38307,38 @@ spec:
All traits share this common property.
type: boolean
maxScale:
- description: |-
- An upper bound for the number of Pods that can be running in parallel for the integration.
- Knative has its own cap value that depends on the installation.
-
-
- Refer to the Knative documentation for more information.
+ description: "An upper bound for the number of Pods that
+ can be running in parallel for the integration. Knative
+ has its own cap value that depends on the installation.
+ \n Refer to the Knative documentation for more information."
type: integer
minScale:
- description: |-
- The minimum number of Pods that should be running at any time for the integration. It's **zero** by default, meaning that
- the integration is scaled down to zero when not used for a configured amount of time.
-
-
- Refer to the Knative documentation for more information.
+ description: "The minimum number of Pods that should be
+ running at any time for the integration. It's **zero**
+ by default, meaning that the integration is scaled down
+ to zero when not used for a configured amount of time.
+ \n Refer to the Knative documentation for more information."
type: integer
rolloutDuration:
- description: |-
- Enables to gradually shift traffic to the latest Revision and sets the rollout duration.
- It's disabled by default and must be expressed as a Golang `time.Duration` string representation,
- rounded to a second precision.
+ description: Enables to gradually shift traffic to the
+ latest Revision and sets the rollout duration. It's
+ disabled by default and must be expressed as a Golang
+ `time.Duration` string representation, rounded to a
+ second precision.
type: string
timeoutSeconds:
- description: |-
- The maximum duration in seconds that the request instance is allowed to respond to a request.
+ description: "The maximum duration in seconds that the
+ request instance is allowed to respond to a request.
This field propagates to the integration pod's terminationGracePeriodSeconds
-
-
- Refer to the Knative documentation for more information.
+ \n Refer to the Knative documentation for more information."
format: int64
type: integer
visibility:
- description: |-
- Setting `cluster-local`, Knative service becomes a private service.
- Specifically, this option applies the `networking.knative.dev/visibility` label to Knative service.
-
-
- Refer to the Knative documentation for more information.
+ description: "Setting `cluster-local`, Knative service
+ becomes a private service. Specifically, this option
+ applies the `networking.knative.dev/visibility` label
+ to Knative service. \n Refer to the Knative documentation
+ for more information."
enum:
- cluster-local
type: string
@@ -37462,9 +38350,8 @@ spec:
description: Colorize the log output
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -37504,18 +38391,20 @@ spec:
description: The configuration of Mount trait
properties:
configs:
- description: |-
- A list of configuration pointing to configmap/secret.
- The configuration are expected to be UTF-8 resources as they are processed by runtime Camel Context and tried to be parsed as property files.
- They are also made available on the classpath in order to ease their usage directly from the Route.
- Syntax: [configmap|secret]:name[/key], where name represents the resource name and key optionally represents the resource key to be filtered
+ description: 'A list of configuration pointing to configmap/secret.
+ The configuration are expected to be UTF-8 resources
+ as they are processed by runtime Camel Context and tried
+ to be parsed as property files. They are also made available
+ on the classpath in order to ease their usage directly
+ from the Route. Syntax: [configmap|secret]:name[/key],
+ where name represents the resource name and key optionally
+ represents the resource key to be filtered'
items:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
emptyDirs:
@@ -37528,17 +38417,21 @@ spec:
description: 'Deprecated: no longer in use.'
type: boolean
hotReload:
- description: |-
- Enable "hot reload" when a secret/configmap mounted is edited (default `false`). The configmap/secret must be
- marked with `camel.apache.org/integration` label to be taken in account. The resource will be watched for any kind change, also for
- changes in metadata.
+ description: Enable "hot reload" when a secret/configmap
+ mounted is edited (default `false`). The configmap/secret
+ must be marked with `camel.apache.org/integration` label
+ to be taken in account. The resource will be watched
+ for any kind change, also for changes in metadata.
type: boolean
resources:
- description: |-
- A list of resources (text or binary content) pointing to configmap/secret.
- The resources are expected to be any resource type (text or binary content).
- The destination path can be either a default location or any path specified by the user.
- Syntax: [configmap|secret]:name[/key][@path], where name represents the resource name, key optionally represents the resource key to be filtered and path represents the destination path
+ description: 'A list of resources (text or binary content)
+ pointing to configmap/secret. The resources are expected
+ to be any resource type (text or binary content). The
+ destination path can be either a default location or
+ any path specified by the user. Syntax: [configmap|secret]:name[/key][@path],
+ where name represents the resource name, key optionally
+ represents the resource key to be filtered and path
+ represents the destination path'
items:
type: string
type: array
@@ -37563,9 +38456,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -37576,9 +38468,8 @@ spec:
description: The configuration of Owner trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -37600,9 +38491,8 @@ spec:
description: The configuration of PDB trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -37610,53 +38500,56 @@ spec:
All traits share this common property.
type: boolean
maxUnavailable:
- description: |-
- The number of pods for the Integration that can be unavailable after an eviction.
- It can be either an absolute number or a percentage (default `1` if `min-available` is also not set).
- Only one of `max-unavailable` and `min-available` can be specified.
+ description: The number of pods for the Integration that
+ can be unavailable after an eviction. It can be either
+ an absolute number or a percentage (default `1` if `min-available`
+ is also not set). Only one of `max-unavailable` and
+ `min-available` can be specified.
type: string
minAvailable:
- description: |-
- The number of pods for the Integration that must still be available after an eviction.
- It can be either an absolute number or a percentage.
- Only one of `min-available` and `max-unavailable` can be specified.
+ description: The number of pods for the Integration that
+ must still be available after an eviction. It can be
+ either an absolute number or a percentage. Only one
+ of `min-available` and `max-unavailable` can be specified.
type: string
type: object
platform:
description: The configuration of Platform trait
properties:
auto:
- description: |-
- To automatically detect from the environment if a default platform can be created (it will be created on OpenShift or when a registry address is set).
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'To automatically detect from the environment
+ if a default platform can be created (it will be created
+ on OpenShift or when a registry address is set). Deprecated:
+ Platform is auto generated by the operator install procedure
+ - maintained for backward compatibility'
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
createDefault:
- description: |-
- To create a default (empty) platform when the platform is missing.
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'To create a default (empty) platform when
+ the platform is missing. Deprecated: Platform is auto
+ generated by the operator install procedure - maintained
+ for backward compatibility'
type: boolean
enabled:
description: 'Deprecated: no longer in use.'
type: boolean
global:
- description: |-
- Indicates if the platform should be created globally in the case of global operator (default true).
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'Indicates if the platform should be created
+ globally in the case of global operator (default true).
+ Deprecated: Platform is auto generated by the operator
+ install procedure - maintained for backward compatibility'
type: boolean
type: object
pod:
description: The configuration of Pod trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -37668,9 +38561,8 @@ spec:
description: The configuration of Prometheus trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -37696,9 +38588,8 @@ spec:
secret on the pod if it is of type `kubernetes.io/dockerconfigjson`.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -37721,10 +38612,11 @@ spec:
description: The configuration of Quarkus trait
properties:
buildMode:
- description: |-
- The Quarkus mode to run: either `jvm` or `native` (default `jvm`).
- In case both `jvm` and `native` are specified, two `IntegrationKit` resources are created,
- with the `native` kit having precedence over the `jvm` one once ready.
+ description: 'The Quarkus mode to run: either `jvm` or
+ `native` (default `jvm`). In case both `jvm` and `native`
+ are specified, two `IntegrationKit` resources are created,
+ with the `native` kit having precedence over the `jvm`
+ one once ready.'
items:
description: QuarkusMode is the type of Quarkus build
packaging.
@@ -37734,9 +38626,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -37752,18 +38643,19 @@ spec:
in the runtime catalog)
type: string
packageTypes:
- description: |-
- The Quarkus package types, `fast-jar` or `native` (default `fast-jar`).
- In case both `fast-jar` and `native` are specified, two `IntegrationKit` resources are created,
- with the native kit having precedence over the `fast-jar` one once ready.
- The order influences the resolution of the current kit for the integration.
- The kit corresponding to the first package type will be assigned to the
- integration in case no existing kit that matches the integration exists.
- Deprecated: use `build-mode` instead.
+ description: 'The Quarkus package types, `fast-jar` or
+ `native` (default `fast-jar`). In case both `fast-jar`
+ and `native` are specified, two `IntegrationKit` resources
+ are created, with the native kit having precedence over
+ the `fast-jar` one once ready. The order influences
+ the resolution of the current kit for the integration.
+ The kit corresponding to the first package type will
+ be assigned to the integration in case no existing kit
+ that matches the integration exists. Deprecated: use
+ `build-mode` instead.'
items:
- description: |-
- QuarkusPackageType is the type of Quarkus build packaging.
- Deprecated: use `QuarkusMode` instead.
+ description: 'QuarkusPackageType is the type of Quarkus
+ build packaging. Deprecated: use `QuarkusMode` instead.'
enum:
- fast-jar
- native
@@ -37771,14 +38663,13 @@ spec:
type: array
type: object
registry:
- description: |-
- The configuration of Registry trait (support removed since version 2.5.0).
- Deprecated: use jvm trait or read documentation.
+ description: 'The configuration of Registry trait (support
+ removed since version 2.5.0). Deprecated: use jvm trait
+ or read documentation.'
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -37792,16 +38683,14 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to route.
- This can be used to set route specific annotations
- For annotations options see https://docs.openshift.com/container-platform/3.11/architecture/networking/routes.html#route-specific-annotations
- CLI usage example: -t "route.annotations.'haproxy.router.openshift.io/balance'=true"
+ description: 'The annotations added to route. This can
+ be used to set route specific annotations For annotations
+ options see https://docs.openshift.com/container-platform/3.11/architecture/networking/routes.html#route-specific-annotations
+ CLI usage example: -t "route.annotations.''haproxy.router.openshift.io/balance''=true"'
type: object
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -37812,82 +38701,82 @@ spec:
description: To configure the host exposed by the route.
type: string
tlsCACertificate:
- description: |-
- The TLS CA certificate contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS CA certificate contents. \n Refer
+ to the OpenShift route documentation for additional
+ information."
type: string
tlsCACertificateSecret:
- description: |-
- The secret name and key reference to the TLS CA certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the
+ TLS CA certificate. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only
+ one key in the secret it will be read, otherwise you
+ can set a key name separated with a \"/\". \n Refer
+ to the OpenShift route documentation for additional
+ information."
type: string
tlsCertificate:
- description: |-
- The TLS certificate contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS certificate contents. \n Refer to
+ the OpenShift route documentation for additional information."
type: string
tlsCertificateSecret:
- description: |-
- The secret name and key reference to the TLS certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the
+ TLS certificate. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only
+ one key in the secret it will be read, otherwise you
+ can set a key name separated with a \"/\". \n Refer
+ to the OpenShift route documentation for additional
+ information."
type: string
tlsDestinationCACertificate:
- description: |-
- The destination CA certificate provides the contents of the ca certificate of the final destination. When using reencrypt
- termination this file should be provided in order to have routers use it for health checks on the secure connection.
- If this field is not specified, the router may provide its own destination CA and perform hostname validation using
- the short service name (service.namespace.svc), which allows infrastructure generated certificates to automatically
- verify.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The destination CA certificate provides
+ the contents of the ca certificate of the final destination.
+ \ When using reencrypt termination this file should
+ be provided in order to have routers use it for health
+ checks on the secure connection. If this field is not
+ specified, the router may provide its own destination
+ CA and perform hostname validation using the short service
+ name (service.namespace.svc), which allows infrastructure
+ generated certificates to automatically verify. \n Refer
+ to the OpenShift route documentation for additional
+ information."
type: string
tlsDestinationCACertificateSecret:
- description: |-
- The secret name and key reference to the destination CA certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the
+ destination CA certificate. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only
+ one key in the secret it will be read, otherwise you
+ can set a key name separated with a \"/\". \n Refer
+ to the OpenShift route documentation for additional
+ information."
type: string
tlsInsecureEdgeTerminationPolicy:
- description: |-
- To configure how to deal with insecure traffic, e.g. `Allow`, `Disable` or `Redirect` traffic.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "To configure how to deal with insecure traffic,
+ e.g. `Allow`, `Disable` or `Redirect` traffic. \n Refer
+ to the OpenShift route documentation for additional
+ information."
enum:
- None
- Allow
- Redirect
type: string
tlsKey:
- description: |-
- The TLS certificate key contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS certificate key contents. \n Refer
+ to the OpenShift route documentation for additional
+ information."
type: string
tlsKeySecret:
- description: |-
- The secret name and key reference to the TLS certificate key. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the
+ TLS certificate key. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only
+ one key in the secret it will be read, otherwise you
+ can set a key name separated with a \"/\". \n Refer
+ to the OpenShift route documentation for additional
+ information."
type: string
tlsTermination:
- description: |-
- The TLS termination type, like `edge`, `passthrough` or `reencrypt`.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS termination type, like `edge`, `passthrough`
+ or `reencrypt`. \n Refer to the OpenShift route documentation
+ for additional information."
enum:
- edge
- reencrypt
@@ -37898,9 +38787,8 @@ spec:
description: The configuration of Security Context trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -37932,9 +38820,8 @@ spec:
a Service needs to be created.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -37942,9 +38829,8 @@ spec:
All traits share this common property.
type: boolean
nodePort:
- description: |-
- Enable Service to be exposed as NodePort (default `false`).
- Deprecated: Use service type instead.
+ description: 'Enable Service to be exposed as NodePort
+ (default `false`). Deprecated: Use service type instead.'
type: boolean
type:
description: The type of service to be used, either 'ClusterIP',
@@ -37959,9 +38845,8 @@ spec:
description: The configuration of Service Binding trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -37988,9 +38873,8 @@ spec:
description: The configuration of Toleration trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -38055,43 +38939,35 @@ spec:
description: API version of the referent.
type: string
fieldPath:
- description: |-
- If referring to a piece of an object instead of an entire object, this string
- should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
- For example, if the object reference is to a container within a pod, this would take on a value like:
- "spec.containers{name}" (where "name" refers to the name of the container that triggered
- the event) or if no container name is specified "spec.containers[2]" (container with
- index 2 in this pod). This syntax is chosen only to have some well-defined way of
- referencing a part of an object.
- TODO: this design is not final and this field is subject to change in the future.
+ description: 'If referring to a piece of an object instead
+ of an entire object, this string should contain a valid
+ JSON/Go field access statement, such as desiredState.manifest.containers[2].
+ For example, if the object reference is to a container within
+ a pod, this would take on a value like: "spec.containers{name}"
+ (where "name" refers to the name of the container that triggered
+ the event) or if no container name is specified "spec.containers[2]"
+ (container with index 2 in this pod). This syntax is chosen
+ only to have some well-defined way of referencing a part
+ of an object. TODO: this design is not final and this field
+ is subject to change in the future.'
type: string
kind:
- description: |-
- Kind of the referent.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ 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: 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'
type: string
namespace:
- description: |-
- Namespace of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
+ description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type: string
resourceVersion:
- description: |-
- Specific resourceVersion to which this reference is made, if any.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
+ description: 'Specific resourceVersion to which this reference
+ is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
type: string
uid:
- description: |-
- UID of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
+ description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
type: string
type: object
- x-kubernetes-map-type: atomic
uri:
description: URI can be used to specify the (Camel) endpoint explicitly
type: string
@@ -38128,43 +39004,35 @@ spec:
description: API version of the referent.
type: string
fieldPath:
- description: |-
- If referring to a piece of an object instead of an entire object, this string
- should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
- For example, if the object reference is to a container within a pod, this would take on a value like:
- "spec.containers{name}" (where "name" refers to the name of the container that triggered
- the event) or if no container name is specified "spec.containers[2]" (container with
- index 2 in this pod). This syntax is chosen only to have some well-defined way of
- referencing a part of an object.
- TODO: this design is not final and this field is subject to change in the future.
+ description: 'If referring to a piece of an object instead
+ of an entire object, this string should contain a valid
+ JSON/Go field access statement, such as desiredState.manifest.containers[2].
+ For example, if the object reference is to a container within
+ a pod, this would take on a value like: "spec.containers{name}"
+ (where "name" refers to the name of the container that triggered
+ the event) or if no container name is specified "spec.containers[2]"
+ (container with index 2 in this pod). This syntax is chosen
+ only to have some well-defined way of referencing a part
+ of an object. TODO: this design is not final and this field
+ is subject to change in the future.'
type: string
kind:
- description: |-
- Kind of the referent.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ 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: 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'
type: string
namespace:
- description: |-
- Namespace of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
+ description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type: string
resourceVersion:
- description: |-
- Specific resourceVersion to which this reference is made, if any.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
+ description: 'Specific resourceVersion to which this reference
+ is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
type: string
uid:
- description: |-
- UID of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
+ description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
type: string
type: object
- x-kubernetes-map-type: atomic
uri:
description: URI can be used to specify the (Camel) endpoint explicitly
type: string
@@ -38204,43 +39072,36 @@ spec:
description: API version of the referent.
type: string
fieldPath:
- description: |-
- If referring to a piece of an object instead of an entire object, this string
- should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
- For example, if the object reference is to a container within a pod, this would take on a value like:
- "spec.containers{name}" (where "name" refers to the name of the container that triggered
- the event) or if no container name is specified "spec.containers[2]" (container with
- index 2 in this pod). This syntax is chosen only to have some well-defined way of
- referencing a part of an object.
- TODO: this design is not final and this field is subject to change in the future.
+ description: 'If referring to a piece of an object instead
+ of an entire object, this string should contain a valid
+ JSON/Go field access statement, such as desiredState.manifest.containers[2].
+ For example, if the object reference is to a container
+ within a pod, this would take on a value like: "spec.containers{name}"
+ (where "name" refers to the name of the container that
+ triggered the event) or if no container name is specified
+ "spec.containers[2]" (container with index 2 in this pod).
+ This syntax is chosen only to have some well-defined way
+ of referencing a part of an object. TODO: this design
+ is not final and this field is subject to change in the
+ future.'
type: string
kind:
- description: |-
- Kind of the referent.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ 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: 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'
type: string
namespace:
- description: |-
- Namespace of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
+ description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type: string
resourceVersion:
- description: |-
- Specific resourceVersion to which this reference is made, if any.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
+ description: 'Specific resourceVersion to which this reference
+ is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
type: string
uid:
- description: |-
- UID of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
+ description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
type: string
type: object
- x-kubernetes-map-type: atomic
uri:
description: URI can be used to specify the (Camel) endpoint
explicitly
@@ -38297,15 +39158,12 @@ spec:
the condition's last transition.
type: string
status:
- description: |-
- Status is the status of the condition.
- Can be True, False, Unknown.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
+ description: 'Status is the status of the condition.
+ Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions'
type: string
type:
- description: |-
- Type is the type of the condition.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
+ description: 'Type is the type of the condition. More
+ info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions'
type: string
required:
- status
@@ -38315,10 +39173,10 @@ spec:
items:
properties:
data:
- description: |-
- RawMessage is a raw encoded JSON value.
+ description: RawMessage is a raw encoded JSON value.
It implements Marshaler and Unmarshaler and can
- be used to delay JSON decoding or precompute a JSON encoding.
+ be used to delay JSON decoding or precompute a
+ JSON encoding.
x-kubernetes-preserve-unknown-fields: true
name:
type: string
@@ -38371,3 +39229,9 @@ spec:
specReplicasPath: .spec.replicas
statusReplicasPath: .status.replicas
status: {}
+status:
+ acceptedNames:
+ kind: ""
+ plural: ""
+ conditions: []
+ storedVersions: []
diff --git a/pkg/apis/camel/v1/trait/ingress.go b/pkg/apis/camel/v1/trait/ingress.go
index a211ae4b62..7cd1653116 100644
--- a/pkg/apis/camel/v1/trait/ingress.go
+++ b/pkg/apis/camel/v1/trait/ingress.go
@@ -27,6 +27,9 @@ import networkingv1 "k8s.io/api/networking/v1"
// +camel-k:trait=ingress.
type IngressTrait struct {
Trait `property:",squash" json:",inline"`
+ // The Ingress class name as defined by the Ingress spec
+ // See https://kubernetes.io/docs/concepts/services-networking/ingress/
+ IngressClassName string `property:"ingress-class-name" json:"ingressClassName,omitempty"`
// The annotations added to the ingress.
// This can be used to set controller specific annotations, e.g., when using the NGINX Ingress controller:
// See https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md
diff --git a/pkg/apis/camel/v1/trait/zz_generated.deepcopy.go b/pkg/apis/camel/v1/trait/zz_generated.deepcopy.go
index 734f102969..f6ea343b08 100644
--- a/pkg/apis/camel/v1/trait/zz_generated.deepcopy.go
+++ b/pkg/apis/camel/v1/trait/zz_generated.deepcopy.go
@@ -1,4 +1,5 @@
//go:build !ignore_autogenerated
+// +build !ignore_autogenerated
// Code generated by controller-gen. DO NOT EDIT.
diff --git a/pkg/apis/camel/v1/zz_generated.deepcopy.go b/pkg/apis/camel/v1/zz_generated.deepcopy.go
index b3fb311675..d5df39c00a 100644
--- a/pkg/apis/camel/v1/zz_generated.deepcopy.go
+++ b/pkg/apis/camel/v1/zz_generated.deepcopy.go
@@ -1,4 +1,5 @@
//go:build !ignore_autogenerated
+// +build !ignore_autogenerated
// Code generated by controller-gen. DO NOT EDIT.
diff --git a/pkg/apis/camel/v1alpha1/zz_generated.deepcopy.go b/pkg/apis/camel/v1alpha1/zz_generated.deepcopy.go
index e1630d44fe..ee28852946 100644
--- a/pkg/apis/camel/v1alpha1/zz_generated.deepcopy.go
+++ b/pkg/apis/camel/v1alpha1/zz_generated.deepcopy.go
@@ -1,4 +1,5 @@
//go:build !ignore_autogenerated
+// +build !ignore_autogenerated
// Code generated by controller-gen. DO NOT EDIT.
diff --git a/pkg/resources/config/crd/bases/camel.apache.org_builds.yaml b/pkg/resources/config/crd/bases/camel.apache.org_builds.yaml
index 3c0cc4bba8..8042dfe730 100644
--- a/pkg/resources/config/crd/bases/camel.apache.org_builds.yaml
+++ b/pkg/resources/config/crd/bases/camel.apache.org_builds.yaml
@@ -15,12 +15,14 @@
# limitations under the License.
# ---------------------------------------------------------------------------
+
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
- controller-gen.kubebuilder.io/version: v0.15.0
+ controller-gen.kubebuilder.io/version: v0.6.1
+ creationTimestamp: null
name: builds.camel.apache.org
spec:
group: camel.apache.org
@@ -63,31 +65,26 @@ spec:
description: Build is the Schema for the builds API.
properties:
apiVersion:
- description: |-
- APIVersion defines the versioned schema of this representation of an object.
- Servers should convert recognized schemas to the latest internal value, and
- may reject unrecognized values.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+ description: 'APIVersion defines the versioned schema of this representation
+ of an object. Servers should convert recognized schemas to the latest
+ internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: |-
- Kind is a string value representing the REST resource this object represents.
- Servers may infer this from the endpoint the client submits requests to.
- Cannot be updated.
- In CamelCase.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ description: 'Kind is a string value representing the REST resource this
+ object represents. Servers may infer this from the endpoint the client
+ submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
spec:
- description: |-
- BuildSpec defines the list of tasks to be execute for a Build. From Camel K version 2, it would be more appropriate
- to think it as pipeline.
+ description: BuildSpec defines the list of tasks to be execute for a Build.
+ From Camel K version 2, it would be more appropriate to think it as
+ pipeline.
properties:
configuration:
- description: |-
- The configuration that should be used to perform the Build.
- Deprecated: no longer in use in Camel K 2 - maintained for backward compatibility
+ description: 'The configuration that should be used to perform the
+ Build. Deprecated: no longer in use in Camel K 2 - maintained for
+ backward compatibility'
properties:
annotations:
additionalProperties:
@@ -145,15 +142,16 @@ spec:
type: string
type: object
maxRunningBuilds:
- description: |-
- the maximum amount of parallel running builds started by this operator instance
- Deprecated: no longer in use in Camel K 2 - maintained for backward compatibility
+ description: 'the maximum amount of parallel running builds started
+ by this operator instance Deprecated: no longer in use in Camel
+ K 2 - maintained for backward compatibility'
format: int32
type: integer
operatorNamespace:
- description: |-
- The namespace where to run the builder Pod (must be the same of the operator in charge of this Build reconciliation).
- Deprecated: no longer in use in Camel K 2 - maintained for backward compatibility
+ description: 'The namespace where to run the builder Pod (must be
+ the same of the operator in charge of this Build reconciliation).
+ Deprecated: no longer in use in Camel K 2 - maintained for backward
+ compatibility'
type: string
tasks:
description: The sequence of tasks (pipeline) to be performed.
@@ -162,9 +160,8 @@ spec:
task should be configured to represent the specific task chosen.
properties:
buildah:
- description: |-
- a BuildahTask, for Buildah strategy
- Deprecated: use jib, s2i or a custom publishing strategy instead
+ description: 'a BuildahTask, for Buildah strategy Deprecated:
+ use jib, s2i or a custom publishing strategy instead'
properties:
baseImage:
description: base image layer
@@ -350,13 +347,15 @@ spec:
application build phase
properties:
caSecrets:
- description: |-
- The Secrets name and key, containing the CA certificate(s) used to connect
- to remote Maven repositories.
- It can contain X.509 certificates, and PKCS#7 formatted certificate chains.
- A JKS formatted keystore is automatically created to store the CA certificate(s),
- and configured to be used as a trusted certificate(s) by the Maven commands.
- Note that the root CA certificates are also imported into the created keystore.
+ description: The Secrets name and key, containing the
+ CA certificate(s) used to connect to remote Maven
+ repositories. It can contain X.509 certificates, and
+ PKCS#7 formatted certificate chains. A JKS formatted
+ keystore is automatically created to store the CA
+ certificate(s), and configured to be used as a trusted
+ certificate(s) by the Maven commands. Note that the
+ root CA certificates are also imported into the created
+ keystore.
items:
description: SecretKeySelector selects a key of a
Secret.
@@ -366,10 +365,10 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the Secret or its
@@ -378,20 +377,16 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: array
cliOptions:
- description: |-
- The CLI options that are appended to the list of arguments for Maven commands,
- e.g., `-V,--no-transfer-progress,-Dstyle.color=never`.
+ description: The CLI options that are appended to the
+ list of arguments for Maven commands, e.g., `-V,--no-transfer-progress,-Dstyle.color=never`.
See https://maven.apache.org/ref/3.8.4/maven-embedder/cli.html.
items:
type: string
type: array
extension:
- description: |-
- The Maven build extensions.
- See https://maven.apache.org/guides/mini/guide-using-extensions.html.
+ description: The Maven build extensions. See https://maven.apache.org/guides/mini/guide-using-extensions.html.
items:
description: MavenArtifact defines a GAV (Group:Artifact:Type:Version:Classifier)
Maven artifact.
@@ -420,9 +415,8 @@ spec:
description: The path of the local Maven repository.
type: string
profiles:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the Maven profile.
+ description: A reference to the ConfigMap or Secret
+ key that contains the Maven profile.
items:
description: ValueSource --.
properties:
@@ -433,10 +427,10 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
@@ -445,7 +439,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -454,10 +447,10 @@ spec:
from. Must be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret or
@@ -466,7 +459,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
properties:
@@ -489,18 +481,23 @@ spec:
description: can use stable releases
properties:
checksumPolicy:
- description: |-
- When Maven deploys files to the repository, it also deploys corresponding checksum files.
- Your options are to `ignore`, `fail`, or `warn` on missing or incorrect checksums.
+ description: When Maven deploys files to the
+ repository, it also deploys corresponding
+ checksum files. Your options are to `ignore`,
+ `fail`, or `warn` on missing or incorrect
+ checksums.
type: string
enabled:
description: is the policy activated or not
type: boolean
updatePolicy:
- description: |-
- This element specifies how often updates should attempt to occur.
- Maven will compare the local POM's timestamp (stored in a repository's maven-metadata file) to the remote.
- The choices are: `always`, `daily` (default), `interval:X` (where X is an integer in minutes) or `never`
+ description: 'This element specifies how often
+ updates should attempt to occur. Maven will
+ compare the local POM''s timestamp (stored
+ in a repository''s maven-metadata file)
+ to the remote. The choices are: `always`,
+ `daily` (default), `interval:X` (where X
+ is an integer in minutes) or `never`'
type: string
required:
- enabled
@@ -509,18 +506,23 @@ spec:
description: can use snapshot
properties:
checksumPolicy:
- description: |-
- When Maven deploys files to the repository, it also deploys corresponding checksum files.
- Your options are to `ignore`, `fail`, or `warn` on missing or incorrect checksums.
+ description: When Maven deploys files to the
+ repository, it also deploys corresponding
+ checksum files. Your options are to `ignore`,
+ `fail`, or `warn` on missing or incorrect
+ checksums.
type: string
enabled:
description: is the policy activated or not
type: boolean
updatePolicy:
- description: |-
- This element specifies how often updates should attempt to occur.
- Maven will compare the local POM's timestamp (stored in a repository's maven-metadata file) to the remote.
- The choices are: `always`, `daily` (default), `interval:X` (where X is an integer in minutes) or `never`
+ description: 'This element specifies how often
+ updates should attempt to occur. Maven will
+ compare the local POM''s timestamp (stored
+ in a repository''s maven-metadata file)
+ to the remote. The choices are: `always`,
+ `daily` (default), `interval:X` (where X
+ is an integer in minutes) or `never`'
type: string
required:
- enabled
@@ -553,9 +555,8 @@ spec:
type: object
type: array
settings:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the Maven settings.
+ description: A reference to the ConfigMap or Secret
+ key that contains the Maven settings.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -564,10 +565,10 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap or
@@ -576,7 +577,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -585,10 +585,10 @@ spec:
from. Must be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret or its
@@ -597,12 +597,10 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
settingsSecurity:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the security of the Maven settings.
+ description: A reference to the ConfigMap or Secret
+ key that contains the security of the Maven settings.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -611,10 +609,10 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap or
@@ -623,7 +621,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -632,10 +629,10 @@ spec:
from. Must be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret or its
@@ -644,7 +641,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: object
name:
@@ -659,9 +655,9 @@ spec:
type: string
capabilities:
additionalProperties:
- description: |-
- Capability is a particular feature which requires a well known set of dependencies and other properties
- which are specified in the runtime catalog.
+ description: Capability is a particular feature which
+ requires a well known set of dependencies and other
+ properties which are specified in the runtime catalog.
properties:
buildTimeProperties:
description: Set of required Camel build time
@@ -802,9 +798,9 @@ spec:
Kamelet
type: boolean
interceptors:
- description: |-
- Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
- uses to pre/post process sources
+ description: Interceptors are optional identifiers
+ the org.apache.camel.k.RoutesLoader uses to pre/post
+ process sources
items:
type: string
type: array
@@ -813,9 +809,8 @@ spec:
DSL) used to interpret this source code
type: string
loader:
- description: |-
- Loader is an optional id of the org.apache.camel.k.RoutesLoader that will
- interpret this source at runtime
+ description: Loader is an optional id of the org.apache.camel.k.RoutesLoader
+ that will interpret this source at runtime
type: string
name:
description: the name of the specification
@@ -850,9 +845,7 @@ spec:
after the build and before the package task.
properties:
command:
- description: |-
- the command to execute
- Deprecated: use ContainerCommands
+ description: 'the command to execute Deprecated: use ContainerCommands'
type: string
commands:
description: the command to execute
@@ -1033,9 +1026,8 @@ spec:
type: object
type: object
kaniko:
- description: |-
- a KanikoTask, for Kaniko strategy
- Deprecated: use jib, s2i or a custom publishing strategy instead
+ description: 'a KanikoTask, for Kaniko strategy Deprecated:
+ use jib, s2i or a custom publishing strategy instead'
properties:
baseImage:
description: base image layer
@@ -1149,9 +1141,8 @@ spec:
type: boolean
type: object
package:
- description: |-
- Application pre publishing
- a PackageTask, used to package the project
+ description: Application pre publishing a PackageTask, used
+ to package the project
properties:
baseImage:
description: the base image layer
@@ -1230,13 +1221,15 @@ spec:
application build phase
properties:
caSecrets:
- description: |-
- The Secrets name and key, containing the CA certificate(s) used to connect
- to remote Maven repositories.
- It can contain X.509 certificates, and PKCS#7 formatted certificate chains.
- A JKS formatted keystore is automatically created to store the CA certificate(s),
- and configured to be used as a trusted certificate(s) by the Maven commands.
- Note that the root CA certificates are also imported into the created keystore.
+ description: The Secrets name and key, containing the
+ CA certificate(s) used to connect to remote Maven
+ repositories. It can contain X.509 certificates, and
+ PKCS#7 formatted certificate chains. A JKS formatted
+ keystore is automatically created to store the CA
+ certificate(s), and configured to be used as a trusted
+ certificate(s) by the Maven commands. Note that the
+ root CA certificates are also imported into the created
+ keystore.
items:
description: SecretKeySelector selects a key of a
Secret.
@@ -1246,10 +1239,10 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the Secret or its
@@ -1258,20 +1251,16 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: array
cliOptions:
- description: |-
- The CLI options that are appended to the list of arguments for Maven commands,
- e.g., `-V,--no-transfer-progress,-Dstyle.color=never`.
+ description: The CLI options that are appended to the
+ list of arguments for Maven commands, e.g., `-V,--no-transfer-progress,-Dstyle.color=never`.
See https://maven.apache.org/ref/3.8.4/maven-embedder/cli.html.
items:
type: string
type: array
extension:
- description: |-
- The Maven build extensions.
- See https://maven.apache.org/guides/mini/guide-using-extensions.html.
+ description: The Maven build extensions. See https://maven.apache.org/guides/mini/guide-using-extensions.html.
items:
description: MavenArtifact defines a GAV (Group:Artifact:Type:Version:Classifier)
Maven artifact.
@@ -1300,9 +1289,8 @@ spec:
description: The path of the local Maven repository.
type: string
profiles:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the Maven profile.
+ description: A reference to the ConfigMap or Secret
+ key that contains the Maven profile.
items:
description: ValueSource --.
properties:
@@ -1313,10 +1301,10 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
@@ -1325,7 +1313,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -1334,10 +1321,10 @@ spec:
from. Must be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret or
@@ -1346,7 +1333,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
properties:
@@ -1369,18 +1355,23 @@ spec:
description: can use stable releases
properties:
checksumPolicy:
- description: |-
- When Maven deploys files to the repository, it also deploys corresponding checksum files.
- Your options are to `ignore`, `fail`, or `warn` on missing or incorrect checksums.
+ description: When Maven deploys files to the
+ repository, it also deploys corresponding
+ checksum files. Your options are to `ignore`,
+ `fail`, or `warn` on missing or incorrect
+ checksums.
type: string
enabled:
description: is the policy activated or not
type: boolean
updatePolicy:
- description: |-
- This element specifies how often updates should attempt to occur.
- Maven will compare the local POM's timestamp (stored in a repository's maven-metadata file) to the remote.
- The choices are: `always`, `daily` (default), `interval:X` (where X is an integer in minutes) or `never`
+ description: 'This element specifies how often
+ updates should attempt to occur. Maven will
+ compare the local POM''s timestamp (stored
+ in a repository''s maven-metadata file)
+ to the remote. The choices are: `always`,
+ `daily` (default), `interval:X` (where X
+ is an integer in minutes) or `never`'
type: string
required:
- enabled
@@ -1389,18 +1380,23 @@ spec:
description: can use snapshot
properties:
checksumPolicy:
- description: |-
- When Maven deploys files to the repository, it also deploys corresponding checksum files.
- Your options are to `ignore`, `fail`, or `warn` on missing or incorrect checksums.
+ description: When Maven deploys files to the
+ repository, it also deploys corresponding
+ checksum files. Your options are to `ignore`,
+ `fail`, or `warn` on missing or incorrect
+ checksums.
type: string
enabled:
description: is the policy activated or not
type: boolean
updatePolicy:
- description: |-
- This element specifies how often updates should attempt to occur.
- Maven will compare the local POM's timestamp (stored in a repository's maven-metadata file) to the remote.
- The choices are: `always`, `daily` (default), `interval:X` (where X is an integer in minutes) or `never`
+ description: 'This element specifies how often
+ updates should attempt to occur. Maven will
+ compare the local POM''s timestamp (stored
+ in a repository''s maven-metadata file)
+ to the remote. The choices are: `always`,
+ `daily` (default), `interval:X` (where X
+ is an integer in minutes) or `never`'
type: string
required:
- enabled
@@ -1433,9 +1429,8 @@ spec:
type: object
type: array
settings:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the Maven settings.
+ description: A reference to the ConfigMap or Secret
+ key that contains the Maven settings.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -1444,10 +1439,10 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap or
@@ -1456,7 +1451,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -1465,10 +1459,10 @@ spec:
from. Must be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret or its
@@ -1477,12 +1471,10 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
settingsSecurity:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the security of the Maven settings.
+ description: A reference to the ConfigMap or Secret
+ key that contains the security of the Maven settings.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -1491,10 +1483,10 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap or
@@ -1503,7 +1495,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -1512,10 +1503,10 @@ spec:
from. Must be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret or its
@@ -1524,7 +1515,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: object
name:
@@ -1539,9 +1529,9 @@ spec:
type: string
capabilities:
additionalProperties:
- description: |-
- Capability is a particular feature which requires a well known set of dependencies and other properties
- which are specified in the runtime catalog.
+ description: Capability is a particular feature which
+ requires a well known set of dependencies and other
+ properties which are specified in the runtime catalog.
properties:
buildTimeProperties:
description: Set of required Camel build time
@@ -1682,9 +1672,9 @@ spec:
Kamelet
type: boolean
interceptors:
- description: |-
- Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
- uses to pre/post process sources
+ description: Interceptors are optional identifiers
+ the org.apache.camel.k.RoutesLoader uses to pre/post
+ process sources
items:
type: string
type: array
@@ -1693,9 +1683,8 @@ spec:
DSL) used to interpret this source code
type: string
loader:
- description: |-
- Loader is an optional id of the org.apache.camel.k.RoutesLoader that will
- interpret this source at runtime
+ description: Loader is an optional id of the org.apache.camel.k.RoutesLoader
+ that will interpret this source at runtime
type: string
name:
description: the name of the specification
@@ -1827,9 +1816,8 @@ spec:
type: string
type: object
spectrum:
- description: |-
- a SpectrumTask, for Spectrum strategy
- Deprecated: use jib, s2i or a custom publishing strategy instead
+ description: 'a SpectrumTask, for Spectrum strategy Deprecated:
+ use jib, s2i or a custom publishing strategy instead'
properties:
baseImage:
description: base image layer
@@ -1929,17 +1917,15 @@ spec:
type: object
type: array
timeout:
- description: |-
- Timeout defines the Build maximum execution duration.
- The Build deadline is set to the Build start time plus the Timeout duration.
- If the Build deadline is exceeded, the Build context is canceled,
- and its phase set to BuildPhaseFailed.
+ description: Timeout defines the Build maximum execution duration.
+ The Build deadline is set to the Build start time plus the Timeout
+ duration. If the Build deadline is exceeded, the Build context is
+ canceled, and its phase set to BuildPhaseFailed.
format: duration
type: string
toolImage:
- description: |-
- The container image to be used to run the build.
- Deprecated: no longer in use in Camel K 2 - maintained for backward compatibility
+ description: 'The container image to be used to run the build. Deprecated:
+ no longer in use in Camel K 2 - maintained for backward compatibility'
type: string
type: object
status:
@@ -2008,10 +1994,8 @@ spec:
description: the digest from image
type: string
duration:
- description: |-
- how long it took for the build
- Change to Duration / ISO 8601 when CRD uses OpenAPI spec v3
- https://github.com/OAI/OpenAPI-Specification/issues/845
+ description: how long it took for the build Change to Duration / ISO
+ 8601 when CRD uses OpenAPI spec v3 https://github.com/OAI/OpenAPI-Specification/issues/845
type: string
error:
description: the error description (if any)
@@ -2073,3 +2057,9 @@ spec:
storage: true
subresources:
status: {}
+status:
+ acceptedNames:
+ kind: ""
+ plural: ""
+ conditions: []
+ storedVersions: []
diff --git a/pkg/resources/config/crd/bases/camel.apache.org_camelcatalogs.yaml b/pkg/resources/config/crd/bases/camel.apache.org_camelcatalogs.yaml
index 3ab9ef6fd7..1e8c85d344 100644
--- a/pkg/resources/config/crd/bases/camel.apache.org_camelcatalogs.yaml
+++ b/pkg/resources/config/crd/bases/camel.apache.org_camelcatalogs.yaml
@@ -15,12 +15,14 @@
# limitations under the License.
# ---------------------------------------------------------------------------
+
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
- controller-gen.kubebuilder.io/version: v0.15.0
+ controller-gen.kubebuilder.io/version: v0.6.1
+ creationTimestamp: null
name: camelcatalogs.camel.apache.org
spec:
group: camel.apache.org
@@ -61,19 +63,14 @@ spec:
statically generated.
properties:
apiVersion:
- description: |-
- APIVersion defines the versioned schema of this representation of an object.
- Servers should convert recognized schemas to the latest internal value, and
- may reject unrecognized values.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+ description: 'APIVersion defines the versioned schema of this representation
+ of an object. Servers should convert recognized schemas to the latest
+ internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: |-
- Kind is a string value representing the REST resource this object represents.
- Servers may infer this from the endpoint the client submits requests to.
- Cannot be updated.
- In CamelCase.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ description: 'Kind is a string value representing the REST resource this
+ object represents. Servers may infer this from the endpoint the client
+ submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
@@ -374,9 +371,9 @@ spec:
type: string
capabilities:
additionalProperties:
- description: |-
- Capability is a particular feature which requires a well known set of dependencies and other properties
- which are specified in the runtime catalog.
+ description: Capability is a particular feature which requires
+ a well known set of dependencies and other properties which
+ are specified in the runtime catalog.
properties:
buildTimeProperties:
description: Set of required Camel build time properties
@@ -542,3 +539,9 @@ spec:
storage: true
subresources:
status: {}
+status:
+ acceptedNames:
+ kind: ""
+ plural: ""
+ conditions: []
+ storedVersions: []
diff --git a/pkg/resources/config/crd/bases/camel.apache.org_integrationkits.yaml b/pkg/resources/config/crd/bases/camel.apache.org_integrationkits.yaml
index 0c9c03bec8..77c7bfd0b0 100644
--- a/pkg/resources/config/crd/bases/camel.apache.org_integrationkits.yaml
+++ b/pkg/resources/config/crd/bases/camel.apache.org_integrationkits.yaml
@@ -15,12 +15,14 @@
# limitations under the License.
# ---------------------------------------------------------------------------
+
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
- controller-gen.kubebuilder.io/version: v0.15.0
+ controller-gen.kubebuilder.io/version: v0.6.1
+ creationTimestamp: null
name: integrationkits.camel.apache.org
spec:
group: camel.apache.org
@@ -64,26 +66,22 @@ spec:
name: v1
schema:
openAPIV3Schema:
- description: |-
- IntegrationKit defines a container image and additional configuration needed to run an `Integration`.
- An `IntegrationKit` is a generic image generally built from the requirements of an `Integration`, but agnostic to it,
- in order to be reused by any other `Integration` which has the same required set of capabilities. An `IntegrationKit`
- may be used for other kits as a base container layer, when the `incremental` build option is enabled.
+ description: IntegrationKit defines a container image and additional configuration
+ needed to run an `Integration`. An `IntegrationKit` is a generic image generally
+ built from the requirements of an `Integration`, but agnostic to it, in
+ order to be reused by any other `Integration` which has the same required
+ set of capabilities. An `IntegrationKit` may be used for other kits as a
+ base container layer, when the `incremental` build option is enabled.
properties:
apiVersion:
- description: |-
- APIVersion defines the versioned schema of this representation of an object.
- Servers should convert recognized schemas to the latest internal value, and
- may reject unrecognized values.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+ description: 'APIVersion defines the versioned schema of this representation
+ of an object. Servers should convert recognized schemas to the latest
+ internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: |-
- Kind is a string value representing the REST resource this object represents.
- Servers may infer this from the endpoint the client submits requests to.
- Cannot be updated.
- In CamelCase.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ description: 'Kind is a string value representing the REST resource this
+ object represents. Servers may infer this from the endpoint the client
+ submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
@@ -96,13 +94,10 @@ spec:
type: string
type: array
configuration:
- description: |-
- Deprecated:
- Use camel trait (camel.properties) to manage properties
- Use mount trait (mount.configs) to manage configs
- Use mount trait (mount.resources) to manage resources
- Use mount trait (mount.volumes) to manage volumes
- configuration used by the kit
+ description: 'Deprecated: Use camel trait (camel.properties) to manage
+ properties Use mount trait (mount.configs) to manage configs Use
+ mount trait (mount.resources) to manage resources Use mount trait
+ (mount.volumes) to manage volumes configuration used by the kit'
items:
description: ConfigurationSpec represents a generic configuration
specification.
@@ -161,8 +156,7 @@ spec:
description: True if the spec is generated from a Kamelet
type: boolean
interceptors:
- description: |-
- Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
+ description: Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
uses to pre/post process sources
items:
type: string
@@ -172,9 +166,8 @@ spec:
to interpret this source code
type: string
loader:
- description: |-
- Loader is an optional id of the org.apache.camel.k.RoutesLoader that will
- interpret this source at runtime
+ description: Loader is an optional id of the org.apache.camel.k.RoutesLoader
+ that will interpret this source at runtime
type: string
name:
description: the name of the specification
@@ -220,14 +213,13 @@ spec:
for the builder pod.
type: object
baseImage:
- description: |-
- Specify a base image. In order to have the application working properly it must be a container image which has a Java JDK
- installed and ready to use on path (ie `/usr/bin/java`).
+ description: Specify a base image. In order to have the application
+ working properly it must be a container image which has
+ a Java JDK installed and ready to use on path (ie `/usr/bin/java`).
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -238,21 +230,27 @@ spec:
existing containers (default `true`)
type: boolean
limitCPU:
- description: |-
- When using `pod` strategy, the maximum amount of CPU required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the maximum amount
+ of CPU required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
limitMemory:
- description: |-
- When using `pod` strategy, the maximum amount of memory required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the maximum amount
+ of memory required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
mavenProfiles:
- description: |-
- A list of references pointing to configmaps/secrets that contains a maven profile.
- This configmap/secret is a resource of the IntegrationKit created, therefore it needs to be present in the namespace where the operator is going to create the IntegrationKit.
- The content of the maven profile is expected to be a text containing a valid maven profile starting with `` and ending with `` that will be integrated as an inline profile in the POM.
- Syntax: [configmap|secret]:name[/key], where name represents the resource name, key optionally represents the resource key to be filtered (default key value = profile.xml).
+ description: 'A list of references pointing to configmaps/secrets
+ that contains a maven profile. This configmap/secret is
+ a resource of the IntegrationKit created, therefore it needs
+ to be present in the namespace where the operator is going
+ to create the IntegrationKit. The content of the maven profile
+ is expected to be a text containing a valid maven profile
+ starting with `` and ending with `` that
+ will be integrated as an inline profile in the POM. Syntax:
+ [configmap|secret]:name[/key], where name represents the
+ resource name, key optionally represents the resource key
+ to be filtered (default key value = profile.xml).'
items:
type: string
type: array
@@ -283,14 +281,14 @@ spec:
type: string
type: array
requestCPU:
- description: |-
- When using `pod` strategy, the minimum amount of CPU required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the minimum amount
+ of CPU required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
requestMemory:
- description: |-
- When using `pod` strategy, the minimum amount of memory required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the minimum amount
+ of memory required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
strategy:
description: The strategy to use, either `pod` or `routine`
@@ -306,10 +304,11 @@ spec:
type: string
type: array
tasksFilter:
- description: |-
- A list of tasks sorted by the order of execution in a csv format, ie, `,,...`.
- Mind that you must include also the operator tasks (`builder`, `quarkus-native`, `package`, `jib`, `s2i`)
- if you need to execute them. Useful only with `pod` strategy.
+ description: A list of tasks sorted by the order of execution
+ in a csv format, ie, `,,...`. Mind
+ that you must include also the operator tasks (`builder`,
+ `quarkus-native`, `package`, `jib`, `s2i`) if you need to
+ execute them. Useful only with `pod` strategy.
type: string
tasksLimitCPU:
description: A list of limit cpu configuration for the specific
@@ -336,18 +335,17 @@ spec:
type: string
type: array
verbose:
- description: |-
- Enable verbose logging on build components that support it (e.g. Kaniko build pod).
- Deprecated no longer in use
+ description: Enable verbose logging on build components that
+ support it (e.g. Kaniko build pod). Deprecated no longer
+ in use
type: boolean
type: object
camel:
description: The Camel trait sets up Camel configuration.
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -360,23 +358,25 @@ spec:
type: string
type: array
runtimeVersion:
- description: |-
- The camel-k-runtime version to use for the integration. It overrides the default version set in the Integration Platform.
- You can use a fixed version (for example "3.2.3") or a semantic version (for example "3.x") which will try to resolve
- to the best matching Catalog existing on the cluster.
+ description: The camel-k-runtime version to use for the integration.
+ It overrides the default version set in the Integration
+ Platform. You can use a fixed version (for example "3.2.3")
+ or a semantic version (for example "3.x") which will try
+ to resolve to the best matching Catalog existing on the
+ cluster.
type: string
type: object
quarkus:
- description: |-
- The Quarkus trait configures the Quarkus runtime.
- It's enabled by default.
- NOTE: Compiling to a native executable, requires at least 4GiB of memory, so the Pod running the native build must have enough memory available.
+ description: 'The Quarkus trait configures the Quarkus runtime.
+ It''s enabled by default. NOTE: Compiling to a native executable,
+ requires at least 4GiB of memory, so the Pod running the native
+ build must have enough memory available.'
properties:
buildMode:
- description: |-
- The Quarkus mode to run: either `jvm` or `native` (default `jvm`).
- In case both `jvm` and `native` are specified, two `IntegrationKit` resources are created,
- with the `native` kit having precedence over the `jvm` one once ready.
+ description: 'The Quarkus mode to run: either `jvm` or `native`
+ (default `jvm`). In case both `jvm` and `native` are specified,
+ two `IntegrationKit` resources are created, with the `native`
+ kit having precedence over the `jvm` one once ready.'
items:
description: QuarkusMode is the type of Quarkus build packaging.
enum:
@@ -385,9 +385,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -403,18 +402,18 @@ spec:
in the runtime catalog)
type: string
packageTypes:
- description: |-
- The Quarkus package types, `fast-jar` or `native` (default `fast-jar`).
- In case both `fast-jar` and `native` are specified, two `IntegrationKit` resources are created,
- with the native kit having precedence over the `fast-jar` one once ready.
- The order influences the resolution of the current kit for the integration.
- The kit corresponding to the first package type will be assigned to the
- integration in case no existing kit that matches the integration exists.
- Deprecated: use `build-mode` instead.
+ description: 'The Quarkus package types, `fast-jar` or `native`
+ (default `fast-jar`). In case both `fast-jar` and `native`
+ are specified, two `IntegrationKit` resources are created,
+ with the native kit having precedence over the `fast-jar`
+ one once ready. The order influences the resolution of the
+ current kit for the integration. The kit corresponding to
+ the first package type will be assigned to the integration
+ in case no existing kit that matches the integration exists.
+ Deprecated: use `build-mode` instead.'
items:
- description: |-
- QuarkusPackageType is the type of Quarkus build packaging.
- Deprecated: use `QuarkusMode` instead.
+ description: 'QuarkusPackageType is the type of Quarkus
+ build packaging. Deprecated: use `QuarkusMode` instead.'
enum:
- fast-jar
- native
@@ -422,14 +421,13 @@ spec:
type: array
type: object
registry:
- description: |-
- The Registry trait sets up Maven to use the Image registry as a Maven repository (support removed since version 2.5.0).
- Deprecated: use jvm trait or read documentation.
+ description: 'The Registry trait sets up Maven to use the Image
+ registry as a Maven repository (support removed since version
+ 2.5.0). Deprecated: use jvm trait or read documentation.'
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -570,3 +568,9 @@ spec:
storage: true
subresources:
status: {}
+status:
+ acceptedNames:
+ kind: ""
+ plural: ""
+ conditions: []
+ storedVersions: []
diff --git a/pkg/resources/config/crd/bases/camel.apache.org_integrationplatforms.yaml b/pkg/resources/config/crd/bases/camel.apache.org_integrationplatforms.yaml
index 7b9029b607..6fdbe736bb 100644
--- a/pkg/resources/config/crd/bases/camel.apache.org_integrationplatforms.yaml
+++ b/pkg/resources/config/crd/bases/camel.apache.org_integrationplatforms.yaml
@@ -15,12 +15,14 @@
# limitations under the License.
# ---------------------------------------------------------------------------
+
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
- controller-gen.kubebuilder.io/version: v0.15.0
+ controller-gen.kubebuilder.io/version: v0.6.1
+ creationTimestamp: null
name: integrationplatforms.camel.apache.org
spec:
group: camel.apache.org
@@ -60,26 +62,21 @@ spec:
name: v1
schema:
openAPIV3Schema:
- description: |-
- IntegrationPlatform is the resource used to drive the Camel K operator behavior.
- It defines the behavior of all Custom Resources (`IntegrationKit`, `Integration`, `Kamelet`) in the given namespace.
- When the Camel K operator is installed in `global` mode,
- you will need to specify an `IntegrationPlatform` in each namespace where you want the Camel K operator to be executed.
+ description: IntegrationPlatform is the resource used to drive the Camel K
+ operator behavior. It defines the behavior of all Custom Resources (`IntegrationKit`,
+ `Integration`, `Kamelet`) in the given namespace. When the Camel K operator
+ is installed in `global` mode, you will need to specify an `IntegrationPlatform`
+ in each namespace where you want the Camel K operator to be executed.
properties:
apiVersion:
- description: |-
- APIVersion defines the versioned schema of this representation of an object.
- Servers should convert recognized schemas to the latest internal value, and
- may reject unrecognized values.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+ description: 'APIVersion defines the versioned schema of this representation
+ of an object. Servers should convert recognized schemas to the latest
+ internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: |-
- Kind is a string value representing the REST resource this object represents.
- Servers may infer this from the endpoint the client submits requests to.
- Cannot be updated.
- In CamelCase.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ description: 'Kind is a string value representing the REST resource this
+ object represents. Servers may infer this from the endpoint the client
+ submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
@@ -95,14 +92,13 @@ spec:
description: 'Deprecated: no longer in use'
type: object
baseImage:
- description: |-
- a base image that can be used as base layer for all images.
- It can be useful if you want to provide some custom base image with further utility software
+ description: a base image that can be used as base layer for all
+ images. It can be useful if you want to provide some custom
+ base image with further utility software
type: string
buildCatalogToolTimeout:
- description: |-
- the timeout (in seconds) to use when creating the build tools container image
- Deprecated: no longer in use
+ description: 'the timeout (in seconds) to use when creating the
+ build tools container image Deprecated: no longer in use'
type: string
buildConfiguration:
description: the configuration required to build an Integration
@@ -168,13 +164,13 @@ spec:
applications
properties:
caSecrets:
- description: |-
- The Secrets name and key, containing the CA certificate(s) used to connect
- to remote Maven repositories.
- It can contain X.509 certificates, and PKCS#7 formatted certificate chains.
- A JKS formatted keystore is automatically created to store the CA certificate(s),
- and configured to be used as a trusted certificate(s) by the Maven commands.
- Note that the root CA certificates are also imported into the created keystore.
+ description: The Secrets name and key, containing the CA certificate(s)
+ used to connect to remote Maven repositories. It can contain
+ X.509 certificates, and PKCS#7 formatted certificate chains.
+ A JKS formatted keystore is automatically created to store
+ the CA certificate(s), and configured to be used as a trusted
+ certificate(s) by the Maven commands. Note that the root
+ CA certificates are also imported into the created keystore.
items:
description: SecretKeySelector selects a key of a Secret.
properties:
@@ -183,10 +179,8 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
description: Specify whether the Secret or its key must
@@ -195,20 +189,16 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: array
cliOptions:
- description: |-
- The CLI options that are appended to the list of arguments for Maven commands,
- e.g., `-V,--no-transfer-progress,-Dstyle.color=never`.
+ description: The CLI options that are appended to the list
+ of arguments for Maven commands, e.g., `-V,--no-transfer-progress,-Dstyle.color=never`.
See https://maven.apache.org/ref/3.8.4/maven-embedder/cli.html.
items:
type: string
type: array
extension:
- description: |-
- The Maven build extensions.
- See https://maven.apache.org/guides/mini/guide-using-extensions.html.
+ description: The Maven build extensions. See https://maven.apache.org/guides/mini/guide-using-extensions.html.
items:
description: MavenArtifact defines a GAV (Group:Artifact:Type:Version:Classifier)
Maven artifact.
@@ -237,9 +227,8 @@ spec:
description: The path of the local Maven repository.
type: string
profiles:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the Maven profile.
+ description: A reference to the ConfigMap or Secret key that
+ contains the Maven profile.
items:
description: ValueSource --.
properties:
@@ -250,10 +239,9 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the ConfigMap or its
@@ -262,7 +250,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -271,10 +258,9 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the Secret or its key
@@ -283,7 +269,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
properties:
@@ -292,9 +277,8 @@ spec:
description: The Maven properties.
type: object
settings:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the Maven settings.
+ description: A reference to the ConfigMap or Secret key that
+ contains the Maven settings.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -303,10 +287,9 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the ConfigMap or its
@@ -315,7 +298,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -324,10 +306,9 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the Secret or its key
@@ -336,12 +317,10 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
settingsSecurity:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the security of the Maven settings.
+ description: A reference to the ConfigMap or Secret key that
+ contains the security of the Maven settings.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -350,10 +329,9 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the ConfigMap or its
@@ -362,7 +340,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -371,10 +348,9 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the Secret or its key
@@ -383,7 +359,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: object
maxRunningBuilds:
@@ -434,13 +409,12 @@ spec:
or OpenShift)
type: string
configuration:
- description: |-
- Deprecated:
- Use camel trait (camel.properties) to manage properties
- Use mount trait (mount.configs) to manage configs
- Use mount trait (mount.resources) to manage resources
- Use mount trait (mount.volumes) to manage volumes
- list of configuration properties to be attached to all the Integration/IntegrationKits built from this IntegrationPlatform
+ description: 'Deprecated: Use camel trait (camel.properties) to manage
+ properties Use mount trait (mount.configs) to manage configs Use
+ mount trait (mount.resources) to manage resources Use mount trait
+ (mount.volumes) to manage volumes list of configuration properties
+ to be attached to all the Integration/IntegrationKits built from
+ this IntegrationPlatform'
items:
description: ConfigurationSpec represents a generic configuration
specification.
@@ -475,9 +449,10 @@ spec:
type: array
type: object
profile:
- description: |-
- the profile you wish to use. It will apply certain traits which are required by the specific profile chosen.
- It usually relates the Cluster with the optional definition of special profiles (ie, Knative)
+ description: the profile you wish to use. It will apply certain traits
+ which are required by the specific profile chosen. It usually relates
+ the Cluster with the optional definition of special profiles (ie,
+ Knative)
type: string
traits:
description: list of traits to be executed for all the Integration/IntegrationKits
@@ -505,9 +480,8 @@ spec:
description: The configuration of Affinity trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -526,9 +500,9 @@ spec:
in the same node (default `false`).
type: boolean
podAffinityLabels:
- description: |-
- Defines a set of pods (namely those matching the label selector, relative to the given namespace) that the
- integration pod(s) should be co-located with.
+ description: Defines a set of pods (namely those matching
+ the label selector, relative to the given namespace) that
+ the integration pod(s) should be co-located with.
items:
type: string
type: array
@@ -537,9 +511,9 @@ spec:
in the same node (default `false`).
type: boolean
podAntiAffinityLabels:
- description: |-
- Defines a set of pods (namely those matching the label selector, relative to the given namespace) that the
- integration pod(s) should not be co-located with.
+ description: Defines a set of pods (namely those matching
+ the label selector, relative to the given namespace) that
+ the integration pod(s) should not be co-located with.
items:
type: string
type: array
@@ -554,14 +528,13 @@ spec:
for the builder pod.
type: object
baseImage:
- description: |-
- Specify a base image. In order to have the application working properly it must be a container image which has a Java JDK
- installed and ready to use on path (ie `/usr/bin/java`).
+ description: Specify a base image. In order to have the application
+ working properly it must be a container image which has
+ a Java JDK installed and ready to use on path (ie `/usr/bin/java`).
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -572,21 +545,27 @@ spec:
existing containers (default `true`)
type: boolean
limitCPU:
- description: |-
- When using `pod` strategy, the maximum amount of CPU required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the maximum amount
+ of CPU required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
limitMemory:
- description: |-
- When using `pod` strategy, the maximum amount of memory required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the maximum amount
+ of memory required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
mavenProfiles:
- description: |-
- A list of references pointing to configmaps/secrets that contains a maven profile.
- This configmap/secret is a resource of the IntegrationKit created, therefore it needs to be present in the namespace where the operator is going to create the IntegrationKit.
- The content of the maven profile is expected to be a text containing a valid maven profile starting with `` and ending with `` that will be integrated as an inline profile in the POM.
- Syntax: [configmap|secret]:name[/key], where name represents the resource name, key optionally represents the resource key to be filtered (default key value = profile.xml).
+ description: 'A list of references pointing to configmaps/secrets
+ that contains a maven profile. This configmap/secret is
+ a resource of the IntegrationKit created, therefore it needs
+ to be present in the namespace where the operator is going
+ to create the IntegrationKit. The content of the maven profile
+ is expected to be a text containing a valid maven profile
+ starting with `` and ending with `` that
+ will be integrated as an inline profile in the POM. Syntax:
+ [configmap|secret]:name[/key], where name represents the
+ resource name, key optionally represents the resource key
+ to be filtered (default key value = profile.xml).'
items:
type: string
type: array
@@ -617,14 +596,14 @@ spec:
type: string
type: array
requestCPU:
- description: |-
- When using `pod` strategy, the minimum amount of CPU required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the minimum amount
+ of CPU required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
requestMemory:
- description: |-
- When using `pod` strategy, the minimum amount of memory required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the minimum amount
+ of memory required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
strategy:
description: The strategy to use, either `pod` or `routine`
@@ -640,10 +619,11 @@ spec:
type: string
type: array
tasksFilter:
- description: |-
- A list of tasks sorted by the order of execution in a csv format, ie, `,,...`.
- Mind that you must include also the operator tasks (`builder`, `quarkus-native`, `package`, `jib`, `s2i`)
- if you need to execute them. Useful only with `pod` strategy.
+ description: A list of tasks sorted by the order of execution
+ in a csv format, ie, `,,...`. Mind
+ that you must include also the operator tasks (`builder`,
+ `quarkus-native`, `package`, `jib`, `s2i`) if you need to
+ execute them. Useful only with `pod` strategy.
type: string
tasksLimitCPU:
description: A list of limit cpu configuration for the specific
@@ -670,18 +650,17 @@ spec:
type: string
type: array
verbose:
- description: |-
- Enable verbose logging on build components that support it (e.g. Kaniko build pod).
- Deprecated no longer in use
+ description: Enable verbose logging on build components that
+ support it (e.g. Kaniko build pod). Deprecated no longer
+ in use
type: boolean
type: object
camel:
description: The configuration of Camel trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -694,10 +673,12 @@ spec:
type: string
type: array
runtimeVersion:
- description: |-
- The camel-k-runtime version to use for the integration. It overrides the default version set in the Integration Platform.
- You can use a fixed version (for example "3.2.3") or a semantic version (for example "3.x") which will try to resolve
- to the best matching Catalog existing on the cluster.
+ description: The camel-k-runtime version to use for the integration.
+ It overrides the default version set in the Integration
+ Platform. You can use a fixed version (for example "3.2.3")
+ or a semantic version (for example "3.x") which will try
+ to resolve to the best matching Catalog existing on the
+ cluster.
type: string
type: object
container:
@@ -725,9 +706,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -738,10 +718,13 @@ spec:
Service.
type: boolean
image:
- description: |-
- The main container image to use for the Integration. When using this parameter the operator will create a synthetic IntegrationKit which
- won't be able to execute traits requiring CamelCatalog. If the container image you're using is coming from an IntegrationKit, use instead
- Integration `.spec.integrationKit` parameter. If you're moving the Integration across environments, you will also need to create an "external" IntegrationKit.
+ description: The main container image to use for the Integration.
+ When using this parameter the operator will create a synthetic
+ IntegrationKit which won't be able to execute traits requiring
+ CamelCatalog. If the container image you're using is coming
+ from an IntegrationKit, use instead Integration `.spec.integrationKit`
+ parameter. If you're moving the Integration across environments,
+ you will also need to create an "external" IntegrationKit.
type: string
imagePullPolicy:
description: 'The pull policy: Always|Never|IfNotPresent'
@@ -809,52 +792,50 @@ spec:
description: The configuration of Cron trait
properties:
activeDeadlineSeconds:
- description: |-
- Specifies the duration in seconds, relative to the start time, that the job
- may be continuously active before it is considered to be failed.
- It defaults to 60s.
+ description: Specifies the duration in seconds, relative to
+ the start time, that the job may be continuously active
+ before it is considered to be failed. It defaults to 60s.
format: int64
type: integer
auto:
- description: |-
- Automatically deploy the integration as CronJob when all routes are
- either starting from a periodic consumer (only `cron`, `timer` and `quartz` are supported) or a passive consumer (e.g. `direct` is a passive consumer).
-
-
- It's required that all periodic consumers have the same period, and it can be expressed as cron schedule (e.g. `1m` can be expressed as `0/1 * * * *`,
- while `35m` or `50s` cannot).
+ description: "Automatically deploy the integration as CronJob
+ when all routes are either starting from a periodic consumer
+ (only `cron`, `timer` and `quartz` are supported) or a passive
+ consumer (e.g. `direct` is a passive consumer). \n It's
+ required that all periodic consumers have the same period,
+ and it can be expressed as cron schedule (e.g. `1m` can
+ be expressed as `0/1 * * * *`, while `35m` or `50s` cannot)."
type: boolean
backoffLimit:
- description: |-
- Specifies the number of retries before marking the job failed.
- It defaults to 2.
+ description: Specifies the number of retries before marking
+ the job failed. It defaults to 2.
format: int32
type: integer
components:
- description: |-
- A comma separated list of the Camel components that need to be customized in order for them to work when the schedule is triggered externally by Kubernetes.
- A specific customizer is activated for each specified component. E.g. for the `timer` component, the `cron-timer` customizer is
- activated (it's present in the `org.apache.camel.k:camel-k-cron` library).
-
-
- Supported components are currently: `cron`, `timer` and `quartz`.
+ description: "A comma separated list of the Camel components
+ that need to be customized in order for them to work when
+ the schedule is triggered externally by Kubernetes. A specific
+ customizer is activated for each specified component. E.g.
+ for the `timer` component, the `cron-timer` customizer is
+ activated (it's present in the `org.apache.camel.k:camel-k-cron`
+ library). \n Supported components are currently: `cron`,
+ `timer` and `quartz`."
type: string
concurrencyPolicy:
- description: |-
- Specifies how to treat concurrent executions of a Job.
- Valid values are:
- - "Allow": allows CronJobs to run concurrently;
- - "Forbid" (default): forbids concurrent runs, skipping next run if previous run hasn't finished yet;
- - "Replace": cancels currently running job and replaces it with a new one
+ description: 'Specifies how to treat concurrent executions
+ of a Job. Valid values are: - "Allow": allows CronJobs to
+ run concurrently; - "Forbid" (default): forbids concurrent
+ runs, skipping next run if previous run hasn''t finished
+ yet; - "Replace": cancels currently running job and replaces
+ it with a new one'
enum:
- Allow
- Forbid
- Replace
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -862,19 +843,19 @@ spec:
traits share this common property.
type: boolean
fallback:
- description: |-
- Use the default Camel implementation of the `cron` endpoint (`quartz`) instead of trying to materialize the integration
- as Kubernetes CronJob.
+ description: Use the default Camel implementation of the `cron`
+ endpoint (`quartz`) instead of trying to materialize the
+ integration as Kubernetes CronJob.
type: boolean
schedule:
- description: |-
- The CronJob schedule for the whole integration. If multiple routes are declared, they must have the same schedule for this
- mechanism to work correctly.
+ description: The CronJob schedule for the whole integration.
+ If multiple routes are declared, they must have the same
+ schedule for this mechanism to work correctly.
type: string
startingDeadlineSeconds:
- description: |-
- Optional deadline in seconds for starting the job if it misses scheduled
- time for any reason. Missed jobs executions will be counted as failed ones.
+ description: Optional deadline in seconds for starting the
+ job if it misses scheduled time for any reason. Missed
+ jobs executions will be counted as failed ones.
format: int64
type: integer
timeZone:
@@ -885,9 +866,8 @@ spec:
description: The configuration of Dependencies trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -898,9 +878,8 @@ spec:
description: The configuration of Deployer trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -916,51 +895,49 @@ spec:
- knative-service
type: string
useSSA:
- description: |-
- Use server-side apply to update the owned resources (default `true`).
- Note that it automatically falls back to client-side patching, if SSA is not available, e.g., on old Kubernetes clusters.
+ description: Use server-side apply to update the owned resources
+ (default `true`). Note that it automatically falls back
+ to client-side patching, if SSA is not available, e.g.,
+ on old Kubernetes clusters.
type: boolean
type: object
deployment:
description: The configuration of Deployment trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
description: 'Deprecated: no longer in use.'
type: boolean
progressDeadlineSeconds:
- description: |-
- The maximum time in seconds for the deployment to make progress before it
- is considered to be failed. It defaults to `60s`.
+ description: The maximum time in seconds for the deployment
+ to make progress before it is considered to be failed. It
+ defaults to `60s`.
format: int32
type: integer
rollingUpdateMaxSurge:
anyOf:
- type: integer
- type: string
- description: |-
- The maximum number of pods that can be scheduled above the desired number of
- pods.
- Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
- This can not be 0 if MaxUnavailable is 0.
- Absolute number is calculated from percentage by rounding up.
- Defaults to `25%`.
+ description: 'The maximum number of pods that can be scheduled
+ above the desired number of pods. Value can be an absolute
+ number (ex: 5) or a percentage of desired pods (ex: 10%).
+ This can not be 0 if MaxUnavailable is 0. Absolute number
+ is calculated from percentage by rounding up. Defaults to
+ `25%`.'
x-kubernetes-int-or-string: true
rollingUpdateMaxUnavailable:
anyOf:
- type: integer
- type: string
- description: |-
- The maximum number of pods that can be unavailable during the update.
- Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
- Absolute number is calculated from percentage by rounding down.
- This can not be 0 if MaxSurge is 0.
- Defaults to `25%`.
+ description: 'The maximum number of pods that can be unavailable
+ during the update. Value can be an absolute number (ex:
+ 5) or a percentage of desired pods (ex: 10%). Absolute number
+ is calculated from percentage by rounding down. This can
+ not be 0 if MaxSurge is 0. Defaults to `25%`.'
x-kubernetes-int-or-string: true
strategy:
description: The deployment strategy to use to replace existing
@@ -974,9 +951,8 @@ spec:
description: The configuration of Environment trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
containerMeta:
@@ -991,11 +967,12 @@ spec:
`NO_PROXY` environment variables (default `true`)
type: boolean
vars:
- description: |-
- A list of environment variables to be added to the integration container.
- The syntax is either VAR=VALUE or VAR=[configmap|secret]:name/key, where name represents the resource name,
- and key represents the resource key to be mapped as and environment variable.
- These take precedence over any previously defined environment variables.
+ description: A list of environment variables to be added to
+ the integration container. The syntax is either VAR=VALUE
+ or VAR=[configmap|secret]:name/key, where name represents
+ the resource name, and key represents the resource key to
+ be mapped as and environment variable. These take precedence
+ over any previously defined environment variables.
items:
type: string
type: array
@@ -1004,9 +981,8 @@ spec:
description: The configuration of Error Handler trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1021,15 +997,14 @@ spec:
description: The configuration of GC trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
discoveryCache:
- description: |-
- Discovery client cache to be used, either `disabled`, `disk` or `memory` (default `memory`).
- Deprecated: to be removed from trait configuration.
+ description: 'Discovery client cache to be used, either `disabled`,
+ `disk` or `memory` (default `memory`). Deprecated: to be
+ removed from trait configuration.'
enum:
- disabled
- disk
@@ -1044,9 +1019,8 @@ spec:
description: The configuration of Health trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1168,19 +1142,17 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to the ingress.
- This can be used to set controller specific annotations, e.g., when using the NGINX Ingress controller:
- See https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md
+ description: 'The annotations added to the ingress. This can
+ be used to set controller specific annotations, e.g., when
+ using the NGINX Ingress controller: See https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md'
type: object
auto:
description: To automatically add an ingress whenever the
integration uses an HTTP endpoint consumer.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1190,14 +1162,18 @@ spec:
host:
description: To configure the host exposed by the ingress.
type: string
+ ingressClassName:
+ description: The Ingress class name as defined by the Ingress
+ spec See https://kubernetes.io/docs/concepts/services-networking/ingress/
+ type: string
path:
description: To configure the path exposed by the ingress
(default `/`).
type: string
pathType:
- description: |-
- To configure the path type exposed by the ingress.
- One of `Exact`, `Prefix`, `ImplementationSpecific` (default to `Prefix`).
+ description: To configure the path type exposed by the ingress.
+ One of `Exact`, `Prefix`, `ImplementationSpecific` (default
+ to `Prefix`).
enum:
- Exact
- Prefix
@@ -1221,9 +1197,8 @@ spec:
by default).
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1240,23 +1215,25 @@ spec:
description: The configuration of Jolokia trait
properties:
CACert:
- description: |-
- The PEM encoded CA certification file path, used to verify client certificates,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt` for OpenShift).
+ description: The PEM encoded CA certification file path, used
+ to verify client certificates, applicable when `protocol`
+ is `https` and `use-ssl-client-authentication` is `true`
+ (default `/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt`
+ for OpenShift).
type: string
clientPrincipal:
- description: |-
- The principal(s) which must be given in a client certificate to allow access to the Jolokia endpoint,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `clientPrincipal=cn=system:master-proxy`, `cn=hawtio-online.hawtio.svc` and `cn=fuse-console.fuse.svc` for OpenShift).
+ description: The principal(s) which must be given in a client
+ certificate to allow access to the Jolokia endpoint, applicable
+ when `protocol` is `https` and `use-ssl-client-authentication`
+ is `true` (default `clientPrincipal=cn=system:master-proxy`,
+ `cn=hawtio-online.hawtio.svc` and `cn=fuse-console.fuse.svc`
+ for OpenShift).
items:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
discoveryEnabled:
@@ -1267,20 +1244,20 @@ spec:
traits share this common property.
type: boolean
extendedClientCheck:
- description: |-
- Mandate the client certificate contains a client flag in the extended key usage section,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `true` for OpenShift).
+ description: Mandate the client certificate contains a client
+ flag in the extended key usage section, applicable when
+ `protocol` is `https` and `use-ssl-client-authentication`
+ is `true` (default `true` for OpenShift).
type: boolean
host:
- description: |-
- The Host address to which the Jolokia agent should bind to. If `"\*"` or `"0.0.0.0"` is given,
- the servers binds to every network interface (default `"*"`).
+ description: The Host address to which the Jolokia agent should
+ bind to. If `"\*"` or `"0.0.0.0"` is given, the servers
+ binds to every network interface (default `"*"`).
type: string
options:
- description: |-
- A list of additional Jolokia options as defined
- in https://jolokia.org/reference/html/agents.html#agent-jvm-config[JVM agent configuration options]
+ description: A list of additional Jolokia options as defined
+ in https://jolokia.org/reference/html/agents.html#agent-jvm-config[JVM
+ agent configuration options]
items:
type: string
type: array
@@ -1311,9 +1288,8 @@ spec:
separator)
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
debug:
@@ -1342,9 +1318,9 @@ spec:
type: string
type: array
printCommand:
- description: |-
- Prints the command used the start the JVM in the container logs (default `true`)
- Deprecated: no longer in use.
+ description: 'Prints the command used the start the JVM in
+ the container logs (default `true`) Deprecated: no longer
+ in use.'
type: boolean
type: object
kamelets:
@@ -1355,9 +1331,8 @@ spec:
and their default configuration (enabled by default)
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1390,16 +1365,14 @@ spec:
description: Enable automatic discovery of all trait properties.
type: boolean
channelSinks:
- description: |-
- List of channels used as destination of integration routes.
- Can contain simple channel names or full Camel URIs.
+ description: List of channels used as destination of integration
+ routes. Can contain simple channel names or full Camel URIs.
items:
type: string
type: array
channelSources:
- description: |-
- List of channels used as source of integration routes.
- Can contain simple channel names or full Camel URIs.
+ description: List of channels used as source of integration
+ routes. Can contain simple channel names or full Camel URIs.
items:
type: string
type: array
@@ -1408,9 +1381,8 @@ spec:
in JSON format.
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1418,9 +1390,9 @@ spec:
traits share this common property.
type: boolean
endpointSinks:
- description: |-
- List of endpoints used as destination of integration routes.
- Can contain simple endpoint names or full Camel URIs.
+ description: List of endpoints used as destination of integration
+ routes. Can contain simple endpoint names or full Camel
+ URIs.
items:
type: string
type: array
@@ -1431,50 +1403,54 @@ spec:
type: string
type: array
eventSinks:
- description: |-
- List of event types that the integration will produce.
- Can contain simple event types or full Camel URIs (to use a specific broker).
+ description: List of event types that the integration will
+ produce. Can contain simple event types or full Camel URIs
+ (to use a specific broker).
items:
type: string
type: array
eventSources:
- description: |-
- List of event types that the integration will be subscribed to.
- Can contain simple event types or full Camel URIs (to use a specific broker different from "default").
+ description: List of event types that the integration will
+ be subscribed to. Can contain simple event types or full
+ Camel URIs (to use a specific broker different from "default").
items:
type: string
type: array
filterEventType:
- description: |-
- Enables the default filtering for the Knative trigger using the event type
- If this is true, the created Knative trigger uses the event type as a filter on the event stream when no other filter criteria is given. (default: true)
+ description: 'Enables the default filtering for the Knative
+ trigger using the event type If this is true, the created
+ Knative trigger uses the event type as a filter on the event
+ stream when no other filter criteria is given. (default:
+ true)'
type: boolean
filterSourceChannels:
- description: |-
- Enables filtering on events based on the header "ce-knativehistory". Since this header has been removed in newer versions of
- Knative, filtering is disabled by default.
+ description: Enables filtering on events based on the header
+ "ce-knativehistory". Since this header has been removed
+ in newer versions of Knative, filtering is disabled by default.
type: boolean
filters:
- description: |-
- Sets filter attributes on the event stream (such as event type, source, subject and so on).
- A list of key-value pairs that represent filter attributes and its values.
- The syntax is KEY=VALUE, e.g., `source="my.source"`.
- Filter attributes get set on the Knative trigger that is being created as part of this integration.
+ description: Sets filter attributes on the event stream (such
+ as event type, source, subject and so on). A list of key-value
+ pairs that represent filter attributes and its values. The
+ syntax is KEY=VALUE, e.g., `source="my.source"`. Filter
+ attributes get set on the Knative trigger that is being
+ created as part of this integration.
items:
type: string
type: array
namespaceLabel:
- description: |-
- Enables the camel-k-operator to set the "bindings.knative.dev/include=true" label to the namespace
- As Knative requires this label to perform injection of K_SINK URL into the service.
- If this is false, the integration pod may start and fail, read the SinkBinding Knative documentation. (default: true)
+ description: 'Enables the camel-k-operator to set the "bindings.knative.dev/include=true"
+ label to the namespace As Knative requires this label to
+ perform injection of K_SINK URL into the service. If this
+ is false, the integration pod may start and fail, read the
+ SinkBinding Knative documentation. (default: true)'
type: boolean
sinkBinding:
- description: |-
- Allows binding the integration to a sink via a Knative SinkBinding resource.
- This can be used when the integration targets a single sink.
- It's enabled by default when the integration targets a single sink
- (except when the integration is owned by a Knative source).
+ description: Allows binding the integration to a sink via
+ a Knative SinkBinding resource. This can be used when the
+ integration targets a single sink. It's enabled by default
+ when the integration targets a single sink (except when
+ the integration is owned by a Knative source).
type: boolean
type: object
knative-service:
@@ -1483,47 +1459,39 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to route.
- This can be used to set knative service specific annotations
- CLI usage example: -t "knative-service.annotations.'haproxy.router.openshift.io/balance'=true"
+ description: 'The annotations added to route. This can be
+ used to set knative service specific annotations CLI usage
+ example: -t "knative-service.annotations.''haproxy.router.openshift.io/balance''=true"'
type: object
auto:
- description: |-
- Automatically deploy the integration as Knative service when all conditions hold:
-
-
- * Integration is using the Knative profile
- * All routes are either starting from an HTTP based consumer or a passive consumer (e.g. `direct` is a passive consumer)
+ description: "Automatically deploy the integration as Knative
+ service when all conditions hold: \n * Integration is using
+ the Knative profile * All routes are either starting from
+ an HTTP based consumer or a passive consumer (e.g. `direct`
+ is a passive consumer)"
type: boolean
autoscalingMetric:
- description: |-
- Configures the Knative autoscaling metric property (e.g. to set `concurrency` based or `cpu` based autoscaling).
-
-
- Refer to the Knative documentation for more information.
+ description: "Configures the Knative autoscaling metric property
+ (e.g. to set `concurrency` based or `cpu` based autoscaling).
+ \n Refer to the Knative documentation for more information."
type: string
autoscalingTarget:
- description: |-
- Sets the allowed concurrency level or CPU percentage (depending on the autoscaling metric) for each Pod.
-
-
- Refer to the Knative documentation for more information.
+ description: "Sets the allowed concurrency level or CPU percentage
+ (depending on the autoscaling metric) for each Pod. \n Refer
+ to the Knative documentation for more information."
type: integer
class:
- description: |-
- Configures the Knative autoscaling class property (e.g. to set `hpa.autoscaling.knative.dev` or `kpa.autoscaling.knative.dev` autoscaling).
-
-
- Refer to the Knative documentation for more information.
+ description: "Configures the Knative autoscaling class property
+ (e.g. to set `hpa.autoscaling.knative.dev` or `kpa.autoscaling.knative.dev`
+ autoscaling). \n Refer to the Knative documentation for
+ more information."
enum:
- kpa.autoscaling.knative.dev
- hpa.autoscaling.knative.dev
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1531,43 +1499,36 @@ spec:
traits share this common property.
type: boolean
maxScale:
- description: |-
- An upper bound for the number of Pods that can be running in parallel for the integration.
- Knative has its own cap value that depends on the installation.
-
-
- Refer to the Knative documentation for more information.
+ description: "An upper bound for the number of Pods that can
+ be running in parallel for the integration. Knative has
+ its own cap value that depends on the installation. \n Refer
+ to the Knative documentation for more information."
type: integer
minScale:
- description: |-
- The minimum number of Pods that should be running at any time for the integration. It's **zero** by default, meaning that
- the integration is scaled down to zero when not used for a configured amount of time.
-
-
- Refer to the Knative documentation for more information.
+ description: "The minimum number of Pods that should be running
+ at any time for the integration. It's **zero** by default,
+ meaning that the integration is scaled down to zero when
+ not used for a configured amount of time. \n Refer to the
+ Knative documentation for more information."
type: integer
rolloutDuration:
- description: |-
- Enables to gradually shift traffic to the latest Revision and sets the rollout duration.
- It's disabled by default and must be expressed as a Golang `time.Duration` string representation,
- rounded to a second precision.
+ description: Enables to gradually shift traffic to the latest
+ Revision and sets the rollout duration. It's disabled by
+ default and must be expressed as a Golang `time.Duration`
+ string representation, rounded to a second precision.
type: string
timeoutSeconds:
- description: |-
- The maximum duration in seconds that the request instance is allowed to respond to a request.
- This field propagates to the integration pod's terminationGracePeriodSeconds
-
-
- Refer to the Knative documentation for more information.
+ description: "The maximum duration in seconds that the request
+ instance is allowed to respond to a request. This field
+ propagates to the integration pod's terminationGracePeriodSeconds
+ \n Refer to the Knative documentation for more information."
format: int64
type: integer
visibility:
- description: |-
- Setting `cluster-local`, Knative service becomes a private service.
- Specifically, this option applies the `networking.knative.dev/visibility` label to Knative service.
-
-
- Refer to the Knative documentation for more information.
+ description: "Setting `cluster-local`, Knative service becomes
+ a private service. Specifically, this option applies the
+ `networking.knative.dev/visibility` label to Knative service.
+ \n Refer to the Knative documentation for more information."
enum:
- cluster-local
type: string
@@ -1579,9 +1540,8 @@ spec:
description: Colorize the log output
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1621,18 +1581,20 @@ spec:
description: The configuration of Mount trait
properties:
configs:
- description: |-
- A list of configuration pointing to configmap/secret.
- The configuration are expected to be UTF-8 resources as they are processed by runtime Camel Context and tried to be parsed as property files.
- They are also made available on the classpath in order to ease their usage directly from the Route.
- Syntax: [configmap|secret]:name[/key], where name represents the resource name and key optionally represents the resource key to be filtered
+ description: 'A list of configuration pointing to configmap/secret.
+ The configuration are expected to be UTF-8 resources as
+ they are processed by runtime Camel Context and tried to
+ be parsed as property files. They are also made available
+ on the classpath in order to ease their usage directly from
+ the Route. Syntax: [configmap|secret]:name[/key], where
+ name represents the resource name and key optionally represents
+ the resource key to be filtered'
items:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
emptyDirs:
@@ -1645,17 +1607,21 @@ spec:
description: 'Deprecated: no longer in use.'
type: boolean
hotReload:
- description: |-
- Enable "hot reload" when a secret/configmap mounted is edited (default `false`). The configmap/secret must be
- marked with `camel.apache.org/integration` label to be taken in account. The resource will be watched for any kind change, also for
- changes in metadata.
+ description: Enable "hot reload" when a secret/configmap mounted
+ is edited (default `false`). The configmap/secret must be
+ marked with `camel.apache.org/integration` label to be taken
+ in account. The resource will be watched for any kind change,
+ also for changes in metadata.
type: boolean
resources:
- description: |-
- A list of resources (text or binary content) pointing to configmap/secret.
- The resources are expected to be any resource type (text or binary content).
- The destination path can be either a default location or any path specified by the user.
- Syntax: [configmap|secret]:name[/key][@path], where name represents the resource name, key optionally represents the resource key to be filtered and path represents the destination path
+ description: 'A list of resources (text or binary content)
+ pointing to configmap/secret. The resources are expected
+ to be any resource type (text or binary content). The destination
+ path can be either a default location or any path specified
+ by the user. Syntax: [configmap|secret]:name[/key][@path],
+ where name represents the resource name, key optionally
+ represents the resource key to be filtered and path represents
+ the destination path'
items:
type: string
type: array
@@ -1680,9 +1646,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1693,9 +1658,8 @@ spec:
description: The configuration of Owner trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1717,9 +1681,8 @@ spec:
description: The configuration of PDB trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1727,53 +1690,56 @@ spec:
traits share this common property.
type: boolean
maxUnavailable:
- description: |-
- The number of pods for the Integration that can be unavailable after an eviction.
- It can be either an absolute number or a percentage (default `1` if `min-available` is also not set).
- Only one of `max-unavailable` and `min-available` can be specified.
+ description: The number of pods for the Integration that can
+ be unavailable after an eviction. It can be either an absolute
+ number or a percentage (default `1` if `min-available` is
+ also not set). Only one of `max-unavailable` and `min-available`
+ can be specified.
type: string
minAvailable:
- description: |-
- The number of pods for the Integration that must still be available after an eviction.
- It can be either an absolute number or a percentage.
- Only one of `min-available` and `max-unavailable` can be specified.
+ description: The number of pods for the Integration that must
+ still be available after an eviction. It can be either an
+ absolute number or a percentage. Only one of `min-available`
+ and `max-unavailable` can be specified.
type: string
type: object
platform:
description: The configuration of Platform trait
properties:
auto:
- description: |-
- To automatically detect from the environment if a default platform can be created (it will be created on OpenShift or when a registry address is set).
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'To automatically detect from the environment
+ if a default platform can be created (it will be created
+ on OpenShift or when a registry address is set). Deprecated:
+ Platform is auto generated by the operator install procedure
+ - maintained for backward compatibility'
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
createDefault:
- description: |-
- To create a default (empty) platform when the platform is missing.
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'To create a default (empty) platform when the
+ platform is missing. Deprecated: Platform is auto generated
+ by the operator install procedure - maintained for backward
+ compatibility'
type: boolean
enabled:
description: 'Deprecated: no longer in use.'
type: boolean
global:
- description: |-
- Indicates if the platform should be created globally in the case of global operator (default true).
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'Indicates if the platform should be created
+ globally in the case of global operator (default true).
+ Deprecated: Platform is auto generated by the operator install
+ procedure - maintained for backward compatibility'
type: boolean
type: object
pod:
description: The configuration of Pod trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1785,9 +1751,8 @@ spec:
description: The configuration of Prometheus trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1813,9 +1778,8 @@ spec:
secret on the pod if it is of type `kubernetes.io/dockerconfigjson`.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1838,10 +1802,10 @@ spec:
description: The configuration of Quarkus trait
properties:
buildMode:
- description: |-
- The Quarkus mode to run: either `jvm` or `native` (default `jvm`).
- In case both `jvm` and `native` are specified, two `IntegrationKit` resources are created,
- with the `native` kit having precedence over the `jvm` one once ready.
+ description: 'The Quarkus mode to run: either `jvm` or `native`
+ (default `jvm`). In case both `jvm` and `native` are specified,
+ two `IntegrationKit` resources are created, with the `native`
+ kit having precedence over the `jvm` one once ready.'
items:
description: QuarkusMode is the type of Quarkus build packaging.
enum:
@@ -1850,9 +1814,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1868,18 +1831,18 @@ spec:
in the runtime catalog)
type: string
packageTypes:
- description: |-
- The Quarkus package types, `fast-jar` or `native` (default `fast-jar`).
- In case both `fast-jar` and `native` are specified, two `IntegrationKit` resources are created,
- with the native kit having precedence over the `fast-jar` one once ready.
- The order influences the resolution of the current kit for the integration.
- The kit corresponding to the first package type will be assigned to the
- integration in case no existing kit that matches the integration exists.
- Deprecated: use `build-mode` instead.
+ description: 'The Quarkus package types, `fast-jar` or `native`
+ (default `fast-jar`). In case both `fast-jar` and `native`
+ are specified, two `IntegrationKit` resources are created,
+ with the native kit having precedence over the `fast-jar`
+ one once ready. The order influences the resolution of the
+ current kit for the integration. The kit corresponding to
+ the first package type will be assigned to the integration
+ in case no existing kit that matches the integration exists.
+ Deprecated: use `build-mode` instead.'
items:
- description: |-
- QuarkusPackageType is the type of Quarkus build packaging.
- Deprecated: use `QuarkusMode` instead.
+ description: 'QuarkusPackageType is the type of Quarkus
+ build packaging. Deprecated: use `QuarkusMode` instead.'
enum:
- fast-jar
- native
@@ -1887,14 +1850,12 @@ spec:
type: array
type: object
registry:
- description: |-
- The configuration of Registry trait (support removed since version 2.5.0).
- Deprecated: use jvm trait or read documentation.
+ description: 'The configuration of Registry trait (support removed
+ since version 2.5.0). Deprecated: use jvm trait or read documentation.'
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1908,16 +1869,14 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to route.
- This can be used to set route specific annotations
- For annotations options see https://docs.openshift.com/container-platform/3.11/architecture/networking/routes.html#route-specific-annotations
- CLI usage example: -t "route.annotations.'haproxy.router.openshift.io/balance'=true"
+ description: 'The annotations added to route. This can be
+ used to set route specific annotations For annotations options
+ see https://docs.openshift.com/container-platform/3.11/architecture/networking/routes.html#route-specific-annotations
+ CLI usage example: -t "route.annotations.''haproxy.router.openshift.io/balance''=true"'
type: object
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1928,82 +1887,74 @@ spec:
description: To configure the host exposed by the route.
type: string
tlsCACertificate:
- description: |-
- The TLS CA certificate contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS CA certificate contents. \n Refer to
+ the OpenShift route documentation for additional information."
type: string
tlsCACertificateSecret:
- description: |-
- The secret name and key reference to the TLS CA certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the TLS
+ CA certificate. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only one
+ key in the secret it will be read, otherwise you can set
+ a key name separated with a \"/\". \n Refer to the OpenShift
+ route documentation for additional information."
type: string
tlsCertificate:
- description: |-
- The TLS certificate contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS certificate contents. \n Refer to the
+ OpenShift route documentation for additional information."
type: string
tlsCertificateSecret:
- description: |-
- The secret name and key reference to the TLS certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the TLS
+ certificate. The format is \"secret-name[/key-name]\", the
+ value represents the secret name, if there is only one key
+ in the secret it will be read, otherwise you can set a key
+ name separated with a \"/\". \n Refer to the OpenShift route
+ documentation for additional information."
type: string
tlsDestinationCACertificate:
- description: |-
- The destination CA certificate provides the contents of the ca certificate of the final destination. When using reencrypt
- termination this file should be provided in order to have routers use it for health checks on the secure connection.
- If this field is not specified, the router may provide its own destination CA and perform hostname validation using
- the short service name (service.namespace.svc), which allows infrastructure generated certificates to automatically
- verify.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The destination CA certificate provides the
+ contents of the ca certificate of the final destination.
+ \ When using reencrypt termination this file should be provided
+ in order to have routers use it for health checks on the
+ secure connection. If this field is not specified, the router
+ may provide its own destination CA and perform hostname
+ validation using the short service name (service.namespace.svc),
+ which allows infrastructure generated certificates to automatically
+ verify. \n Refer to the OpenShift route documentation for
+ additional information."
type: string
tlsDestinationCACertificateSecret:
- description: |-
- The secret name and key reference to the destination CA certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the destination
+ CA certificate. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only one
+ key in the secret it will be read, otherwise you can set
+ a key name separated with a \"/\". \n Refer to the OpenShift
+ route documentation for additional information."
type: string
tlsInsecureEdgeTerminationPolicy:
- description: |-
- To configure how to deal with insecure traffic, e.g. `Allow`, `Disable` or `Redirect` traffic.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "To configure how to deal with insecure traffic,
+ e.g. `Allow`, `Disable` or `Redirect` traffic. \n Refer
+ to the OpenShift route documentation for additional information."
enum:
- None
- Allow
- Redirect
type: string
tlsKey:
- description: |-
- The TLS certificate key contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS certificate key contents. \n Refer to
+ the OpenShift route documentation for additional information."
type: string
tlsKeySecret:
- description: |-
- The secret name and key reference to the TLS certificate key. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the TLS
+ certificate key. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only one
+ key in the secret it will be read, otherwise you can set
+ a key name separated with a \"/\". \n Refer to the OpenShift
+ route documentation for additional information."
type: string
tlsTermination:
- description: |-
- The TLS termination type, like `edge`, `passthrough` or `reencrypt`.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS termination type, like `edge`, `passthrough`
+ or `reencrypt`. \n Refer to the OpenShift route documentation
+ for additional information."
enum:
- edge
- reencrypt
@@ -2014,9 +1965,8 @@ spec:
description: The configuration of Security Context trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -2048,9 +1998,8 @@ spec:
needs to be created.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -2058,9 +2007,8 @@ spec:
traits share this common property.
type: boolean
nodePort:
- description: |-
- Enable Service to be exposed as NodePort (default `false`).
- Deprecated: Use service type instead.
+ description: 'Enable Service to be exposed as NodePort (default
+ `false`). Deprecated: Use service type instead.'
type: boolean
type:
description: The type of service to be used, either 'ClusterIP',
@@ -2075,9 +2023,8 @@ spec:
description: The configuration of Service Binding trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -2104,9 +2051,8 @@ spec:
description: The configuration of Toleration trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -2143,14 +2089,13 @@ spec:
description: 'Deprecated: no longer in use'
type: object
baseImage:
- description: |-
- a base image that can be used as base layer for all images.
- It can be useful if you want to provide some custom base image with further utility software
+ description: a base image that can be used as base layer for all
+ images. It can be useful if you want to provide some custom
+ base image with further utility software
type: string
buildCatalogToolTimeout:
- description: |-
- the timeout (in seconds) to use when creating the build tools container image
- Deprecated: no longer in use
+ description: 'the timeout (in seconds) to use when creating the
+ build tools container image Deprecated: no longer in use'
type: string
buildConfiguration:
description: the configuration required to build an Integration
@@ -2216,13 +2161,13 @@ spec:
applications
properties:
caSecrets:
- description: |-
- The Secrets name and key, containing the CA certificate(s) used to connect
- to remote Maven repositories.
- It can contain X.509 certificates, and PKCS#7 formatted certificate chains.
- A JKS formatted keystore is automatically created to store the CA certificate(s),
- and configured to be used as a trusted certificate(s) by the Maven commands.
- Note that the root CA certificates are also imported into the created keystore.
+ description: The Secrets name and key, containing the CA certificate(s)
+ used to connect to remote Maven repositories. It can contain
+ X.509 certificates, and PKCS#7 formatted certificate chains.
+ A JKS formatted keystore is automatically created to store
+ the CA certificate(s), and configured to be used as a trusted
+ certificate(s) by the Maven commands. Note that the root
+ CA certificates are also imported into the created keystore.
items:
description: SecretKeySelector selects a key of a Secret.
properties:
@@ -2231,10 +2176,8 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
description: Specify whether the Secret or its key must
@@ -2243,20 +2186,16 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: array
cliOptions:
- description: |-
- The CLI options that are appended to the list of arguments for Maven commands,
- e.g., `-V,--no-transfer-progress,-Dstyle.color=never`.
+ description: The CLI options that are appended to the list
+ of arguments for Maven commands, e.g., `-V,--no-transfer-progress,-Dstyle.color=never`.
See https://maven.apache.org/ref/3.8.4/maven-embedder/cli.html.
items:
type: string
type: array
extension:
- description: |-
- The Maven build extensions.
- See https://maven.apache.org/guides/mini/guide-using-extensions.html.
+ description: The Maven build extensions. See https://maven.apache.org/guides/mini/guide-using-extensions.html.
items:
description: MavenArtifact defines a GAV (Group:Artifact:Type:Version:Classifier)
Maven artifact.
@@ -2285,9 +2224,8 @@ spec:
description: The path of the local Maven repository.
type: string
profiles:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the Maven profile.
+ description: A reference to the ConfigMap or Secret key that
+ contains the Maven profile.
items:
description: ValueSource --.
properties:
@@ -2298,10 +2236,9 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the ConfigMap or its
@@ -2310,7 +2247,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -2319,10 +2255,9 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the Secret or its key
@@ -2331,7 +2266,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
properties:
@@ -2340,9 +2274,8 @@ spec:
description: The Maven properties.
type: object
settings:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the Maven settings.
+ description: A reference to the ConfigMap or Secret key that
+ contains the Maven settings.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -2351,10 +2284,9 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the ConfigMap or its
@@ -2363,7 +2295,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -2372,10 +2303,9 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the Secret or its key
@@ -2384,12 +2314,10 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
settingsSecurity:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the security of the Maven settings.
+ description: A reference to the ConfigMap or Secret key that
+ contains the security of the Maven settings.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -2398,10 +2326,9 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the ConfigMap or its
@@ -2410,7 +2337,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -2419,10 +2345,9 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the Secret or its key
@@ -2431,7 +2356,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: object
maxRunningBuilds:
@@ -2516,13 +2440,12 @@ spec:
type: object
type: array
configuration:
- description: |-
- Deprecated:
- Use camel trait (camel.properties) to manage properties
- Use mount trait (mount.configs) to manage configs
- Use mount trait (mount.resources) to manage resources
- Use mount trait (mount.volumes) to manage volumes
- list of configuration properties to be attached to all the Integration/IntegrationKits built from this IntegrationPlatform
+ description: 'Deprecated: Use camel trait (camel.properties) to manage
+ properties Use mount trait (mount.configs) to manage configs Use
+ mount trait (mount.resources) to manage resources Use mount trait
+ (mount.volumes) to manage volumes list of configuration properties
+ to be attached to all the Integration/IntegrationKits built from
+ this IntegrationPlatform'
items:
description: ConfigurationSpec represents a generic configuration
specification.
@@ -2571,9 +2494,10 @@ spec:
description: defines in what phase the IntegrationPlatform is found
type: string
profile:
- description: |-
- the profile you wish to use. It will apply certain traits which are required by the specific profile chosen.
- It usually relates the Cluster with the optional definition of special profiles (ie, Knative)
+ description: the profile you wish to use. It will apply certain traits
+ which are required by the specific profile chosen. It usually relates
+ the Cluster with the optional definition of special profiles (ie,
+ Knative)
type: string
traits:
description: list of traits to be executed for all the Integration/IntegrationKits
@@ -2601,9 +2525,8 @@ spec:
description: The configuration of Affinity trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -2622,9 +2545,9 @@ spec:
in the same node (default `false`).
type: boolean
podAffinityLabels:
- description: |-
- Defines a set of pods (namely those matching the label selector, relative to the given namespace) that the
- integration pod(s) should be co-located with.
+ description: Defines a set of pods (namely those matching
+ the label selector, relative to the given namespace) that
+ the integration pod(s) should be co-located with.
items:
type: string
type: array
@@ -2633,9 +2556,9 @@ spec:
in the same node (default `false`).
type: boolean
podAntiAffinityLabels:
- description: |-
- Defines a set of pods (namely those matching the label selector, relative to the given namespace) that the
- integration pod(s) should not be co-located with.
+ description: Defines a set of pods (namely those matching
+ the label selector, relative to the given namespace) that
+ the integration pod(s) should not be co-located with.
items:
type: string
type: array
@@ -2650,14 +2573,13 @@ spec:
for the builder pod.
type: object
baseImage:
- description: |-
- Specify a base image. In order to have the application working properly it must be a container image which has a Java JDK
- installed and ready to use on path (ie `/usr/bin/java`).
+ description: Specify a base image. In order to have the application
+ working properly it must be a container image which has
+ a Java JDK installed and ready to use on path (ie `/usr/bin/java`).
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -2668,21 +2590,27 @@ spec:
existing containers (default `true`)
type: boolean
limitCPU:
- description: |-
- When using `pod` strategy, the maximum amount of CPU required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the maximum amount
+ of CPU required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
limitMemory:
- description: |-
- When using `pod` strategy, the maximum amount of memory required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the maximum amount
+ of memory required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
mavenProfiles:
- description: |-
- A list of references pointing to configmaps/secrets that contains a maven profile.
- This configmap/secret is a resource of the IntegrationKit created, therefore it needs to be present in the namespace where the operator is going to create the IntegrationKit.
- The content of the maven profile is expected to be a text containing a valid maven profile starting with `` and ending with `` that will be integrated as an inline profile in the POM.
- Syntax: [configmap|secret]:name[/key], where name represents the resource name, key optionally represents the resource key to be filtered (default key value = profile.xml).
+ description: 'A list of references pointing to configmaps/secrets
+ that contains a maven profile. This configmap/secret is
+ a resource of the IntegrationKit created, therefore it needs
+ to be present in the namespace where the operator is going
+ to create the IntegrationKit. The content of the maven profile
+ is expected to be a text containing a valid maven profile
+ starting with `` and ending with `` that
+ will be integrated as an inline profile in the POM. Syntax:
+ [configmap|secret]:name[/key], where name represents the
+ resource name, key optionally represents the resource key
+ to be filtered (default key value = profile.xml).'
items:
type: string
type: array
@@ -2713,14 +2641,14 @@ spec:
type: string
type: array
requestCPU:
- description: |-
- When using `pod` strategy, the minimum amount of CPU required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the minimum amount
+ of CPU required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
requestMemory:
- description: |-
- When using `pod` strategy, the minimum amount of memory required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the minimum amount
+ of memory required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
strategy:
description: The strategy to use, either `pod` or `routine`
@@ -2736,10 +2664,11 @@ spec:
type: string
type: array
tasksFilter:
- description: |-
- A list of tasks sorted by the order of execution in a csv format, ie, `,,...`.
- Mind that you must include also the operator tasks (`builder`, `quarkus-native`, `package`, `jib`, `s2i`)
- if you need to execute them. Useful only with `pod` strategy.
+ description: A list of tasks sorted by the order of execution
+ in a csv format, ie, `,,...`. Mind
+ that you must include also the operator tasks (`builder`,
+ `quarkus-native`, `package`, `jib`, `s2i`) if you need to
+ execute them. Useful only with `pod` strategy.
type: string
tasksLimitCPU:
description: A list of limit cpu configuration for the specific
@@ -2766,18 +2695,17 @@ spec:
type: string
type: array
verbose:
- description: |-
- Enable verbose logging on build components that support it (e.g. Kaniko build pod).
- Deprecated no longer in use
+ description: Enable verbose logging on build components that
+ support it (e.g. Kaniko build pod). Deprecated no longer
+ in use
type: boolean
type: object
camel:
description: The configuration of Camel trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -2790,10 +2718,12 @@ spec:
type: string
type: array
runtimeVersion:
- description: |-
- The camel-k-runtime version to use for the integration. It overrides the default version set in the Integration Platform.
- You can use a fixed version (for example "3.2.3") or a semantic version (for example "3.x") which will try to resolve
- to the best matching Catalog existing on the cluster.
+ description: The camel-k-runtime version to use for the integration.
+ It overrides the default version set in the Integration
+ Platform. You can use a fixed version (for example "3.2.3")
+ or a semantic version (for example "3.x") which will try
+ to resolve to the best matching Catalog existing on the
+ cluster.
type: string
type: object
container:
@@ -2821,9 +2751,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -2834,10 +2763,13 @@ spec:
Service.
type: boolean
image:
- description: |-
- The main container image to use for the Integration. When using this parameter the operator will create a synthetic IntegrationKit which
- won't be able to execute traits requiring CamelCatalog. If the container image you're using is coming from an IntegrationKit, use instead
- Integration `.spec.integrationKit` parameter. If you're moving the Integration across environments, you will also need to create an "external" IntegrationKit.
+ description: The main container image to use for the Integration.
+ When using this parameter the operator will create a synthetic
+ IntegrationKit which won't be able to execute traits requiring
+ CamelCatalog. If the container image you're using is coming
+ from an IntegrationKit, use instead Integration `.spec.integrationKit`
+ parameter. If you're moving the Integration across environments,
+ you will also need to create an "external" IntegrationKit.
type: string
imagePullPolicy:
description: 'The pull policy: Always|Never|IfNotPresent'
@@ -2905,52 +2837,50 @@ spec:
description: The configuration of Cron trait
properties:
activeDeadlineSeconds:
- description: |-
- Specifies the duration in seconds, relative to the start time, that the job
- may be continuously active before it is considered to be failed.
- It defaults to 60s.
+ description: Specifies the duration in seconds, relative to
+ the start time, that the job may be continuously active
+ before it is considered to be failed. It defaults to 60s.
format: int64
type: integer
auto:
- description: |-
- Automatically deploy the integration as CronJob when all routes are
- either starting from a periodic consumer (only `cron`, `timer` and `quartz` are supported) or a passive consumer (e.g. `direct` is a passive consumer).
-
-
- It's required that all periodic consumers have the same period, and it can be expressed as cron schedule (e.g. `1m` can be expressed as `0/1 * * * *`,
- while `35m` or `50s` cannot).
+ description: "Automatically deploy the integration as CronJob
+ when all routes are either starting from a periodic consumer
+ (only `cron`, `timer` and `quartz` are supported) or a passive
+ consumer (e.g. `direct` is a passive consumer). \n It's
+ required that all periodic consumers have the same period,
+ and it can be expressed as cron schedule (e.g. `1m` can
+ be expressed as `0/1 * * * *`, while `35m` or `50s` cannot)."
type: boolean
backoffLimit:
- description: |-
- Specifies the number of retries before marking the job failed.
- It defaults to 2.
+ description: Specifies the number of retries before marking
+ the job failed. It defaults to 2.
format: int32
type: integer
components:
- description: |-
- A comma separated list of the Camel components that need to be customized in order for them to work when the schedule is triggered externally by Kubernetes.
- A specific customizer is activated for each specified component. E.g. for the `timer` component, the `cron-timer` customizer is
- activated (it's present in the `org.apache.camel.k:camel-k-cron` library).
-
-
- Supported components are currently: `cron`, `timer` and `quartz`.
+ description: "A comma separated list of the Camel components
+ that need to be customized in order for them to work when
+ the schedule is triggered externally by Kubernetes. A specific
+ customizer is activated for each specified component. E.g.
+ for the `timer` component, the `cron-timer` customizer is
+ activated (it's present in the `org.apache.camel.k:camel-k-cron`
+ library). \n Supported components are currently: `cron`,
+ `timer` and `quartz`."
type: string
concurrencyPolicy:
- description: |-
- Specifies how to treat concurrent executions of a Job.
- Valid values are:
- - "Allow": allows CronJobs to run concurrently;
- - "Forbid" (default): forbids concurrent runs, skipping next run if previous run hasn't finished yet;
- - "Replace": cancels currently running job and replaces it with a new one
+ description: 'Specifies how to treat concurrent executions
+ of a Job. Valid values are: - "Allow": allows CronJobs to
+ run concurrently; - "Forbid" (default): forbids concurrent
+ runs, skipping next run if previous run hasn''t finished
+ yet; - "Replace": cancels currently running job and replaces
+ it with a new one'
enum:
- Allow
- Forbid
- Replace
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -2958,19 +2888,19 @@ spec:
traits share this common property.
type: boolean
fallback:
- description: |-
- Use the default Camel implementation of the `cron` endpoint (`quartz`) instead of trying to materialize the integration
- as Kubernetes CronJob.
+ description: Use the default Camel implementation of the `cron`
+ endpoint (`quartz`) instead of trying to materialize the
+ integration as Kubernetes CronJob.
type: boolean
schedule:
- description: |-
- The CronJob schedule for the whole integration. If multiple routes are declared, they must have the same schedule for this
- mechanism to work correctly.
+ description: The CronJob schedule for the whole integration.
+ If multiple routes are declared, they must have the same
+ schedule for this mechanism to work correctly.
type: string
startingDeadlineSeconds:
- description: |-
- Optional deadline in seconds for starting the job if it misses scheduled
- time for any reason. Missed jobs executions will be counted as failed ones.
+ description: Optional deadline in seconds for starting the
+ job if it misses scheduled time for any reason. Missed
+ jobs executions will be counted as failed ones.
format: int64
type: integer
timeZone:
@@ -2981,9 +2911,8 @@ spec:
description: The configuration of Dependencies trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -2994,9 +2923,8 @@ spec:
description: The configuration of Deployer trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3012,51 +2940,49 @@ spec:
- knative-service
type: string
useSSA:
- description: |-
- Use server-side apply to update the owned resources (default `true`).
- Note that it automatically falls back to client-side patching, if SSA is not available, e.g., on old Kubernetes clusters.
+ description: Use server-side apply to update the owned resources
+ (default `true`). Note that it automatically falls back
+ to client-side patching, if SSA is not available, e.g.,
+ on old Kubernetes clusters.
type: boolean
type: object
deployment:
description: The configuration of Deployment trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
description: 'Deprecated: no longer in use.'
type: boolean
progressDeadlineSeconds:
- description: |-
- The maximum time in seconds for the deployment to make progress before it
- is considered to be failed. It defaults to `60s`.
+ description: The maximum time in seconds for the deployment
+ to make progress before it is considered to be failed. It
+ defaults to `60s`.
format: int32
type: integer
rollingUpdateMaxSurge:
anyOf:
- type: integer
- type: string
- description: |-
- The maximum number of pods that can be scheduled above the desired number of
- pods.
- Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
- This can not be 0 if MaxUnavailable is 0.
- Absolute number is calculated from percentage by rounding up.
- Defaults to `25%`.
+ description: 'The maximum number of pods that can be scheduled
+ above the desired number of pods. Value can be an absolute
+ number (ex: 5) or a percentage of desired pods (ex: 10%).
+ This can not be 0 if MaxUnavailable is 0. Absolute number
+ is calculated from percentage by rounding up. Defaults to
+ `25%`.'
x-kubernetes-int-or-string: true
rollingUpdateMaxUnavailable:
anyOf:
- type: integer
- type: string
- description: |-
- The maximum number of pods that can be unavailable during the update.
- Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
- Absolute number is calculated from percentage by rounding down.
- This can not be 0 if MaxSurge is 0.
- Defaults to `25%`.
+ description: 'The maximum number of pods that can be unavailable
+ during the update. Value can be an absolute number (ex:
+ 5) or a percentage of desired pods (ex: 10%). Absolute number
+ is calculated from percentage by rounding down. This can
+ not be 0 if MaxSurge is 0. Defaults to `25%`.'
x-kubernetes-int-or-string: true
strategy:
description: The deployment strategy to use to replace existing
@@ -3070,9 +2996,8 @@ spec:
description: The configuration of Environment trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
containerMeta:
@@ -3087,11 +3012,12 @@ spec:
`NO_PROXY` environment variables (default `true`)
type: boolean
vars:
- description: |-
- A list of environment variables to be added to the integration container.
- The syntax is either VAR=VALUE or VAR=[configmap|secret]:name/key, where name represents the resource name,
- and key represents the resource key to be mapped as and environment variable.
- These take precedence over any previously defined environment variables.
+ description: A list of environment variables to be added to
+ the integration container. The syntax is either VAR=VALUE
+ or VAR=[configmap|secret]:name/key, where name represents
+ the resource name, and key represents the resource key to
+ be mapped as and environment variable. These take precedence
+ over any previously defined environment variables.
items:
type: string
type: array
@@ -3100,9 +3026,8 @@ spec:
description: The configuration of Error Handler trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3117,15 +3042,14 @@ spec:
description: The configuration of GC trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
discoveryCache:
- description: |-
- Discovery client cache to be used, either `disabled`, `disk` or `memory` (default `memory`).
- Deprecated: to be removed from trait configuration.
+ description: 'Discovery client cache to be used, either `disabled`,
+ `disk` or `memory` (default `memory`). Deprecated: to be
+ removed from trait configuration.'
enum:
- disabled
- disk
@@ -3140,9 +3064,8 @@ spec:
description: The configuration of Health trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3264,19 +3187,17 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to the ingress.
- This can be used to set controller specific annotations, e.g., when using the NGINX Ingress controller:
- See https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md
+ description: 'The annotations added to the ingress. This can
+ be used to set controller specific annotations, e.g., when
+ using the NGINX Ingress controller: See https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md'
type: object
auto:
description: To automatically add an ingress whenever the
integration uses an HTTP endpoint consumer.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3286,14 +3207,18 @@ spec:
host:
description: To configure the host exposed by the ingress.
type: string
+ ingressClassName:
+ description: The Ingress class name as defined by the Ingress
+ spec See https://kubernetes.io/docs/concepts/services-networking/ingress/
+ type: string
path:
description: To configure the path exposed by the ingress
(default `/`).
type: string
pathType:
- description: |-
- To configure the path type exposed by the ingress.
- One of `Exact`, `Prefix`, `ImplementationSpecific` (default to `Prefix`).
+ description: To configure the path type exposed by the ingress.
+ One of `Exact`, `Prefix`, `ImplementationSpecific` (default
+ to `Prefix`).
enum:
- Exact
- Prefix
@@ -3317,9 +3242,8 @@ spec:
by default).
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3336,23 +3260,25 @@ spec:
description: The configuration of Jolokia trait
properties:
CACert:
- description: |-
- The PEM encoded CA certification file path, used to verify client certificates,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt` for OpenShift).
+ description: The PEM encoded CA certification file path, used
+ to verify client certificates, applicable when `protocol`
+ is `https` and `use-ssl-client-authentication` is `true`
+ (default `/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt`
+ for OpenShift).
type: string
clientPrincipal:
- description: |-
- The principal(s) which must be given in a client certificate to allow access to the Jolokia endpoint,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `clientPrincipal=cn=system:master-proxy`, `cn=hawtio-online.hawtio.svc` and `cn=fuse-console.fuse.svc` for OpenShift).
+ description: The principal(s) which must be given in a client
+ certificate to allow access to the Jolokia endpoint, applicable
+ when `protocol` is `https` and `use-ssl-client-authentication`
+ is `true` (default `clientPrincipal=cn=system:master-proxy`,
+ `cn=hawtio-online.hawtio.svc` and `cn=fuse-console.fuse.svc`
+ for OpenShift).
items:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
discoveryEnabled:
@@ -3363,20 +3289,20 @@ spec:
traits share this common property.
type: boolean
extendedClientCheck:
- description: |-
- Mandate the client certificate contains a client flag in the extended key usage section,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `true` for OpenShift).
+ description: Mandate the client certificate contains a client
+ flag in the extended key usage section, applicable when
+ `protocol` is `https` and `use-ssl-client-authentication`
+ is `true` (default `true` for OpenShift).
type: boolean
host:
- description: |-
- The Host address to which the Jolokia agent should bind to. If `"\*"` or `"0.0.0.0"` is given,
- the servers binds to every network interface (default `"*"`).
+ description: The Host address to which the Jolokia agent should
+ bind to. If `"\*"` or `"0.0.0.0"` is given, the servers
+ binds to every network interface (default `"*"`).
type: string
options:
- description: |-
- A list of additional Jolokia options as defined
- in https://jolokia.org/reference/html/agents.html#agent-jvm-config[JVM agent configuration options]
+ description: A list of additional Jolokia options as defined
+ in https://jolokia.org/reference/html/agents.html#agent-jvm-config[JVM
+ agent configuration options]
items:
type: string
type: array
@@ -3407,9 +3333,8 @@ spec:
separator)
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
debug:
@@ -3438,9 +3363,9 @@ spec:
type: string
type: array
printCommand:
- description: |-
- Prints the command used the start the JVM in the container logs (default `true`)
- Deprecated: no longer in use.
+ description: 'Prints the command used the start the JVM in
+ the container logs (default `true`) Deprecated: no longer
+ in use.'
type: boolean
type: object
kamelets:
@@ -3451,9 +3376,8 @@ spec:
and their default configuration (enabled by default)
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3486,16 +3410,14 @@ spec:
description: Enable automatic discovery of all trait properties.
type: boolean
channelSinks:
- description: |-
- List of channels used as destination of integration routes.
- Can contain simple channel names or full Camel URIs.
+ description: List of channels used as destination of integration
+ routes. Can contain simple channel names or full Camel URIs.
items:
type: string
type: array
channelSources:
- description: |-
- List of channels used as source of integration routes.
- Can contain simple channel names or full Camel URIs.
+ description: List of channels used as source of integration
+ routes. Can contain simple channel names or full Camel URIs.
items:
type: string
type: array
@@ -3504,9 +3426,8 @@ spec:
in JSON format.
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3514,9 +3435,9 @@ spec:
traits share this common property.
type: boolean
endpointSinks:
- description: |-
- List of endpoints used as destination of integration routes.
- Can contain simple endpoint names or full Camel URIs.
+ description: List of endpoints used as destination of integration
+ routes. Can contain simple endpoint names or full Camel
+ URIs.
items:
type: string
type: array
@@ -3527,50 +3448,54 @@ spec:
type: string
type: array
eventSinks:
- description: |-
- List of event types that the integration will produce.
- Can contain simple event types or full Camel URIs (to use a specific broker).
+ description: List of event types that the integration will
+ produce. Can contain simple event types or full Camel URIs
+ (to use a specific broker).
items:
type: string
type: array
eventSources:
- description: |-
- List of event types that the integration will be subscribed to.
- Can contain simple event types or full Camel URIs (to use a specific broker different from "default").
+ description: List of event types that the integration will
+ be subscribed to. Can contain simple event types or full
+ Camel URIs (to use a specific broker different from "default").
items:
type: string
type: array
filterEventType:
- description: |-
- Enables the default filtering for the Knative trigger using the event type
- If this is true, the created Knative trigger uses the event type as a filter on the event stream when no other filter criteria is given. (default: true)
+ description: 'Enables the default filtering for the Knative
+ trigger using the event type If this is true, the created
+ Knative trigger uses the event type as a filter on the event
+ stream when no other filter criteria is given. (default:
+ true)'
type: boolean
filterSourceChannels:
- description: |-
- Enables filtering on events based on the header "ce-knativehistory". Since this header has been removed in newer versions of
- Knative, filtering is disabled by default.
+ description: Enables filtering on events based on the header
+ "ce-knativehistory". Since this header has been removed
+ in newer versions of Knative, filtering is disabled by default.
type: boolean
filters:
- description: |-
- Sets filter attributes on the event stream (such as event type, source, subject and so on).
- A list of key-value pairs that represent filter attributes and its values.
- The syntax is KEY=VALUE, e.g., `source="my.source"`.
- Filter attributes get set on the Knative trigger that is being created as part of this integration.
+ description: Sets filter attributes on the event stream (such
+ as event type, source, subject and so on). A list of key-value
+ pairs that represent filter attributes and its values. The
+ syntax is KEY=VALUE, e.g., `source="my.source"`. Filter
+ attributes get set on the Knative trigger that is being
+ created as part of this integration.
items:
type: string
type: array
namespaceLabel:
- description: |-
- Enables the camel-k-operator to set the "bindings.knative.dev/include=true" label to the namespace
- As Knative requires this label to perform injection of K_SINK URL into the service.
- If this is false, the integration pod may start and fail, read the SinkBinding Knative documentation. (default: true)
+ description: 'Enables the camel-k-operator to set the "bindings.knative.dev/include=true"
+ label to the namespace As Knative requires this label to
+ perform injection of K_SINK URL into the service. If this
+ is false, the integration pod may start and fail, read the
+ SinkBinding Knative documentation. (default: true)'
type: boolean
sinkBinding:
- description: |-
- Allows binding the integration to a sink via a Knative SinkBinding resource.
- This can be used when the integration targets a single sink.
- It's enabled by default when the integration targets a single sink
- (except when the integration is owned by a Knative source).
+ description: Allows binding the integration to a sink via
+ a Knative SinkBinding resource. This can be used when the
+ integration targets a single sink. It's enabled by default
+ when the integration targets a single sink (except when
+ the integration is owned by a Knative source).
type: boolean
type: object
knative-service:
@@ -3579,47 +3504,39 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to route.
- This can be used to set knative service specific annotations
- CLI usage example: -t "knative-service.annotations.'haproxy.router.openshift.io/balance'=true"
+ description: 'The annotations added to route. This can be
+ used to set knative service specific annotations CLI usage
+ example: -t "knative-service.annotations.''haproxy.router.openshift.io/balance''=true"'
type: object
auto:
- description: |-
- Automatically deploy the integration as Knative service when all conditions hold:
-
-
- * Integration is using the Knative profile
- * All routes are either starting from an HTTP based consumer or a passive consumer (e.g. `direct` is a passive consumer)
+ description: "Automatically deploy the integration as Knative
+ service when all conditions hold: \n * Integration is using
+ the Knative profile * All routes are either starting from
+ an HTTP based consumer or a passive consumer (e.g. `direct`
+ is a passive consumer)"
type: boolean
autoscalingMetric:
- description: |-
- Configures the Knative autoscaling metric property (e.g. to set `concurrency` based or `cpu` based autoscaling).
-
-
- Refer to the Knative documentation for more information.
+ description: "Configures the Knative autoscaling metric property
+ (e.g. to set `concurrency` based or `cpu` based autoscaling).
+ \n Refer to the Knative documentation for more information."
type: string
autoscalingTarget:
- description: |-
- Sets the allowed concurrency level or CPU percentage (depending on the autoscaling metric) for each Pod.
-
-
- Refer to the Knative documentation for more information.
+ description: "Sets the allowed concurrency level or CPU percentage
+ (depending on the autoscaling metric) for each Pod. \n Refer
+ to the Knative documentation for more information."
type: integer
class:
- description: |-
- Configures the Knative autoscaling class property (e.g. to set `hpa.autoscaling.knative.dev` or `kpa.autoscaling.knative.dev` autoscaling).
-
-
- Refer to the Knative documentation for more information.
+ description: "Configures the Knative autoscaling class property
+ (e.g. to set `hpa.autoscaling.knative.dev` or `kpa.autoscaling.knative.dev`
+ autoscaling). \n Refer to the Knative documentation for
+ more information."
enum:
- kpa.autoscaling.knative.dev
- hpa.autoscaling.knative.dev
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3627,43 +3544,36 @@ spec:
traits share this common property.
type: boolean
maxScale:
- description: |-
- An upper bound for the number of Pods that can be running in parallel for the integration.
- Knative has its own cap value that depends on the installation.
-
-
- Refer to the Knative documentation for more information.
+ description: "An upper bound for the number of Pods that can
+ be running in parallel for the integration. Knative has
+ its own cap value that depends on the installation. \n Refer
+ to the Knative documentation for more information."
type: integer
minScale:
- description: |-
- The minimum number of Pods that should be running at any time for the integration. It's **zero** by default, meaning that
- the integration is scaled down to zero when not used for a configured amount of time.
-
-
- Refer to the Knative documentation for more information.
+ description: "The minimum number of Pods that should be running
+ at any time for the integration. It's **zero** by default,
+ meaning that the integration is scaled down to zero when
+ not used for a configured amount of time. \n Refer to the
+ Knative documentation for more information."
type: integer
rolloutDuration:
- description: |-
- Enables to gradually shift traffic to the latest Revision and sets the rollout duration.
- It's disabled by default and must be expressed as a Golang `time.Duration` string representation,
- rounded to a second precision.
+ description: Enables to gradually shift traffic to the latest
+ Revision and sets the rollout duration. It's disabled by
+ default and must be expressed as a Golang `time.Duration`
+ string representation, rounded to a second precision.
type: string
timeoutSeconds:
- description: |-
- The maximum duration in seconds that the request instance is allowed to respond to a request.
- This field propagates to the integration pod's terminationGracePeriodSeconds
-
-
- Refer to the Knative documentation for more information.
+ description: "The maximum duration in seconds that the request
+ instance is allowed to respond to a request. This field
+ propagates to the integration pod's terminationGracePeriodSeconds
+ \n Refer to the Knative documentation for more information."
format: int64
type: integer
visibility:
- description: |-
- Setting `cluster-local`, Knative service becomes a private service.
- Specifically, this option applies the `networking.knative.dev/visibility` label to Knative service.
-
-
- Refer to the Knative documentation for more information.
+ description: "Setting `cluster-local`, Knative service becomes
+ a private service. Specifically, this option applies the
+ `networking.knative.dev/visibility` label to Knative service.
+ \n Refer to the Knative documentation for more information."
enum:
- cluster-local
type: string
@@ -3675,9 +3585,8 @@ spec:
description: Colorize the log output
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3717,18 +3626,20 @@ spec:
description: The configuration of Mount trait
properties:
configs:
- description: |-
- A list of configuration pointing to configmap/secret.
- The configuration are expected to be UTF-8 resources as they are processed by runtime Camel Context and tried to be parsed as property files.
- They are also made available on the classpath in order to ease their usage directly from the Route.
- Syntax: [configmap|secret]:name[/key], where name represents the resource name and key optionally represents the resource key to be filtered
+ description: 'A list of configuration pointing to configmap/secret.
+ The configuration are expected to be UTF-8 resources as
+ they are processed by runtime Camel Context and tried to
+ be parsed as property files. They are also made available
+ on the classpath in order to ease their usage directly from
+ the Route. Syntax: [configmap|secret]:name[/key], where
+ name represents the resource name and key optionally represents
+ the resource key to be filtered'
items:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
emptyDirs:
@@ -3741,17 +3652,21 @@ spec:
description: 'Deprecated: no longer in use.'
type: boolean
hotReload:
- description: |-
- Enable "hot reload" when a secret/configmap mounted is edited (default `false`). The configmap/secret must be
- marked with `camel.apache.org/integration` label to be taken in account. The resource will be watched for any kind change, also for
- changes in metadata.
+ description: Enable "hot reload" when a secret/configmap mounted
+ is edited (default `false`). The configmap/secret must be
+ marked with `camel.apache.org/integration` label to be taken
+ in account. The resource will be watched for any kind change,
+ also for changes in metadata.
type: boolean
resources:
- description: |-
- A list of resources (text or binary content) pointing to configmap/secret.
- The resources are expected to be any resource type (text or binary content).
- The destination path can be either a default location or any path specified by the user.
- Syntax: [configmap|secret]:name[/key][@path], where name represents the resource name, key optionally represents the resource key to be filtered and path represents the destination path
+ description: 'A list of resources (text or binary content)
+ pointing to configmap/secret. The resources are expected
+ to be any resource type (text or binary content). The destination
+ path can be either a default location or any path specified
+ by the user. Syntax: [configmap|secret]:name[/key][@path],
+ where name represents the resource name, key optionally
+ represents the resource key to be filtered and path represents
+ the destination path'
items:
type: string
type: array
@@ -3776,9 +3691,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3789,9 +3703,8 @@ spec:
description: The configuration of Owner trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3813,9 +3726,8 @@ spec:
description: The configuration of PDB trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3823,53 +3735,56 @@ spec:
traits share this common property.
type: boolean
maxUnavailable:
- description: |-
- The number of pods for the Integration that can be unavailable after an eviction.
- It can be either an absolute number or a percentage (default `1` if `min-available` is also not set).
- Only one of `max-unavailable` and `min-available` can be specified.
+ description: The number of pods for the Integration that can
+ be unavailable after an eviction. It can be either an absolute
+ number or a percentage (default `1` if `min-available` is
+ also not set). Only one of `max-unavailable` and `min-available`
+ can be specified.
type: string
minAvailable:
- description: |-
- The number of pods for the Integration that must still be available after an eviction.
- It can be either an absolute number or a percentage.
- Only one of `min-available` and `max-unavailable` can be specified.
+ description: The number of pods for the Integration that must
+ still be available after an eviction. It can be either an
+ absolute number or a percentage. Only one of `min-available`
+ and `max-unavailable` can be specified.
type: string
type: object
platform:
description: The configuration of Platform trait
properties:
auto:
- description: |-
- To automatically detect from the environment if a default platform can be created (it will be created on OpenShift or when a registry address is set).
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'To automatically detect from the environment
+ if a default platform can be created (it will be created
+ on OpenShift or when a registry address is set). Deprecated:
+ Platform is auto generated by the operator install procedure
+ - maintained for backward compatibility'
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
createDefault:
- description: |-
- To create a default (empty) platform when the platform is missing.
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'To create a default (empty) platform when the
+ platform is missing. Deprecated: Platform is auto generated
+ by the operator install procedure - maintained for backward
+ compatibility'
type: boolean
enabled:
description: 'Deprecated: no longer in use.'
type: boolean
global:
- description: |-
- Indicates if the platform should be created globally in the case of global operator (default true).
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'Indicates if the platform should be created
+ globally in the case of global operator (default true).
+ Deprecated: Platform is auto generated by the operator install
+ procedure - maintained for backward compatibility'
type: boolean
type: object
pod:
description: The configuration of Pod trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3881,9 +3796,8 @@ spec:
description: The configuration of Prometheus trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3909,9 +3823,8 @@ spec:
secret on the pod if it is of type `kubernetes.io/dockerconfigjson`.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3934,10 +3847,10 @@ spec:
description: The configuration of Quarkus trait
properties:
buildMode:
- description: |-
- The Quarkus mode to run: either `jvm` or `native` (default `jvm`).
- In case both `jvm` and `native` are specified, two `IntegrationKit` resources are created,
- with the `native` kit having precedence over the `jvm` one once ready.
+ description: 'The Quarkus mode to run: either `jvm` or `native`
+ (default `jvm`). In case both `jvm` and `native` are specified,
+ two `IntegrationKit` resources are created, with the `native`
+ kit having precedence over the `jvm` one once ready.'
items:
description: QuarkusMode is the type of Quarkus build packaging.
enum:
@@ -3946,9 +3859,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3964,18 +3876,18 @@ spec:
in the runtime catalog)
type: string
packageTypes:
- description: |-
- The Quarkus package types, `fast-jar` or `native` (default `fast-jar`).
- In case both `fast-jar` and `native` are specified, two `IntegrationKit` resources are created,
- with the native kit having precedence over the `fast-jar` one once ready.
- The order influences the resolution of the current kit for the integration.
- The kit corresponding to the first package type will be assigned to the
- integration in case no existing kit that matches the integration exists.
- Deprecated: use `build-mode` instead.
+ description: 'The Quarkus package types, `fast-jar` or `native`
+ (default `fast-jar`). In case both `fast-jar` and `native`
+ are specified, two `IntegrationKit` resources are created,
+ with the native kit having precedence over the `fast-jar`
+ one once ready. The order influences the resolution of the
+ current kit for the integration. The kit corresponding to
+ the first package type will be assigned to the integration
+ in case no existing kit that matches the integration exists.
+ Deprecated: use `build-mode` instead.'
items:
- description: |-
- QuarkusPackageType is the type of Quarkus build packaging.
- Deprecated: use `QuarkusMode` instead.
+ description: 'QuarkusPackageType is the type of Quarkus
+ build packaging. Deprecated: use `QuarkusMode` instead.'
enum:
- fast-jar
- native
@@ -3983,14 +3895,12 @@ spec:
type: array
type: object
registry:
- description: |-
- The configuration of Registry trait (support removed since version 2.5.0).
- Deprecated: use jvm trait or read documentation.
+ description: 'The configuration of Registry trait (support removed
+ since version 2.5.0). Deprecated: use jvm trait or read documentation.'
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -4004,16 +3914,14 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to route.
- This can be used to set route specific annotations
- For annotations options see https://docs.openshift.com/container-platform/3.11/architecture/networking/routes.html#route-specific-annotations
- CLI usage example: -t "route.annotations.'haproxy.router.openshift.io/balance'=true"
+ description: 'The annotations added to route. This can be
+ used to set route specific annotations For annotations options
+ see https://docs.openshift.com/container-platform/3.11/architecture/networking/routes.html#route-specific-annotations
+ CLI usage example: -t "route.annotations.''haproxy.router.openshift.io/balance''=true"'
type: object
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -4024,82 +3932,74 @@ spec:
description: To configure the host exposed by the route.
type: string
tlsCACertificate:
- description: |-
- The TLS CA certificate contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS CA certificate contents. \n Refer to
+ the OpenShift route documentation for additional information."
type: string
tlsCACertificateSecret:
- description: |-
- The secret name and key reference to the TLS CA certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the TLS
+ CA certificate. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only one
+ key in the secret it will be read, otherwise you can set
+ a key name separated with a \"/\". \n Refer to the OpenShift
+ route documentation for additional information."
type: string
tlsCertificate:
- description: |-
- The TLS certificate contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS certificate contents. \n Refer to the
+ OpenShift route documentation for additional information."
type: string
tlsCertificateSecret:
- description: |-
- The secret name and key reference to the TLS certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the TLS
+ certificate. The format is \"secret-name[/key-name]\", the
+ value represents the secret name, if there is only one key
+ in the secret it will be read, otherwise you can set a key
+ name separated with a \"/\". \n Refer to the OpenShift route
+ documentation for additional information."
type: string
tlsDestinationCACertificate:
- description: |-
- The destination CA certificate provides the contents of the ca certificate of the final destination. When using reencrypt
- termination this file should be provided in order to have routers use it for health checks on the secure connection.
- If this field is not specified, the router may provide its own destination CA and perform hostname validation using
- the short service name (service.namespace.svc), which allows infrastructure generated certificates to automatically
- verify.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The destination CA certificate provides the
+ contents of the ca certificate of the final destination.
+ \ When using reencrypt termination this file should be provided
+ in order to have routers use it for health checks on the
+ secure connection. If this field is not specified, the router
+ may provide its own destination CA and perform hostname
+ validation using the short service name (service.namespace.svc),
+ which allows infrastructure generated certificates to automatically
+ verify. \n Refer to the OpenShift route documentation for
+ additional information."
type: string
tlsDestinationCACertificateSecret:
- description: |-
- The secret name and key reference to the destination CA certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the destination
+ CA certificate. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only one
+ key in the secret it will be read, otherwise you can set
+ a key name separated with a \"/\". \n Refer to the OpenShift
+ route documentation for additional information."
type: string
tlsInsecureEdgeTerminationPolicy:
- description: |-
- To configure how to deal with insecure traffic, e.g. `Allow`, `Disable` or `Redirect` traffic.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "To configure how to deal with insecure traffic,
+ e.g. `Allow`, `Disable` or `Redirect` traffic. \n Refer
+ to the OpenShift route documentation for additional information."
enum:
- None
- Allow
- Redirect
type: string
tlsKey:
- description: |-
- The TLS certificate key contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS certificate key contents. \n Refer to
+ the OpenShift route documentation for additional information."
type: string
tlsKeySecret:
- description: |-
- The secret name and key reference to the TLS certificate key. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the TLS
+ certificate key. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only one
+ key in the secret it will be read, otherwise you can set
+ a key name separated with a \"/\". \n Refer to the OpenShift
+ route documentation for additional information."
type: string
tlsTermination:
- description: |-
- The TLS termination type, like `edge`, `passthrough` or `reencrypt`.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS termination type, like `edge`, `passthrough`
+ or `reencrypt`. \n Refer to the OpenShift route documentation
+ for additional information."
enum:
- edge
- reencrypt
@@ -4110,9 +4010,8 @@ spec:
description: The configuration of Security Context trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -4144,9 +4043,8 @@ spec:
needs to be created.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -4154,9 +4052,8 @@ spec:
traits share this common property.
type: boolean
nodePort:
- description: |-
- Enable Service to be exposed as NodePort (default `false`).
- Deprecated: Use service type instead.
+ description: 'Enable Service to be exposed as NodePort (default
+ `false`). Deprecated: Use service type instead.'
type: boolean
type:
description: The type of service to be used, either 'ClusterIP',
@@ -4171,9 +4068,8 @@ spec:
description: The configuration of Service Binding trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -4200,9 +4096,8 @@ spec:
description: The configuration of Toleration trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -4235,3 +4130,9 @@ spec:
storage: true
subresources:
status: {}
+status:
+ acceptedNames:
+ kind: ""
+ plural: ""
+ conditions: []
+ storedVersions: []
diff --git a/pkg/resources/config/crd/bases/camel.apache.org_integrationprofiles.yaml b/pkg/resources/config/crd/bases/camel.apache.org_integrationprofiles.yaml
index f09ad63fcd..9e1512a90f 100644
--- a/pkg/resources/config/crd/bases/camel.apache.org_integrationprofiles.yaml
+++ b/pkg/resources/config/crd/bases/camel.apache.org_integrationprofiles.yaml
@@ -15,12 +15,14 @@
# limitations under the License.
# ---------------------------------------------------------------------------
+
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
- controller-gen.kubebuilder.io/version: v0.15.0
+ controller-gen.kubebuilder.io/version: v0.6.1
+ creationTimestamp: null
name: integrationprofiles.camel.apache.org
spec:
group: camel.apache.org
@@ -48,24 +50,20 @@ spec:
name: v1
schema:
openAPIV3Schema:
- description: |-
- IntegrationProfile is the resource used to apply user defined settings to the Camel K operator behavior.
- It defines the behavior of all Custom Resources (`IntegrationKit`, `Integration`, `Kamelet`) in the given namespace.
+ description: IntegrationProfile is the resource used to apply user defined
+ settings to the Camel K operator behavior. It defines the behavior of all
+ Custom Resources (`IntegrationKit`, `Integration`, `Kamelet`) in the given
+ namespace.
properties:
apiVersion:
- description: |-
- APIVersion defines the versioned schema of this representation of an object.
- Servers should convert recognized schemas to the latest internal value, and
- may reject unrecognized values.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+ description: 'APIVersion defines the versioned schema of this representation
+ of an object. Servers should convert recognized schemas to the latest
+ internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: |-
- Kind is a string value representing the REST resource this object represents.
- Servers may infer this from the endpoint the client submits requests to.
- Cannot be updated.
- In CamelCase.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ description: 'Kind is a string value representing the REST resource this
+ object represents. Servers may infer this from the endpoint the client
+ submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
@@ -77,22 +75,22 @@ spec:
description: specify how to build the Integration/IntegrationKits
properties:
baseImage:
- description: |-
- a base image that can be used as base layer for all images.
- It can be useful if you want to provide some custom base image with further utility software
+ description: a base image that can be used as base layer for all
+ images. It can be useful if you want to provide some custom
+ base image with further utility software
type: string
maven:
description: Maven configuration used to build the Camel/Camel-Quarkus
applications
properties:
caSecrets:
- description: |-
- The Secrets name and key, containing the CA certificate(s) used to connect
- to remote Maven repositories.
- It can contain X.509 certificates, and PKCS#7 formatted certificate chains.
- A JKS formatted keystore is automatically created to store the CA certificate(s),
- and configured to be used as a trusted certificate(s) by the Maven commands.
- Note that the root CA certificates are also imported into the created keystore.
+ description: The Secrets name and key, containing the CA certificate(s)
+ used to connect to remote Maven repositories. It can contain
+ X.509 certificates, and PKCS#7 formatted certificate chains.
+ A JKS formatted keystore is automatically created to store
+ the CA certificate(s), and configured to be used as a trusted
+ certificate(s) by the Maven commands. Note that the root
+ CA certificates are also imported into the created keystore.
items:
description: SecretKeySelector selects a key of a Secret.
properties:
@@ -101,10 +99,8 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
description: Specify whether the Secret or its key must
@@ -113,20 +109,16 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: array
cliOptions:
- description: |-
- The CLI options that are appended to the list of arguments for Maven commands,
- e.g., `-V,--no-transfer-progress,-Dstyle.color=never`.
+ description: The CLI options that are appended to the list
+ of arguments for Maven commands, e.g., `-V,--no-transfer-progress,-Dstyle.color=never`.
See https://maven.apache.org/ref/3.8.4/maven-embedder/cli.html.
items:
type: string
type: array
extension:
- description: |-
- The Maven build extensions.
- See https://maven.apache.org/guides/mini/guide-using-extensions.html.
+ description: The Maven build extensions. See https://maven.apache.org/guides/mini/guide-using-extensions.html.
items:
description: MavenArtifact defines a GAV (Group:Artifact:Type:Version:Classifier)
Maven artifact.
@@ -155,9 +147,8 @@ spec:
description: The path of the local Maven repository.
type: string
profiles:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the Maven profile.
+ description: A reference to the ConfigMap or Secret key that
+ contains the Maven profile.
items:
description: ValueSource --.
properties:
@@ -168,10 +159,9 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the ConfigMap or its
@@ -180,7 +170,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -189,10 +178,9 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the Secret or its key
@@ -201,7 +189,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
properties:
@@ -210,9 +197,8 @@ spec:
description: The Maven properties.
type: object
settings:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the Maven settings.
+ description: A reference to the ConfigMap or Secret key that
+ contains the Maven settings.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -221,10 +207,9 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the ConfigMap or its
@@ -233,7 +218,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -242,10 +226,9 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the Secret or its key
@@ -254,12 +237,10 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
settingsSecurity:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the security of the Maven settings.
+ description: A reference to the ConfigMap or Secret key that
+ contains the security of the Maven settings.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -268,10 +249,9 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the ConfigMap or its
@@ -280,7 +260,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -289,10 +268,9 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the Secret or its key
@@ -301,7 +279,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: object
registry:
@@ -380,9 +357,8 @@ spec:
description: The configuration of Affinity trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -401,9 +377,9 @@ spec:
in the same node (default `false`).
type: boolean
podAffinityLabels:
- description: |-
- Defines a set of pods (namely those matching the label selector, relative to the given namespace) that the
- integration pod(s) should be co-located with.
+ description: Defines a set of pods (namely those matching
+ the label selector, relative to the given namespace) that
+ the integration pod(s) should be co-located with.
items:
type: string
type: array
@@ -412,9 +388,9 @@ spec:
in the same node (default `false`).
type: boolean
podAntiAffinityLabels:
- description: |-
- Defines a set of pods (namely those matching the label selector, relative to the given namespace) that the
- integration pod(s) should not be co-located with.
+ description: Defines a set of pods (namely those matching
+ the label selector, relative to the given namespace) that
+ the integration pod(s) should not be co-located with.
items:
type: string
type: array
@@ -429,14 +405,13 @@ spec:
for the builder pod.
type: object
baseImage:
- description: |-
- Specify a base image. In order to have the application working properly it must be a container image which has a Java JDK
- installed and ready to use on path (ie `/usr/bin/java`).
+ description: Specify a base image. In order to have the application
+ working properly it must be a container image which has
+ a Java JDK installed and ready to use on path (ie `/usr/bin/java`).
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -447,21 +422,27 @@ spec:
existing containers (default `true`)
type: boolean
limitCPU:
- description: |-
- When using `pod` strategy, the maximum amount of CPU required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the maximum amount
+ of CPU required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
limitMemory:
- description: |-
- When using `pod` strategy, the maximum amount of memory required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the maximum amount
+ of memory required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
mavenProfiles:
- description: |-
- A list of references pointing to configmaps/secrets that contains a maven profile.
- This configmap/secret is a resource of the IntegrationKit created, therefore it needs to be present in the namespace where the operator is going to create the IntegrationKit.
- The content of the maven profile is expected to be a text containing a valid maven profile starting with `` and ending with `` that will be integrated as an inline profile in the POM.
- Syntax: [configmap|secret]:name[/key], where name represents the resource name, key optionally represents the resource key to be filtered (default key value = profile.xml).
+ description: 'A list of references pointing to configmaps/secrets
+ that contains a maven profile. This configmap/secret is
+ a resource of the IntegrationKit created, therefore it needs
+ to be present in the namespace where the operator is going
+ to create the IntegrationKit. The content of the maven profile
+ is expected to be a text containing a valid maven profile
+ starting with `` and ending with `` that
+ will be integrated as an inline profile in the POM. Syntax:
+ [configmap|secret]:name[/key], where name represents the
+ resource name, key optionally represents the resource key
+ to be filtered (default key value = profile.xml).'
items:
type: string
type: array
@@ -492,14 +473,14 @@ spec:
type: string
type: array
requestCPU:
- description: |-
- When using `pod` strategy, the minimum amount of CPU required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the minimum amount
+ of CPU required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
requestMemory:
- description: |-
- When using `pod` strategy, the minimum amount of memory required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the minimum amount
+ of memory required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
strategy:
description: The strategy to use, either `pod` or `routine`
@@ -515,10 +496,11 @@ spec:
type: string
type: array
tasksFilter:
- description: |-
- A list of tasks sorted by the order of execution in a csv format, ie, `,,...`.
- Mind that you must include also the operator tasks (`builder`, `quarkus-native`, `package`, `jib`, `s2i`)
- if you need to execute them. Useful only with `pod` strategy.
+ description: A list of tasks sorted by the order of execution
+ in a csv format, ie, `,,...`. Mind
+ that you must include also the operator tasks (`builder`,
+ `quarkus-native`, `package`, `jib`, `s2i`) if you need to
+ execute them. Useful only with `pod` strategy.
type: string
tasksLimitCPU:
description: A list of limit cpu configuration for the specific
@@ -545,18 +527,17 @@ spec:
type: string
type: array
verbose:
- description: |-
- Enable verbose logging on build components that support it (e.g. Kaniko build pod).
- Deprecated no longer in use
+ description: Enable verbose logging on build components that
+ support it (e.g. Kaniko build pod). Deprecated no longer
+ in use
type: boolean
type: object
camel:
description: The configuration of Camel trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -569,10 +550,12 @@ spec:
type: string
type: array
runtimeVersion:
- description: |-
- The camel-k-runtime version to use for the integration. It overrides the default version set in the Integration Platform.
- You can use a fixed version (for example "3.2.3") or a semantic version (for example "3.x") which will try to resolve
- to the best matching Catalog existing on the cluster.
+ description: The camel-k-runtime version to use for the integration.
+ It overrides the default version set in the Integration
+ Platform. You can use a fixed version (for example "3.2.3")
+ or a semantic version (for example "3.x") which will try
+ to resolve to the best matching Catalog existing on the
+ cluster.
type: string
type: object
container:
@@ -600,9 +583,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -613,10 +595,13 @@ spec:
Service.
type: boolean
image:
- description: |-
- The main container image to use for the Integration. When using this parameter the operator will create a synthetic IntegrationKit which
- won't be able to execute traits requiring CamelCatalog. If the container image you're using is coming from an IntegrationKit, use instead
- Integration `.spec.integrationKit` parameter. If you're moving the Integration across environments, you will also need to create an "external" IntegrationKit.
+ description: The main container image to use for the Integration.
+ When using this parameter the operator will create a synthetic
+ IntegrationKit which won't be able to execute traits requiring
+ CamelCatalog. If the container image you're using is coming
+ from an IntegrationKit, use instead Integration `.spec.integrationKit`
+ parameter. If you're moving the Integration across environments,
+ you will also need to create an "external" IntegrationKit.
type: string
imagePullPolicy:
description: 'The pull policy: Always|Never|IfNotPresent'
@@ -684,52 +669,50 @@ spec:
description: The configuration of Cron trait
properties:
activeDeadlineSeconds:
- description: |-
- Specifies the duration in seconds, relative to the start time, that the job
- may be continuously active before it is considered to be failed.
- It defaults to 60s.
+ description: Specifies the duration in seconds, relative to
+ the start time, that the job may be continuously active
+ before it is considered to be failed. It defaults to 60s.
format: int64
type: integer
auto:
- description: |-
- Automatically deploy the integration as CronJob when all routes are
- either starting from a periodic consumer (only `cron`, `timer` and `quartz` are supported) or a passive consumer (e.g. `direct` is a passive consumer).
-
-
- It's required that all periodic consumers have the same period, and it can be expressed as cron schedule (e.g. `1m` can be expressed as `0/1 * * * *`,
- while `35m` or `50s` cannot).
+ description: "Automatically deploy the integration as CronJob
+ when all routes are either starting from a periodic consumer
+ (only `cron`, `timer` and `quartz` are supported) or a passive
+ consumer (e.g. `direct` is a passive consumer). \n It's
+ required that all periodic consumers have the same period,
+ and it can be expressed as cron schedule (e.g. `1m` can
+ be expressed as `0/1 * * * *`, while `35m` or `50s` cannot)."
type: boolean
backoffLimit:
- description: |-
- Specifies the number of retries before marking the job failed.
- It defaults to 2.
+ description: Specifies the number of retries before marking
+ the job failed. It defaults to 2.
format: int32
type: integer
components:
- description: |-
- A comma separated list of the Camel components that need to be customized in order for them to work when the schedule is triggered externally by Kubernetes.
- A specific customizer is activated for each specified component. E.g. for the `timer` component, the `cron-timer` customizer is
- activated (it's present in the `org.apache.camel.k:camel-k-cron` library).
-
-
- Supported components are currently: `cron`, `timer` and `quartz`.
+ description: "A comma separated list of the Camel components
+ that need to be customized in order for them to work when
+ the schedule is triggered externally by Kubernetes. A specific
+ customizer is activated for each specified component. E.g.
+ for the `timer` component, the `cron-timer` customizer is
+ activated (it's present in the `org.apache.camel.k:camel-k-cron`
+ library). \n Supported components are currently: `cron`,
+ `timer` and `quartz`."
type: string
concurrencyPolicy:
- description: |-
- Specifies how to treat concurrent executions of a Job.
- Valid values are:
- - "Allow": allows CronJobs to run concurrently;
- - "Forbid" (default): forbids concurrent runs, skipping next run if previous run hasn't finished yet;
- - "Replace": cancels currently running job and replaces it with a new one
+ description: 'Specifies how to treat concurrent executions
+ of a Job. Valid values are: - "Allow": allows CronJobs to
+ run concurrently; - "Forbid" (default): forbids concurrent
+ runs, skipping next run if previous run hasn''t finished
+ yet; - "Replace": cancels currently running job and replaces
+ it with a new one'
enum:
- Allow
- Forbid
- Replace
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -737,19 +720,19 @@ spec:
traits share this common property.
type: boolean
fallback:
- description: |-
- Use the default Camel implementation of the `cron` endpoint (`quartz`) instead of trying to materialize the integration
- as Kubernetes CronJob.
+ description: Use the default Camel implementation of the `cron`
+ endpoint (`quartz`) instead of trying to materialize the
+ integration as Kubernetes CronJob.
type: boolean
schedule:
- description: |-
- The CronJob schedule for the whole integration. If multiple routes are declared, they must have the same schedule for this
- mechanism to work correctly.
+ description: The CronJob schedule for the whole integration.
+ If multiple routes are declared, they must have the same
+ schedule for this mechanism to work correctly.
type: string
startingDeadlineSeconds:
- description: |-
- Optional deadline in seconds for starting the job if it misses scheduled
- time for any reason. Missed jobs executions will be counted as failed ones.
+ description: Optional deadline in seconds for starting the
+ job if it misses scheduled time for any reason. Missed
+ jobs executions will be counted as failed ones.
format: int64
type: integer
timeZone:
@@ -760,9 +743,8 @@ spec:
description: The configuration of Dependencies trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -773,9 +755,8 @@ spec:
description: The configuration of Deployer trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -791,51 +772,49 @@ spec:
- knative-service
type: string
useSSA:
- description: |-
- Use server-side apply to update the owned resources (default `true`).
- Note that it automatically falls back to client-side patching, if SSA is not available, e.g., on old Kubernetes clusters.
+ description: Use server-side apply to update the owned resources
+ (default `true`). Note that it automatically falls back
+ to client-side patching, if SSA is not available, e.g.,
+ on old Kubernetes clusters.
type: boolean
type: object
deployment:
description: The configuration of Deployment trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
description: 'Deprecated: no longer in use.'
type: boolean
progressDeadlineSeconds:
- description: |-
- The maximum time in seconds for the deployment to make progress before it
- is considered to be failed. It defaults to `60s`.
+ description: The maximum time in seconds for the deployment
+ to make progress before it is considered to be failed. It
+ defaults to `60s`.
format: int32
type: integer
rollingUpdateMaxSurge:
anyOf:
- type: integer
- type: string
- description: |-
- The maximum number of pods that can be scheduled above the desired number of
- pods.
- Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
- This can not be 0 if MaxUnavailable is 0.
- Absolute number is calculated from percentage by rounding up.
- Defaults to `25%`.
+ description: 'The maximum number of pods that can be scheduled
+ above the desired number of pods. Value can be an absolute
+ number (ex: 5) or a percentage of desired pods (ex: 10%).
+ This can not be 0 if MaxUnavailable is 0. Absolute number
+ is calculated from percentage by rounding up. Defaults to
+ `25%`.'
x-kubernetes-int-or-string: true
rollingUpdateMaxUnavailable:
anyOf:
- type: integer
- type: string
- description: |-
- The maximum number of pods that can be unavailable during the update.
- Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
- Absolute number is calculated from percentage by rounding down.
- This can not be 0 if MaxSurge is 0.
- Defaults to `25%`.
+ description: 'The maximum number of pods that can be unavailable
+ during the update. Value can be an absolute number (ex:
+ 5) or a percentage of desired pods (ex: 10%). Absolute number
+ is calculated from percentage by rounding down. This can
+ not be 0 if MaxSurge is 0. Defaults to `25%`.'
x-kubernetes-int-or-string: true
strategy:
description: The deployment strategy to use to replace existing
@@ -849,9 +828,8 @@ spec:
description: The configuration of Environment trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
containerMeta:
@@ -866,11 +844,12 @@ spec:
`NO_PROXY` environment variables (default `true`)
type: boolean
vars:
- description: |-
- A list of environment variables to be added to the integration container.
- The syntax is either VAR=VALUE or VAR=[configmap|secret]:name/key, where name represents the resource name,
- and key represents the resource key to be mapped as and environment variable.
- These take precedence over any previously defined environment variables.
+ description: A list of environment variables to be added to
+ the integration container. The syntax is either VAR=VALUE
+ or VAR=[configmap|secret]:name/key, where name represents
+ the resource name, and key represents the resource key to
+ be mapped as and environment variable. These take precedence
+ over any previously defined environment variables.
items:
type: string
type: array
@@ -879,9 +858,8 @@ spec:
description: The configuration of Error Handler trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -896,15 +874,14 @@ spec:
description: The configuration of GC trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
discoveryCache:
- description: |-
- Discovery client cache to be used, either `disabled`, `disk` or `memory` (default `memory`).
- Deprecated: to be removed from trait configuration.
+ description: 'Discovery client cache to be used, either `disabled`,
+ `disk` or `memory` (default `memory`). Deprecated: to be
+ removed from trait configuration.'
enum:
- disabled
- disk
@@ -919,9 +896,8 @@ spec:
description: The configuration of Health trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1043,19 +1019,17 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to the ingress.
- This can be used to set controller specific annotations, e.g., when using the NGINX Ingress controller:
- See https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md
+ description: 'The annotations added to the ingress. This can
+ be used to set controller specific annotations, e.g., when
+ using the NGINX Ingress controller: See https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md'
type: object
auto:
description: To automatically add an ingress whenever the
integration uses an HTTP endpoint consumer.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1065,14 +1039,18 @@ spec:
host:
description: To configure the host exposed by the ingress.
type: string
+ ingressClassName:
+ description: The Ingress class name as defined by the Ingress
+ spec See https://kubernetes.io/docs/concepts/services-networking/ingress/
+ type: string
path:
description: To configure the path exposed by the ingress
(default `/`).
type: string
pathType:
- description: |-
- To configure the path type exposed by the ingress.
- One of `Exact`, `Prefix`, `ImplementationSpecific` (default to `Prefix`).
+ description: To configure the path type exposed by the ingress.
+ One of `Exact`, `Prefix`, `ImplementationSpecific` (default
+ to `Prefix`).
enum:
- Exact
- Prefix
@@ -1096,9 +1074,8 @@ spec:
by default).
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1115,23 +1092,25 @@ spec:
description: The configuration of Jolokia trait
properties:
CACert:
- description: |-
- The PEM encoded CA certification file path, used to verify client certificates,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt` for OpenShift).
+ description: The PEM encoded CA certification file path, used
+ to verify client certificates, applicable when `protocol`
+ is `https` and `use-ssl-client-authentication` is `true`
+ (default `/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt`
+ for OpenShift).
type: string
clientPrincipal:
- description: |-
- The principal(s) which must be given in a client certificate to allow access to the Jolokia endpoint,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `clientPrincipal=cn=system:master-proxy`, `cn=hawtio-online.hawtio.svc` and `cn=fuse-console.fuse.svc` for OpenShift).
+ description: The principal(s) which must be given in a client
+ certificate to allow access to the Jolokia endpoint, applicable
+ when `protocol` is `https` and `use-ssl-client-authentication`
+ is `true` (default `clientPrincipal=cn=system:master-proxy`,
+ `cn=hawtio-online.hawtio.svc` and `cn=fuse-console.fuse.svc`
+ for OpenShift).
items:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
discoveryEnabled:
@@ -1142,20 +1121,20 @@ spec:
traits share this common property.
type: boolean
extendedClientCheck:
- description: |-
- Mandate the client certificate contains a client flag in the extended key usage section,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `true` for OpenShift).
+ description: Mandate the client certificate contains a client
+ flag in the extended key usage section, applicable when
+ `protocol` is `https` and `use-ssl-client-authentication`
+ is `true` (default `true` for OpenShift).
type: boolean
host:
- description: |-
- The Host address to which the Jolokia agent should bind to. If `"\*"` or `"0.0.0.0"` is given,
- the servers binds to every network interface (default `"*"`).
+ description: The Host address to which the Jolokia agent should
+ bind to. If `"\*"` or `"0.0.0.0"` is given, the servers
+ binds to every network interface (default `"*"`).
type: string
options:
- description: |-
- A list of additional Jolokia options as defined
- in https://jolokia.org/reference/html/agents.html#agent-jvm-config[JVM agent configuration options]
+ description: A list of additional Jolokia options as defined
+ in https://jolokia.org/reference/html/agents.html#agent-jvm-config[JVM
+ agent configuration options]
items:
type: string
type: array
@@ -1186,9 +1165,8 @@ spec:
separator)
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
debug:
@@ -1217,9 +1195,9 @@ spec:
type: string
type: array
printCommand:
- description: |-
- Prints the command used the start the JVM in the container logs (default `true`)
- Deprecated: no longer in use.
+ description: 'Prints the command used the start the JVM in
+ the container logs (default `true`) Deprecated: no longer
+ in use.'
type: boolean
type: object
kamelets:
@@ -1230,9 +1208,8 @@ spec:
and their default configuration (enabled by default)
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1265,16 +1242,14 @@ spec:
description: Enable automatic discovery of all trait properties.
type: boolean
channelSinks:
- description: |-
- List of channels used as destination of integration routes.
- Can contain simple channel names or full Camel URIs.
+ description: List of channels used as destination of integration
+ routes. Can contain simple channel names or full Camel URIs.
items:
type: string
type: array
channelSources:
- description: |-
- List of channels used as source of integration routes.
- Can contain simple channel names or full Camel URIs.
+ description: List of channels used as source of integration
+ routes. Can contain simple channel names or full Camel URIs.
items:
type: string
type: array
@@ -1283,9 +1258,8 @@ spec:
in JSON format.
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1293,9 +1267,9 @@ spec:
traits share this common property.
type: boolean
endpointSinks:
- description: |-
- List of endpoints used as destination of integration routes.
- Can contain simple endpoint names or full Camel URIs.
+ description: List of endpoints used as destination of integration
+ routes. Can contain simple endpoint names or full Camel
+ URIs.
items:
type: string
type: array
@@ -1306,50 +1280,54 @@ spec:
type: string
type: array
eventSinks:
- description: |-
- List of event types that the integration will produce.
- Can contain simple event types or full Camel URIs (to use a specific broker).
+ description: List of event types that the integration will
+ produce. Can contain simple event types or full Camel URIs
+ (to use a specific broker).
items:
type: string
type: array
eventSources:
- description: |-
- List of event types that the integration will be subscribed to.
- Can contain simple event types or full Camel URIs (to use a specific broker different from "default").
+ description: List of event types that the integration will
+ be subscribed to. Can contain simple event types or full
+ Camel URIs (to use a specific broker different from "default").
items:
type: string
type: array
filterEventType:
- description: |-
- Enables the default filtering for the Knative trigger using the event type
- If this is true, the created Knative trigger uses the event type as a filter on the event stream when no other filter criteria is given. (default: true)
+ description: 'Enables the default filtering for the Knative
+ trigger using the event type If this is true, the created
+ Knative trigger uses the event type as a filter on the event
+ stream when no other filter criteria is given. (default:
+ true)'
type: boolean
filterSourceChannels:
- description: |-
- Enables filtering on events based on the header "ce-knativehistory". Since this header has been removed in newer versions of
- Knative, filtering is disabled by default.
+ description: Enables filtering on events based on the header
+ "ce-knativehistory". Since this header has been removed
+ in newer versions of Knative, filtering is disabled by default.
type: boolean
filters:
- description: |-
- Sets filter attributes on the event stream (such as event type, source, subject and so on).
- A list of key-value pairs that represent filter attributes and its values.
- The syntax is KEY=VALUE, e.g., `source="my.source"`.
- Filter attributes get set on the Knative trigger that is being created as part of this integration.
+ description: Sets filter attributes on the event stream (such
+ as event type, source, subject and so on). A list of key-value
+ pairs that represent filter attributes and its values. The
+ syntax is KEY=VALUE, e.g., `source="my.source"`. Filter
+ attributes get set on the Knative trigger that is being
+ created as part of this integration.
items:
type: string
type: array
namespaceLabel:
- description: |-
- Enables the camel-k-operator to set the "bindings.knative.dev/include=true" label to the namespace
- As Knative requires this label to perform injection of K_SINK URL into the service.
- If this is false, the integration pod may start and fail, read the SinkBinding Knative documentation. (default: true)
+ description: 'Enables the camel-k-operator to set the "bindings.knative.dev/include=true"
+ label to the namespace As Knative requires this label to
+ perform injection of K_SINK URL into the service. If this
+ is false, the integration pod may start and fail, read the
+ SinkBinding Knative documentation. (default: true)'
type: boolean
sinkBinding:
- description: |-
- Allows binding the integration to a sink via a Knative SinkBinding resource.
- This can be used when the integration targets a single sink.
- It's enabled by default when the integration targets a single sink
- (except when the integration is owned by a Knative source).
+ description: Allows binding the integration to a sink via
+ a Knative SinkBinding resource. This can be used when the
+ integration targets a single sink. It's enabled by default
+ when the integration targets a single sink (except when
+ the integration is owned by a Knative source).
type: boolean
type: object
knative-service:
@@ -1358,47 +1336,39 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to route.
- This can be used to set knative service specific annotations
- CLI usage example: -t "knative-service.annotations.'haproxy.router.openshift.io/balance'=true"
+ description: 'The annotations added to route. This can be
+ used to set knative service specific annotations CLI usage
+ example: -t "knative-service.annotations.''haproxy.router.openshift.io/balance''=true"'
type: object
auto:
- description: |-
- Automatically deploy the integration as Knative service when all conditions hold:
-
-
- * Integration is using the Knative profile
- * All routes are either starting from an HTTP based consumer or a passive consumer (e.g. `direct` is a passive consumer)
+ description: "Automatically deploy the integration as Knative
+ service when all conditions hold: \n * Integration is using
+ the Knative profile * All routes are either starting from
+ an HTTP based consumer or a passive consumer (e.g. `direct`
+ is a passive consumer)"
type: boolean
autoscalingMetric:
- description: |-
- Configures the Knative autoscaling metric property (e.g. to set `concurrency` based or `cpu` based autoscaling).
-
-
- Refer to the Knative documentation for more information.
+ description: "Configures the Knative autoscaling metric property
+ (e.g. to set `concurrency` based or `cpu` based autoscaling).
+ \n Refer to the Knative documentation for more information."
type: string
autoscalingTarget:
- description: |-
- Sets the allowed concurrency level or CPU percentage (depending on the autoscaling metric) for each Pod.
-
-
- Refer to the Knative documentation for more information.
+ description: "Sets the allowed concurrency level or CPU percentage
+ (depending on the autoscaling metric) for each Pod. \n Refer
+ to the Knative documentation for more information."
type: integer
class:
- description: |-
- Configures the Knative autoscaling class property (e.g. to set `hpa.autoscaling.knative.dev` or `kpa.autoscaling.knative.dev` autoscaling).
-
-
- Refer to the Knative documentation for more information.
+ description: "Configures the Knative autoscaling class property
+ (e.g. to set `hpa.autoscaling.knative.dev` or `kpa.autoscaling.knative.dev`
+ autoscaling). \n Refer to the Knative documentation for
+ more information."
enum:
- kpa.autoscaling.knative.dev
- hpa.autoscaling.knative.dev
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1406,43 +1376,36 @@ spec:
traits share this common property.
type: boolean
maxScale:
- description: |-
- An upper bound for the number of Pods that can be running in parallel for the integration.
- Knative has its own cap value that depends on the installation.
-
-
- Refer to the Knative documentation for more information.
+ description: "An upper bound for the number of Pods that can
+ be running in parallel for the integration. Knative has
+ its own cap value that depends on the installation. \n Refer
+ to the Knative documentation for more information."
type: integer
minScale:
- description: |-
- The minimum number of Pods that should be running at any time for the integration. It's **zero** by default, meaning that
- the integration is scaled down to zero when not used for a configured amount of time.
-
-
- Refer to the Knative documentation for more information.
+ description: "The minimum number of Pods that should be running
+ at any time for the integration. It's **zero** by default,
+ meaning that the integration is scaled down to zero when
+ not used for a configured amount of time. \n Refer to the
+ Knative documentation for more information."
type: integer
rolloutDuration:
- description: |-
- Enables to gradually shift traffic to the latest Revision and sets the rollout duration.
- It's disabled by default and must be expressed as a Golang `time.Duration` string representation,
- rounded to a second precision.
+ description: Enables to gradually shift traffic to the latest
+ Revision and sets the rollout duration. It's disabled by
+ default and must be expressed as a Golang `time.Duration`
+ string representation, rounded to a second precision.
type: string
timeoutSeconds:
- description: |-
- The maximum duration in seconds that the request instance is allowed to respond to a request.
- This field propagates to the integration pod's terminationGracePeriodSeconds
-
-
- Refer to the Knative documentation for more information.
+ description: "The maximum duration in seconds that the request
+ instance is allowed to respond to a request. This field
+ propagates to the integration pod's terminationGracePeriodSeconds
+ \n Refer to the Knative documentation for more information."
format: int64
type: integer
visibility:
- description: |-
- Setting `cluster-local`, Knative service becomes a private service.
- Specifically, this option applies the `networking.knative.dev/visibility` label to Knative service.
-
-
- Refer to the Knative documentation for more information.
+ description: "Setting `cluster-local`, Knative service becomes
+ a private service. Specifically, this option applies the
+ `networking.knative.dev/visibility` label to Knative service.
+ \n Refer to the Knative documentation for more information."
enum:
- cluster-local
type: string
@@ -1454,9 +1417,8 @@ spec:
description: Colorize the log output
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1496,18 +1458,20 @@ spec:
description: The configuration of Mount trait
properties:
configs:
- description: |-
- A list of configuration pointing to configmap/secret.
- The configuration are expected to be UTF-8 resources as they are processed by runtime Camel Context and tried to be parsed as property files.
- They are also made available on the classpath in order to ease their usage directly from the Route.
- Syntax: [configmap|secret]:name[/key], where name represents the resource name and key optionally represents the resource key to be filtered
+ description: 'A list of configuration pointing to configmap/secret.
+ The configuration are expected to be UTF-8 resources as
+ they are processed by runtime Camel Context and tried to
+ be parsed as property files. They are also made available
+ on the classpath in order to ease their usage directly from
+ the Route. Syntax: [configmap|secret]:name[/key], where
+ name represents the resource name and key optionally represents
+ the resource key to be filtered'
items:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
emptyDirs:
@@ -1520,17 +1484,21 @@ spec:
description: 'Deprecated: no longer in use.'
type: boolean
hotReload:
- description: |-
- Enable "hot reload" when a secret/configmap mounted is edited (default `false`). The configmap/secret must be
- marked with `camel.apache.org/integration` label to be taken in account. The resource will be watched for any kind change, also for
- changes in metadata.
+ description: Enable "hot reload" when a secret/configmap mounted
+ is edited (default `false`). The configmap/secret must be
+ marked with `camel.apache.org/integration` label to be taken
+ in account. The resource will be watched for any kind change,
+ also for changes in metadata.
type: boolean
resources:
- description: |-
- A list of resources (text or binary content) pointing to configmap/secret.
- The resources are expected to be any resource type (text or binary content).
- The destination path can be either a default location or any path specified by the user.
- Syntax: [configmap|secret]:name[/key][@path], where name represents the resource name, key optionally represents the resource key to be filtered and path represents the destination path
+ description: 'A list of resources (text or binary content)
+ pointing to configmap/secret. The resources are expected
+ to be any resource type (text or binary content). The destination
+ path can be either a default location or any path specified
+ by the user. Syntax: [configmap|secret]:name[/key][@path],
+ where name represents the resource name, key optionally
+ represents the resource key to be filtered and path represents
+ the destination path'
items:
type: string
type: array
@@ -1555,9 +1523,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1568,9 +1535,8 @@ spec:
description: The configuration of Owner trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1592,9 +1558,8 @@ spec:
description: The configuration of PDB trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1602,53 +1567,56 @@ spec:
traits share this common property.
type: boolean
maxUnavailable:
- description: |-
- The number of pods for the Integration that can be unavailable after an eviction.
- It can be either an absolute number or a percentage (default `1` if `min-available` is also not set).
- Only one of `max-unavailable` and `min-available` can be specified.
+ description: The number of pods for the Integration that can
+ be unavailable after an eviction. It can be either an absolute
+ number or a percentage (default `1` if `min-available` is
+ also not set). Only one of `max-unavailable` and `min-available`
+ can be specified.
type: string
minAvailable:
- description: |-
- The number of pods for the Integration that must still be available after an eviction.
- It can be either an absolute number or a percentage.
- Only one of `min-available` and `max-unavailable` can be specified.
+ description: The number of pods for the Integration that must
+ still be available after an eviction. It can be either an
+ absolute number or a percentage. Only one of `min-available`
+ and `max-unavailable` can be specified.
type: string
type: object
platform:
description: The configuration of Platform trait
properties:
auto:
- description: |-
- To automatically detect from the environment if a default platform can be created (it will be created on OpenShift or when a registry address is set).
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'To automatically detect from the environment
+ if a default platform can be created (it will be created
+ on OpenShift or when a registry address is set). Deprecated:
+ Platform is auto generated by the operator install procedure
+ - maintained for backward compatibility'
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
createDefault:
- description: |-
- To create a default (empty) platform when the platform is missing.
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'To create a default (empty) platform when the
+ platform is missing. Deprecated: Platform is auto generated
+ by the operator install procedure - maintained for backward
+ compatibility'
type: boolean
enabled:
description: 'Deprecated: no longer in use.'
type: boolean
global:
- description: |-
- Indicates if the platform should be created globally in the case of global operator (default true).
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'Indicates if the platform should be created
+ globally in the case of global operator (default true).
+ Deprecated: Platform is auto generated by the operator install
+ procedure - maintained for backward compatibility'
type: boolean
type: object
pod:
description: The configuration of Pod trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1660,9 +1628,8 @@ spec:
description: The configuration of Prometheus trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1688,9 +1655,8 @@ spec:
secret on the pod if it is of type `kubernetes.io/dockerconfigjson`.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1713,10 +1679,10 @@ spec:
description: The configuration of Quarkus trait
properties:
buildMode:
- description: |-
- The Quarkus mode to run: either `jvm` or `native` (default `jvm`).
- In case both `jvm` and `native` are specified, two `IntegrationKit` resources are created,
- with the `native` kit having precedence over the `jvm` one once ready.
+ description: 'The Quarkus mode to run: either `jvm` or `native`
+ (default `jvm`). In case both `jvm` and `native` are specified,
+ two `IntegrationKit` resources are created, with the `native`
+ kit having precedence over the `jvm` one once ready.'
items:
description: QuarkusMode is the type of Quarkus build packaging.
enum:
@@ -1725,9 +1691,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1743,18 +1708,18 @@ spec:
in the runtime catalog)
type: string
packageTypes:
- description: |-
- The Quarkus package types, `fast-jar` or `native` (default `fast-jar`).
- In case both `fast-jar` and `native` are specified, two `IntegrationKit` resources are created,
- with the native kit having precedence over the `fast-jar` one once ready.
- The order influences the resolution of the current kit for the integration.
- The kit corresponding to the first package type will be assigned to the
- integration in case no existing kit that matches the integration exists.
- Deprecated: use `build-mode` instead.
- items:
- description: |-
- QuarkusPackageType is the type of Quarkus build packaging.
- Deprecated: use `QuarkusMode` instead.
+ description: 'The Quarkus package types, `fast-jar` or `native`
+ (default `fast-jar`). In case both `fast-jar` and `native`
+ are specified, two `IntegrationKit` resources are created,
+ with the native kit having precedence over the `fast-jar`
+ one once ready. The order influences the resolution of the
+ current kit for the integration. The kit corresponding to
+ the first package type will be assigned to the integration
+ in case no existing kit that matches the integration exists.
+ Deprecated: use `build-mode` instead.'
+ items:
+ description: 'QuarkusPackageType is the type of Quarkus
+ build packaging. Deprecated: use `QuarkusMode` instead.'
enum:
- fast-jar
- native
@@ -1762,14 +1727,12 @@ spec:
type: array
type: object
registry:
- description: |-
- The configuration of Registry trait (support removed since version 2.5.0).
- Deprecated: use jvm trait or read documentation.
+ description: 'The configuration of Registry trait (support removed
+ since version 2.5.0). Deprecated: use jvm trait or read documentation.'
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1783,16 +1746,14 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to route.
- This can be used to set route specific annotations
- For annotations options see https://docs.openshift.com/container-platform/3.11/architecture/networking/routes.html#route-specific-annotations
- CLI usage example: -t "route.annotations.'haproxy.router.openshift.io/balance'=true"
+ description: 'The annotations added to route. This can be
+ used to set route specific annotations For annotations options
+ see https://docs.openshift.com/container-platform/3.11/architecture/networking/routes.html#route-specific-annotations
+ CLI usage example: -t "route.annotations.''haproxy.router.openshift.io/balance''=true"'
type: object
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1803,82 +1764,74 @@ spec:
description: To configure the host exposed by the route.
type: string
tlsCACertificate:
- description: |-
- The TLS CA certificate contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS CA certificate contents. \n Refer to
+ the OpenShift route documentation for additional information."
type: string
tlsCACertificateSecret:
- description: |-
- The secret name and key reference to the TLS CA certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the TLS
+ CA certificate. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only one
+ key in the secret it will be read, otherwise you can set
+ a key name separated with a \"/\". \n Refer to the OpenShift
+ route documentation for additional information."
type: string
tlsCertificate:
- description: |-
- The TLS certificate contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS certificate contents. \n Refer to the
+ OpenShift route documentation for additional information."
type: string
tlsCertificateSecret:
- description: |-
- The secret name and key reference to the TLS certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the TLS
+ certificate. The format is \"secret-name[/key-name]\", the
+ value represents the secret name, if there is only one key
+ in the secret it will be read, otherwise you can set a key
+ name separated with a \"/\". \n Refer to the OpenShift route
+ documentation for additional information."
type: string
tlsDestinationCACertificate:
- description: |-
- The destination CA certificate provides the contents of the ca certificate of the final destination. When using reencrypt
- termination this file should be provided in order to have routers use it for health checks on the secure connection.
- If this field is not specified, the router may provide its own destination CA and perform hostname validation using
- the short service name (service.namespace.svc), which allows infrastructure generated certificates to automatically
- verify.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The destination CA certificate provides the
+ contents of the ca certificate of the final destination.
+ \ When using reencrypt termination this file should be provided
+ in order to have routers use it for health checks on the
+ secure connection. If this field is not specified, the router
+ may provide its own destination CA and perform hostname
+ validation using the short service name (service.namespace.svc),
+ which allows infrastructure generated certificates to automatically
+ verify. \n Refer to the OpenShift route documentation for
+ additional information."
type: string
tlsDestinationCACertificateSecret:
- description: |-
- The secret name and key reference to the destination CA certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the destination
+ CA certificate. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only one
+ key in the secret it will be read, otherwise you can set
+ a key name separated with a \"/\". \n Refer to the OpenShift
+ route documentation for additional information."
type: string
tlsInsecureEdgeTerminationPolicy:
- description: |-
- To configure how to deal with insecure traffic, e.g. `Allow`, `Disable` or `Redirect` traffic.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "To configure how to deal with insecure traffic,
+ e.g. `Allow`, `Disable` or `Redirect` traffic. \n Refer
+ to the OpenShift route documentation for additional information."
enum:
- None
- Allow
- Redirect
type: string
tlsKey:
- description: |-
- The TLS certificate key contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS certificate key contents. \n Refer to
+ the OpenShift route documentation for additional information."
type: string
tlsKeySecret:
- description: |-
- The secret name and key reference to the TLS certificate key. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the TLS
+ certificate key. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only one
+ key in the secret it will be read, otherwise you can set
+ a key name separated with a \"/\". \n Refer to the OpenShift
+ route documentation for additional information."
type: string
tlsTermination:
- description: |-
- The TLS termination type, like `edge`, `passthrough` or `reencrypt`.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS termination type, like `edge`, `passthrough`
+ or `reencrypt`. \n Refer to the OpenShift route documentation
+ for additional information."
enum:
- edge
- reencrypt
@@ -1889,9 +1842,8 @@ spec:
description: The configuration of Security Context trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1923,9 +1875,8 @@ spec:
needs to be created.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1933,9 +1884,8 @@ spec:
traits share this common property.
type: boolean
nodePort:
- description: |-
- Enable Service to be exposed as NodePort (default `false`).
- Deprecated: Use service type instead.
+ description: 'Enable Service to be exposed as NodePort (default
+ `false`). Deprecated: Use service type instead.'
type: boolean
type:
description: The type of service to be used, either 'ClusterIP',
@@ -1950,9 +1900,8 @@ spec:
description: The configuration of Service Binding trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -1979,9 +1928,8 @@ spec:
description: The configuration of Toleration trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -2013,22 +1961,22 @@ spec:
description: specify how to build the Integration/IntegrationKits
properties:
baseImage:
- description: |-
- a base image that can be used as base layer for all images.
- It can be useful if you want to provide some custom base image with further utility software
+ description: a base image that can be used as base layer for all
+ images. It can be useful if you want to provide some custom
+ base image with further utility software
type: string
maven:
description: Maven configuration used to build the Camel/Camel-Quarkus
applications
properties:
caSecrets:
- description: |-
- The Secrets name and key, containing the CA certificate(s) used to connect
- to remote Maven repositories.
- It can contain X.509 certificates, and PKCS#7 formatted certificate chains.
- A JKS formatted keystore is automatically created to store the CA certificate(s),
- and configured to be used as a trusted certificate(s) by the Maven commands.
- Note that the root CA certificates are also imported into the created keystore.
+ description: The Secrets name and key, containing the CA certificate(s)
+ used to connect to remote Maven repositories. It can contain
+ X.509 certificates, and PKCS#7 formatted certificate chains.
+ A JKS formatted keystore is automatically created to store
+ the CA certificate(s), and configured to be used as a trusted
+ certificate(s) by the Maven commands. Note that the root
+ CA certificates are also imported into the created keystore.
items:
description: SecretKeySelector selects a key of a Secret.
properties:
@@ -2037,10 +1985,8 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
description: Specify whether the Secret or its key must
@@ -2049,20 +1995,16 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: array
cliOptions:
- description: |-
- The CLI options that are appended to the list of arguments for Maven commands,
- e.g., `-V,--no-transfer-progress,-Dstyle.color=never`.
+ description: The CLI options that are appended to the list
+ of arguments for Maven commands, e.g., `-V,--no-transfer-progress,-Dstyle.color=never`.
See https://maven.apache.org/ref/3.8.4/maven-embedder/cli.html.
items:
type: string
type: array
extension:
- description: |-
- The Maven build extensions.
- See https://maven.apache.org/guides/mini/guide-using-extensions.html.
+ description: The Maven build extensions. See https://maven.apache.org/guides/mini/guide-using-extensions.html.
items:
description: MavenArtifact defines a GAV (Group:Artifact:Type:Version:Classifier)
Maven artifact.
@@ -2091,9 +2033,8 @@ spec:
description: The path of the local Maven repository.
type: string
profiles:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the Maven profile.
+ description: A reference to the ConfigMap or Secret key that
+ contains the Maven profile.
items:
description: ValueSource --.
properties:
@@ -2104,10 +2045,9 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the ConfigMap or its
@@ -2116,7 +2056,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -2125,10 +2064,9 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the Secret or its key
@@ -2137,7 +2075,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
properties:
@@ -2146,9 +2083,8 @@ spec:
description: The Maven properties.
type: object
settings:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the Maven settings.
+ description: A reference to the ConfigMap or Secret key that
+ contains the Maven settings.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -2157,10 +2093,9 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the ConfigMap or its
@@ -2169,7 +2104,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -2178,10 +2112,9 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the Secret or its key
@@ -2190,12 +2123,10 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
settingsSecurity:
- description: |-
- A reference to the ConfigMap or Secret key that contains
- the security of the Maven settings.
+ description: A reference to the ConfigMap or Secret key that
+ contains the security of the Maven settings.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -2204,10 +2135,9 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the ConfigMap or its
@@ -2216,7 +2146,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -2225,10 +2154,9 @@ spec:
be a valid secret key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: Specify whether the Secret or its key
@@ -2237,7 +2165,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: object
registry:
@@ -2358,9 +2285,8 @@ spec:
description: The configuration of Affinity trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -2379,9 +2305,9 @@ spec:
in the same node (default `false`).
type: boolean
podAffinityLabels:
- description: |-
- Defines a set of pods (namely those matching the label selector, relative to the given namespace) that the
- integration pod(s) should be co-located with.
+ description: Defines a set of pods (namely those matching
+ the label selector, relative to the given namespace) that
+ the integration pod(s) should be co-located with.
items:
type: string
type: array
@@ -2390,9 +2316,9 @@ spec:
in the same node (default `false`).
type: boolean
podAntiAffinityLabels:
- description: |-
- Defines a set of pods (namely those matching the label selector, relative to the given namespace) that the
- integration pod(s) should not be co-located with.
+ description: Defines a set of pods (namely those matching
+ the label selector, relative to the given namespace) that
+ the integration pod(s) should not be co-located with.
items:
type: string
type: array
@@ -2407,14 +2333,13 @@ spec:
for the builder pod.
type: object
baseImage:
- description: |-
- Specify a base image. In order to have the application working properly it must be a container image which has a Java JDK
- installed and ready to use on path (ie `/usr/bin/java`).
+ description: Specify a base image. In order to have the application
+ working properly it must be a container image which has
+ a Java JDK installed and ready to use on path (ie `/usr/bin/java`).
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -2425,21 +2350,27 @@ spec:
existing containers (default `true`)
type: boolean
limitCPU:
- description: |-
- When using `pod` strategy, the maximum amount of CPU required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the maximum amount
+ of CPU required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
limitMemory:
- description: |-
- When using `pod` strategy, the maximum amount of memory required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the maximum amount
+ of memory required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
mavenProfiles:
- description: |-
- A list of references pointing to configmaps/secrets that contains a maven profile.
- This configmap/secret is a resource of the IntegrationKit created, therefore it needs to be present in the namespace where the operator is going to create the IntegrationKit.
- The content of the maven profile is expected to be a text containing a valid maven profile starting with `` and ending with `` that will be integrated as an inline profile in the POM.
- Syntax: [configmap|secret]:name[/key], where name represents the resource name, key optionally represents the resource key to be filtered (default key value = profile.xml).
+ description: 'A list of references pointing to configmaps/secrets
+ that contains a maven profile. This configmap/secret is
+ a resource of the IntegrationKit created, therefore it needs
+ to be present in the namespace where the operator is going
+ to create the IntegrationKit. The content of the maven profile
+ is expected to be a text containing a valid maven profile
+ starting with `` and ending with `` that
+ will be integrated as an inline profile in the POM. Syntax:
+ [configmap|secret]:name[/key], where name represents the
+ resource name, key optionally represents the resource key
+ to be filtered (default key value = profile.xml).'
items:
type: string
type: array
@@ -2470,14 +2401,14 @@ spec:
type: string
type: array
requestCPU:
- description: |-
- When using `pod` strategy, the minimum amount of CPU required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the minimum amount
+ of CPU required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
requestMemory:
- description: |-
- When using `pod` strategy, the minimum amount of memory required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the minimum amount
+ of memory required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
strategy:
description: The strategy to use, either `pod` or `routine`
@@ -2493,10 +2424,11 @@ spec:
type: string
type: array
tasksFilter:
- description: |-
- A list of tasks sorted by the order of execution in a csv format, ie, `,,...`.
- Mind that you must include also the operator tasks (`builder`, `quarkus-native`, `package`, `jib`, `s2i`)
- if you need to execute them. Useful only with `pod` strategy.
+ description: A list of tasks sorted by the order of execution
+ in a csv format, ie, `,,...`. Mind
+ that you must include also the operator tasks (`builder`,
+ `quarkus-native`, `package`, `jib`, `s2i`) if you need to
+ execute them. Useful only with `pod` strategy.
type: string
tasksLimitCPU:
description: A list of limit cpu configuration for the specific
@@ -2523,18 +2455,17 @@ spec:
type: string
type: array
verbose:
- description: |-
- Enable verbose logging on build components that support it (e.g. Kaniko build pod).
- Deprecated no longer in use
+ description: Enable verbose logging on build components that
+ support it (e.g. Kaniko build pod). Deprecated no longer
+ in use
type: boolean
type: object
camel:
description: The configuration of Camel trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -2547,10 +2478,12 @@ spec:
type: string
type: array
runtimeVersion:
- description: |-
- The camel-k-runtime version to use for the integration. It overrides the default version set in the Integration Platform.
- You can use a fixed version (for example "3.2.3") or a semantic version (for example "3.x") which will try to resolve
- to the best matching Catalog existing on the cluster.
+ description: The camel-k-runtime version to use for the integration.
+ It overrides the default version set in the Integration
+ Platform. You can use a fixed version (for example "3.2.3")
+ or a semantic version (for example "3.x") which will try
+ to resolve to the best matching Catalog existing on the
+ cluster.
type: string
type: object
container:
@@ -2578,9 +2511,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -2591,10 +2523,13 @@ spec:
Service.
type: boolean
image:
- description: |-
- The main container image to use for the Integration. When using this parameter the operator will create a synthetic IntegrationKit which
- won't be able to execute traits requiring CamelCatalog. If the container image you're using is coming from an IntegrationKit, use instead
- Integration `.spec.integrationKit` parameter. If you're moving the Integration across environments, you will also need to create an "external" IntegrationKit.
+ description: The main container image to use for the Integration.
+ When using this parameter the operator will create a synthetic
+ IntegrationKit which won't be able to execute traits requiring
+ CamelCatalog. If the container image you're using is coming
+ from an IntegrationKit, use instead Integration `.spec.integrationKit`
+ parameter. If you're moving the Integration across environments,
+ you will also need to create an "external" IntegrationKit.
type: string
imagePullPolicy:
description: 'The pull policy: Always|Never|IfNotPresent'
@@ -2662,52 +2597,50 @@ spec:
description: The configuration of Cron trait
properties:
activeDeadlineSeconds:
- description: |-
- Specifies the duration in seconds, relative to the start time, that the job
- may be continuously active before it is considered to be failed.
- It defaults to 60s.
+ description: Specifies the duration in seconds, relative to
+ the start time, that the job may be continuously active
+ before it is considered to be failed. It defaults to 60s.
format: int64
type: integer
auto:
- description: |-
- Automatically deploy the integration as CronJob when all routes are
- either starting from a periodic consumer (only `cron`, `timer` and `quartz` are supported) or a passive consumer (e.g. `direct` is a passive consumer).
-
-
- It's required that all periodic consumers have the same period, and it can be expressed as cron schedule (e.g. `1m` can be expressed as `0/1 * * * *`,
- while `35m` or `50s` cannot).
+ description: "Automatically deploy the integration as CronJob
+ when all routes are either starting from a periodic consumer
+ (only `cron`, `timer` and `quartz` are supported) or a passive
+ consumer (e.g. `direct` is a passive consumer). \n It's
+ required that all periodic consumers have the same period,
+ and it can be expressed as cron schedule (e.g. `1m` can
+ be expressed as `0/1 * * * *`, while `35m` or `50s` cannot)."
type: boolean
backoffLimit:
- description: |-
- Specifies the number of retries before marking the job failed.
- It defaults to 2.
+ description: Specifies the number of retries before marking
+ the job failed. It defaults to 2.
format: int32
type: integer
components:
- description: |-
- A comma separated list of the Camel components that need to be customized in order for them to work when the schedule is triggered externally by Kubernetes.
- A specific customizer is activated for each specified component. E.g. for the `timer` component, the `cron-timer` customizer is
- activated (it's present in the `org.apache.camel.k:camel-k-cron` library).
-
-
- Supported components are currently: `cron`, `timer` and `quartz`.
+ description: "A comma separated list of the Camel components
+ that need to be customized in order for them to work when
+ the schedule is triggered externally by Kubernetes. A specific
+ customizer is activated for each specified component. E.g.
+ for the `timer` component, the `cron-timer` customizer is
+ activated (it's present in the `org.apache.camel.k:camel-k-cron`
+ library). \n Supported components are currently: `cron`,
+ `timer` and `quartz`."
type: string
concurrencyPolicy:
- description: |-
- Specifies how to treat concurrent executions of a Job.
- Valid values are:
- - "Allow": allows CronJobs to run concurrently;
- - "Forbid" (default): forbids concurrent runs, skipping next run if previous run hasn't finished yet;
- - "Replace": cancels currently running job and replaces it with a new one
+ description: 'Specifies how to treat concurrent executions
+ of a Job. Valid values are: - "Allow": allows CronJobs to
+ run concurrently; - "Forbid" (default): forbids concurrent
+ runs, skipping next run if previous run hasn''t finished
+ yet; - "Replace": cancels currently running job and replaces
+ it with a new one'
enum:
- Allow
- Forbid
- Replace
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -2715,19 +2648,19 @@ spec:
traits share this common property.
type: boolean
fallback:
- description: |-
- Use the default Camel implementation of the `cron` endpoint (`quartz`) instead of trying to materialize the integration
- as Kubernetes CronJob.
+ description: Use the default Camel implementation of the `cron`
+ endpoint (`quartz`) instead of trying to materialize the
+ integration as Kubernetes CronJob.
type: boolean
schedule:
- description: |-
- The CronJob schedule for the whole integration. If multiple routes are declared, they must have the same schedule for this
- mechanism to work correctly.
+ description: The CronJob schedule for the whole integration.
+ If multiple routes are declared, they must have the same
+ schedule for this mechanism to work correctly.
type: string
startingDeadlineSeconds:
- description: |-
- Optional deadline in seconds for starting the job if it misses scheduled
- time for any reason. Missed jobs executions will be counted as failed ones.
+ description: Optional deadline in seconds for starting the
+ job if it misses scheduled time for any reason. Missed
+ jobs executions will be counted as failed ones.
format: int64
type: integer
timeZone:
@@ -2738,9 +2671,8 @@ spec:
description: The configuration of Dependencies trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -2751,9 +2683,8 @@ spec:
description: The configuration of Deployer trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -2769,51 +2700,49 @@ spec:
- knative-service
type: string
useSSA:
- description: |-
- Use server-side apply to update the owned resources (default `true`).
- Note that it automatically falls back to client-side patching, if SSA is not available, e.g., on old Kubernetes clusters.
+ description: Use server-side apply to update the owned resources
+ (default `true`). Note that it automatically falls back
+ to client-side patching, if SSA is not available, e.g.,
+ on old Kubernetes clusters.
type: boolean
type: object
deployment:
description: The configuration of Deployment trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
description: 'Deprecated: no longer in use.'
type: boolean
progressDeadlineSeconds:
- description: |-
- The maximum time in seconds for the deployment to make progress before it
- is considered to be failed. It defaults to `60s`.
+ description: The maximum time in seconds for the deployment
+ to make progress before it is considered to be failed. It
+ defaults to `60s`.
format: int32
type: integer
rollingUpdateMaxSurge:
anyOf:
- type: integer
- type: string
- description: |-
- The maximum number of pods that can be scheduled above the desired number of
- pods.
- Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
- This can not be 0 if MaxUnavailable is 0.
- Absolute number is calculated from percentage by rounding up.
- Defaults to `25%`.
+ description: 'The maximum number of pods that can be scheduled
+ above the desired number of pods. Value can be an absolute
+ number (ex: 5) or a percentage of desired pods (ex: 10%).
+ This can not be 0 if MaxUnavailable is 0. Absolute number
+ is calculated from percentage by rounding up. Defaults to
+ `25%`.'
x-kubernetes-int-or-string: true
rollingUpdateMaxUnavailable:
anyOf:
- type: integer
- type: string
- description: |-
- The maximum number of pods that can be unavailable during the update.
- Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
- Absolute number is calculated from percentage by rounding down.
- This can not be 0 if MaxSurge is 0.
- Defaults to `25%`.
+ description: 'The maximum number of pods that can be unavailable
+ during the update. Value can be an absolute number (ex:
+ 5) or a percentage of desired pods (ex: 10%). Absolute number
+ is calculated from percentage by rounding down. This can
+ not be 0 if MaxSurge is 0. Defaults to `25%`.'
x-kubernetes-int-or-string: true
strategy:
description: The deployment strategy to use to replace existing
@@ -2827,9 +2756,8 @@ spec:
description: The configuration of Environment trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
containerMeta:
@@ -2844,11 +2772,12 @@ spec:
`NO_PROXY` environment variables (default `true`)
type: boolean
vars:
- description: |-
- A list of environment variables to be added to the integration container.
- The syntax is either VAR=VALUE or VAR=[configmap|secret]:name/key, where name represents the resource name,
- and key represents the resource key to be mapped as and environment variable.
- These take precedence over any previously defined environment variables.
+ description: A list of environment variables to be added to
+ the integration container. The syntax is either VAR=VALUE
+ or VAR=[configmap|secret]:name/key, where name represents
+ the resource name, and key represents the resource key to
+ be mapped as and environment variable. These take precedence
+ over any previously defined environment variables.
items:
type: string
type: array
@@ -2857,9 +2786,8 @@ spec:
description: The configuration of Error Handler trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -2874,15 +2802,14 @@ spec:
description: The configuration of GC trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
discoveryCache:
- description: |-
- Discovery client cache to be used, either `disabled`, `disk` or `memory` (default `memory`).
- Deprecated: to be removed from trait configuration.
+ description: 'Discovery client cache to be used, either `disabled`,
+ `disk` or `memory` (default `memory`). Deprecated: to be
+ removed from trait configuration.'
enum:
- disabled
- disk
@@ -2897,9 +2824,8 @@ spec:
description: The configuration of Health trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3021,19 +2947,17 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to the ingress.
- This can be used to set controller specific annotations, e.g., when using the NGINX Ingress controller:
- See https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md
+ description: 'The annotations added to the ingress. This can
+ be used to set controller specific annotations, e.g., when
+ using the NGINX Ingress controller: See https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md'
type: object
auto:
description: To automatically add an ingress whenever the
integration uses an HTTP endpoint consumer.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3043,14 +2967,18 @@ spec:
host:
description: To configure the host exposed by the ingress.
type: string
+ ingressClassName:
+ description: The Ingress class name as defined by the Ingress
+ spec See https://kubernetes.io/docs/concepts/services-networking/ingress/
+ type: string
path:
description: To configure the path exposed by the ingress
(default `/`).
type: string
pathType:
- description: |-
- To configure the path type exposed by the ingress.
- One of `Exact`, `Prefix`, `ImplementationSpecific` (default to `Prefix`).
+ description: To configure the path type exposed by the ingress.
+ One of `Exact`, `Prefix`, `ImplementationSpecific` (default
+ to `Prefix`).
enum:
- Exact
- Prefix
@@ -3074,9 +3002,8 @@ spec:
by default).
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3093,23 +3020,25 @@ spec:
description: The configuration of Jolokia trait
properties:
CACert:
- description: |-
- The PEM encoded CA certification file path, used to verify client certificates,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt` for OpenShift).
+ description: The PEM encoded CA certification file path, used
+ to verify client certificates, applicable when `protocol`
+ is `https` and `use-ssl-client-authentication` is `true`
+ (default `/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt`
+ for OpenShift).
type: string
clientPrincipal:
- description: |-
- The principal(s) which must be given in a client certificate to allow access to the Jolokia endpoint,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `clientPrincipal=cn=system:master-proxy`, `cn=hawtio-online.hawtio.svc` and `cn=fuse-console.fuse.svc` for OpenShift).
+ description: The principal(s) which must be given in a client
+ certificate to allow access to the Jolokia endpoint, applicable
+ when `protocol` is `https` and `use-ssl-client-authentication`
+ is `true` (default `clientPrincipal=cn=system:master-proxy`,
+ `cn=hawtio-online.hawtio.svc` and `cn=fuse-console.fuse.svc`
+ for OpenShift).
items:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
discoveryEnabled:
@@ -3120,20 +3049,20 @@ spec:
traits share this common property.
type: boolean
extendedClientCheck:
- description: |-
- Mandate the client certificate contains a client flag in the extended key usage section,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `true` for OpenShift).
+ description: Mandate the client certificate contains a client
+ flag in the extended key usage section, applicable when
+ `protocol` is `https` and `use-ssl-client-authentication`
+ is `true` (default `true` for OpenShift).
type: boolean
host:
- description: |-
- The Host address to which the Jolokia agent should bind to. If `"\*"` or `"0.0.0.0"` is given,
- the servers binds to every network interface (default `"*"`).
+ description: The Host address to which the Jolokia agent should
+ bind to. If `"\*"` or `"0.0.0.0"` is given, the servers
+ binds to every network interface (default `"*"`).
type: string
options:
- description: |-
- A list of additional Jolokia options as defined
- in https://jolokia.org/reference/html/agents.html#agent-jvm-config[JVM agent configuration options]
+ description: A list of additional Jolokia options as defined
+ in https://jolokia.org/reference/html/agents.html#agent-jvm-config[JVM
+ agent configuration options]
items:
type: string
type: array
@@ -3164,9 +3093,8 @@ spec:
separator)
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
debug:
@@ -3195,9 +3123,9 @@ spec:
type: string
type: array
printCommand:
- description: |-
- Prints the command used the start the JVM in the container logs (default `true`)
- Deprecated: no longer in use.
+ description: 'Prints the command used the start the JVM in
+ the container logs (default `true`) Deprecated: no longer
+ in use.'
type: boolean
type: object
kamelets:
@@ -3208,9 +3136,8 @@ spec:
and their default configuration (enabled by default)
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3243,16 +3170,14 @@ spec:
description: Enable automatic discovery of all trait properties.
type: boolean
channelSinks:
- description: |-
- List of channels used as destination of integration routes.
- Can contain simple channel names or full Camel URIs.
+ description: List of channels used as destination of integration
+ routes. Can contain simple channel names or full Camel URIs.
items:
type: string
type: array
channelSources:
- description: |-
- List of channels used as source of integration routes.
- Can contain simple channel names or full Camel URIs.
+ description: List of channels used as source of integration
+ routes. Can contain simple channel names or full Camel URIs.
items:
type: string
type: array
@@ -3261,9 +3186,8 @@ spec:
in JSON format.
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3271,9 +3195,9 @@ spec:
traits share this common property.
type: boolean
endpointSinks:
- description: |-
- List of endpoints used as destination of integration routes.
- Can contain simple endpoint names or full Camel URIs.
+ description: List of endpoints used as destination of integration
+ routes. Can contain simple endpoint names or full Camel
+ URIs.
items:
type: string
type: array
@@ -3284,50 +3208,54 @@ spec:
type: string
type: array
eventSinks:
- description: |-
- List of event types that the integration will produce.
- Can contain simple event types or full Camel URIs (to use a specific broker).
+ description: List of event types that the integration will
+ produce. Can contain simple event types or full Camel URIs
+ (to use a specific broker).
items:
type: string
type: array
eventSources:
- description: |-
- List of event types that the integration will be subscribed to.
- Can contain simple event types or full Camel URIs (to use a specific broker different from "default").
+ description: List of event types that the integration will
+ be subscribed to. Can contain simple event types or full
+ Camel URIs (to use a specific broker different from "default").
items:
type: string
type: array
filterEventType:
- description: |-
- Enables the default filtering for the Knative trigger using the event type
- If this is true, the created Knative trigger uses the event type as a filter on the event stream when no other filter criteria is given. (default: true)
+ description: 'Enables the default filtering for the Knative
+ trigger using the event type If this is true, the created
+ Knative trigger uses the event type as a filter on the event
+ stream when no other filter criteria is given. (default:
+ true)'
type: boolean
filterSourceChannels:
- description: |-
- Enables filtering on events based on the header "ce-knativehistory". Since this header has been removed in newer versions of
- Knative, filtering is disabled by default.
+ description: Enables filtering on events based on the header
+ "ce-knativehistory". Since this header has been removed
+ in newer versions of Knative, filtering is disabled by default.
type: boolean
filters:
- description: |-
- Sets filter attributes on the event stream (such as event type, source, subject and so on).
- A list of key-value pairs that represent filter attributes and its values.
- The syntax is KEY=VALUE, e.g., `source="my.source"`.
- Filter attributes get set on the Knative trigger that is being created as part of this integration.
+ description: Sets filter attributes on the event stream (such
+ as event type, source, subject and so on). A list of key-value
+ pairs that represent filter attributes and its values. The
+ syntax is KEY=VALUE, e.g., `source="my.source"`. Filter
+ attributes get set on the Knative trigger that is being
+ created as part of this integration.
items:
type: string
type: array
namespaceLabel:
- description: |-
- Enables the camel-k-operator to set the "bindings.knative.dev/include=true" label to the namespace
- As Knative requires this label to perform injection of K_SINK URL into the service.
- If this is false, the integration pod may start and fail, read the SinkBinding Knative documentation. (default: true)
+ description: 'Enables the camel-k-operator to set the "bindings.knative.dev/include=true"
+ label to the namespace As Knative requires this label to
+ perform injection of K_SINK URL into the service. If this
+ is false, the integration pod may start and fail, read the
+ SinkBinding Knative documentation. (default: true)'
type: boolean
sinkBinding:
- description: |-
- Allows binding the integration to a sink via a Knative SinkBinding resource.
- This can be used when the integration targets a single sink.
- It's enabled by default when the integration targets a single sink
- (except when the integration is owned by a Knative source).
+ description: Allows binding the integration to a sink via
+ a Knative SinkBinding resource. This can be used when the
+ integration targets a single sink. It's enabled by default
+ when the integration targets a single sink (except when
+ the integration is owned by a Knative source).
type: boolean
type: object
knative-service:
@@ -3336,47 +3264,39 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to route.
- This can be used to set knative service specific annotations
- CLI usage example: -t "knative-service.annotations.'haproxy.router.openshift.io/balance'=true"
+ description: 'The annotations added to route. This can be
+ used to set knative service specific annotations CLI usage
+ example: -t "knative-service.annotations.''haproxy.router.openshift.io/balance''=true"'
type: object
auto:
- description: |-
- Automatically deploy the integration as Knative service when all conditions hold:
-
-
- * Integration is using the Knative profile
- * All routes are either starting from an HTTP based consumer or a passive consumer (e.g. `direct` is a passive consumer)
+ description: "Automatically deploy the integration as Knative
+ service when all conditions hold: \n * Integration is using
+ the Knative profile * All routes are either starting from
+ an HTTP based consumer or a passive consumer (e.g. `direct`
+ is a passive consumer)"
type: boolean
autoscalingMetric:
- description: |-
- Configures the Knative autoscaling metric property (e.g. to set `concurrency` based or `cpu` based autoscaling).
-
-
- Refer to the Knative documentation for more information.
+ description: "Configures the Knative autoscaling metric property
+ (e.g. to set `concurrency` based or `cpu` based autoscaling).
+ \n Refer to the Knative documentation for more information."
type: string
autoscalingTarget:
- description: |-
- Sets the allowed concurrency level or CPU percentage (depending on the autoscaling metric) for each Pod.
-
-
- Refer to the Knative documentation for more information.
+ description: "Sets the allowed concurrency level or CPU percentage
+ (depending on the autoscaling metric) for each Pod. \n Refer
+ to the Knative documentation for more information."
type: integer
class:
- description: |-
- Configures the Knative autoscaling class property (e.g. to set `hpa.autoscaling.knative.dev` or `kpa.autoscaling.knative.dev` autoscaling).
-
-
- Refer to the Knative documentation for more information.
+ description: "Configures the Knative autoscaling class property
+ (e.g. to set `hpa.autoscaling.knative.dev` or `kpa.autoscaling.knative.dev`
+ autoscaling). \n Refer to the Knative documentation for
+ more information."
enum:
- kpa.autoscaling.knative.dev
- hpa.autoscaling.knative.dev
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3384,43 +3304,36 @@ spec:
traits share this common property.
type: boolean
maxScale:
- description: |-
- An upper bound for the number of Pods that can be running in parallel for the integration.
- Knative has its own cap value that depends on the installation.
-
-
- Refer to the Knative documentation for more information.
+ description: "An upper bound for the number of Pods that can
+ be running in parallel for the integration. Knative has
+ its own cap value that depends on the installation. \n Refer
+ to the Knative documentation for more information."
type: integer
minScale:
- description: |-
- The minimum number of Pods that should be running at any time for the integration. It's **zero** by default, meaning that
- the integration is scaled down to zero when not used for a configured amount of time.
-
-
- Refer to the Knative documentation for more information.
+ description: "The minimum number of Pods that should be running
+ at any time for the integration. It's **zero** by default,
+ meaning that the integration is scaled down to zero when
+ not used for a configured amount of time. \n Refer to the
+ Knative documentation for more information."
type: integer
rolloutDuration:
- description: |-
- Enables to gradually shift traffic to the latest Revision and sets the rollout duration.
- It's disabled by default and must be expressed as a Golang `time.Duration` string representation,
- rounded to a second precision.
+ description: Enables to gradually shift traffic to the latest
+ Revision and sets the rollout duration. It's disabled by
+ default and must be expressed as a Golang `time.Duration`
+ string representation, rounded to a second precision.
type: string
timeoutSeconds:
- description: |-
- The maximum duration in seconds that the request instance is allowed to respond to a request.
- This field propagates to the integration pod's terminationGracePeriodSeconds
-
-
- Refer to the Knative documentation for more information.
+ description: "The maximum duration in seconds that the request
+ instance is allowed to respond to a request. This field
+ propagates to the integration pod's terminationGracePeriodSeconds
+ \n Refer to the Knative documentation for more information."
format: int64
type: integer
visibility:
- description: |-
- Setting `cluster-local`, Knative service becomes a private service.
- Specifically, this option applies the `networking.knative.dev/visibility` label to Knative service.
-
-
- Refer to the Knative documentation for more information.
+ description: "Setting `cluster-local`, Knative service becomes
+ a private service. Specifically, this option applies the
+ `networking.knative.dev/visibility` label to Knative service.
+ \n Refer to the Knative documentation for more information."
enum:
- cluster-local
type: string
@@ -3432,9 +3345,8 @@ spec:
description: Colorize the log output
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3474,18 +3386,20 @@ spec:
description: The configuration of Mount trait
properties:
configs:
- description: |-
- A list of configuration pointing to configmap/secret.
- The configuration are expected to be UTF-8 resources as they are processed by runtime Camel Context and tried to be parsed as property files.
- They are also made available on the classpath in order to ease their usage directly from the Route.
- Syntax: [configmap|secret]:name[/key], where name represents the resource name and key optionally represents the resource key to be filtered
+ description: 'A list of configuration pointing to configmap/secret.
+ The configuration are expected to be UTF-8 resources as
+ they are processed by runtime Camel Context and tried to
+ be parsed as property files. They are also made available
+ on the classpath in order to ease their usage directly from
+ the Route. Syntax: [configmap|secret]:name[/key], where
+ name represents the resource name and key optionally represents
+ the resource key to be filtered'
items:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
emptyDirs:
@@ -3498,17 +3412,21 @@ spec:
description: 'Deprecated: no longer in use.'
type: boolean
hotReload:
- description: |-
- Enable "hot reload" when a secret/configmap mounted is edited (default `false`). The configmap/secret must be
- marked with `camel.apache.org/integration` label to be taken in account. The resource will be watched for any kind change, also for
- changes in metadata.
+ description: Enable "hot reload" when a secret/configmap mounted
+ is edited (default `false`). The configmap/secret must be
+ marked with `camel.apache.org/integration` label to be taken
+ in account. The resource will be watched for any kind change,
+ also for changes in metadata.
type: boolean
resources:
- description: |-
- A list of resources (text or binary content) pointing to configmap/secret.
- The resources are expected to be any resource type (text or binary content).
- The destination path can be either a default location or any path specified by the user.
- Syntax: [configmap|secret]:name[/key][@path], where name represents the resource name, key optionally represents the resource key to be filtered and path represents the destination path
+ description: 'A list of resources (text or binary content)
+ pointing to configmap/secret. The resources are expected
+ to be any resource type (text or binary content). The destination
+ path can be either a default location or any path specified
+ by the user. Syntax: [configmap|secret]:name[/key][@path],
+ where name represents the resource name, key optionally
+ represents the resource key to be filtered and path represents
+ the destination path'
items:
type: string
type: array
@@ -3533,9 +3451,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3546,9 +3463,8 @@ spec:
description: The configuration of Owner trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3570,9 +3486,8 @@ spec:
description: The configuration of PDB trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3580,53 +3495,56 @@ spec:
traits share this common property.
type: boolean
maxUnavailable:
- description: |-
- The number of pods for the Integration that can be unavailable after an eviction.
- It can be either an absolute number or a percentage (default `1` if `min-available` is also not set).
- Only one of `max-unavailable` and `min-available` can be specified.
+ description: The number of pods for the Integration that can
+ be unavailable after an eviction. It can be either an absolute
+ number or a percentage (default `1` if `min-available` is
+ also not set). Only one of `max-unavailable` and `min-available`
+ can be specified.
type: string
minAvailable:
- description: |-
- The number of pods for the Integration that must still be available after an eviction.
- It can be either an absolute number or a percentage.
- Only one of `min-available` and `max-unavailable` can be specified.
+ description: The number of pods for the Integration that must
+ still be available after an eviction. It can be either an
+ absolute number or a percentage. Only one of `min-available`
+ and `max-unavailable` can be specified.
type: string
type: object
platform:
description: The configuration of Platform trait
properties:
auto:
- description: |-
- To automatically detect from the environment if a default platform can be created (it will be created on OpenShift or when a registry address is set).
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'To automatically detect from the environment
+ if a default platform can be created (it will be created
+ on OpenShift or when a registry address is set). Deprecated:
+ Platform is auto generated by the operator install procedure
+ - maintained for backward compatibility'
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
createDefault:
- description: |-
- To create a default (empty) platform when the platform is missing.
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'To create a default (empty) platform when the
+ platform is missing. Deprecated: Platform is auto generated
+ by the operator install procedure - maintained for backward
+ compatibility'
type: boolean
enabled:
description: 'Deprecated: no longer in use.'
type: boolean
global:
- description: |-
- Indicates if the platform should be created globally in the case of global operator (default true).
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'Indicates if the platform should be created
+ globally in the case of global operator (default true).
+ Deprecated: Platform is auto generated by the operator install
+ procedure - maintained for backward compatibility'
type: boolean
type: object
pod:
description: The configuration of Pod trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3638,9 +3556,8 @@ spec:
description: The configuration of Prometheus trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3666,9 +3583,8 @@ spec:
secret on the pod if it is of type `kubernetes.io/dockerconfigjson`.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3691,10 +3607,10 @@ spec:
description: The configuration of Quarkus trait
properties:
buildMode:
- description: |-
- The Quarkus mode to run: either `jvm` or `native` (default `jvm`).
- In case both `jvm` and `native` are specified, two `IntegrationKit` resources are created,
- with the `native` kit having precedence over the `jvm` one once ready.
+ description: 'The Quarkus mode to run: either `jvm` or `native`
+ (default `jvm`). In case both `jvm` and `native` are specified,
+ two `IntegrationKit` resources are created, with the `native`
+ kit having precedence over the `jvm` one once ready.'
items:
description: QuarkusMode is the type of Quarkus build packaging.
enum:
@@ -3703,9 +3619,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3721,18 +3636,18 @@ spec:
in the runtime catalog)
type: string
packageTypes:
- description: |-
- The Quarkus package types, `fast-jar` or `native` (default `fast-jar`).
- In case both `fast-jar` and `native` are specified, two `IntegrationKit` resources are created,
- with the native kit having precedence over the `fast-jar` one once ready.
- The order influences the resolution of the current kit for the integration.
- The kit corresponding to the first package type will be assigned to the
- integration in case no existing kit that matches the integration exists.
- Deprecated: use `build-mode` instead.
- items:
- description: |-
- QuarkusPackageType is the type of Quarkus build packaging.
- Deprecated: use `QuarkusMode` instead.
+ description: 'The Quarkus package types, `fast-jar` or `native`
+ (default `fast-jar`). In case both `fast-jar` and `native`
+ are specified, two `IntegrationKit` resources are created,
+ with the native kit having precedence over the `fast-jar`
+ one once ready. The order influences the resolution of the
+ current kit for the integration. The kit corresponding to
+ the first package type will be assigned to the integration
+ in case no existing kit that matches the integration exists.
+ Deprecated: use `build-mode` instead.'
+ items:
+ description: 'QuarkusPackageType is the type of Quarkus
+ build packaging. Deprecated: use `QuarkusMode` instead.'
enum:
- fast-jar
- native
@@ -3740,14 +3655,12 @@ spec:
type: array
type: object
registry:
- description: |-
- The configuration of Registry trait (support removed since version 2.5.0).
- Deprecated: use jvm trait or read documentation.
+ description: 'The configuration of Registry trait (support removed
+ since version 2.5.0). Deprecated: use jvm trait or read documentation.'
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3761,16 +3674,14 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to route.
- This can be used to set route specific annotations
- For annotations options see https://docs.openshift.com/container-platform/3.11/architecture/networking/routes.html#route-specific-annotations
- CLI usage example: -t "route.annotations.'haproxy.router.openshift.io/balance'=true"
+ description: 'The annotations added to route. This can be
+ used to set route specific annotations For annotations options
+ see https://docs.openshift.com/container-platform/3.11/architecture/networking/routes.html#route-specific-annotations
+ CLI usage example: -t "route.annotations.''haproxy.router.openshift.io/balance''=true"'
type: object
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3781,82 +3692,74 @@ spec:
description: To configure the host exposed by the route.
type: string
tlsCACertificate:
- description: |-
- The TLS CA certificate contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS CA certificate contents. \n Refer to
+ the OpenShift route documentation for additional information."
type: string
tlsCACertificateSecret:
- description: |-
- The secret name and key reference to the TLS CA certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the TLS
+ CA certificate. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only one
+ key in the secret it will be read, otherwise you can set
+ a key name separated with a \"/\". \n Refer to the OpenShift
+ route documentation for additional information."
type: string
tlsCertificate:
- description: |-
- The TLS certificate contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS certificate contents. \n Refer to the
+ OpenShift route documentation for additional information."
type: string
tlsCertificateSecret:
- description: |-
- The secret name and key reference to the TLS certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the TLS
+ certificate. The format is \"secret-name[/key-name]\", the
+ value represents the secret name, if there is only one key
+ in the secret it will be read, otherwise you can set a key
+ name separated with a \"/\". \n Refer to the OpenShift route
+ documentation for additional information."
type: string
tlsDestinationCACertificate:
- description: |-
- The destination CA certificate provides the contents of the ca certificate of the final destination. When using reencrypt
- termination this file should be provided in order to have routers use it for health checks on the secure connection.
- If this field is not specified, the router may provide its own destination CA and perform hostname validation using
- the short service name (service.namespace.svc), which allows infrastructure generated certificates to automatically
- verify.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The destination CA certificate provides the
+ contents of the ca certificate of the final destination.
+ \ When using reencrypt termination this file should be provided
+ in order to have routers use it for health checks on the
+ secure connection. If this field is not specified, the router
+ may provide its own destination CA and perform hostname
+ validation using the short service name (service.namespace.svc),
+ which allows infrastructure generated certificates to automatically
+ verify. \n Refer to the OpenShift route documentation for
+ additional information."
type: string
tlsDestinationCACertificateSecret:
- description: |-
- The secret name and key reference to the destination CA certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the destination
+ CA certificate. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only one
+ key in the secret it will be read, otherwise you can set
+ a key name separated with a \"/\". \n Refer to the OpenShift
+ route documentation for additional information."
type: string
tlsInsecureEdgeTerminationPolicy:
- description: |-
- To configure how to deal with insecure traffic, e.g. `Allow`, `Disable` or `Redirect` traffic.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "To configure how to deal with insecure traffic,
+ e.g. `Allow`, `Disable` or `Redirect` traffic. \n Refer
+ to the OpenShift route documentation for additional information."
enum:
- None
- Allow
- Redirect
type: string
tlsKey:
- description: |-
- The TLS certificate key contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS certificate key contents. \n Refer to
+ the OpenShift route documentation for additional information."
type: string
tlsKeySecret:
- description: |-
- The secret name and key reference to the TLS certificate key. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the TLS
+ certificate key. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only one
+ key in the secret it will be read, otherwise you can set
+ a key name separated with a \"/\". \n Refer to the OpenShift
+ route documentation for additional information."
type: string
tlsTermination:
- description: |-
- The TLS termination type, like `edge`, `passthrough` or `reencrypt`.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS termination type, like `edge`, `passthrough`
+ or `reencrypt`. \n Refer to the OpenShift route documentation
+ for additional information."
enum:
- edge
- reencrypt
@@ -3867,9 +3770,8 @@ spec:
description: The configuration of Security Context trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3901,9 +3803,8 @@ spec:
needs to be created.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3911,9 +3812,8 @@ spec:
traits share this common property.
type: boolean
nodePort:
- description: |-
- Enable Service to be exposed as NodePort (default `false`).
- Deprecated: Use service type instead.
+ description: 'Enable Service to be exposed as NodePort (default
+ `false`). Deprecated: Use service type instead.'
type: boolean
type:
description: The type of service to be used, either 'ClusterIP',
@@ -3928,9 +3828,8 @@ spec:
description: The configuration of Service Binding trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3957,9 +3856,8 @@ spec:
description: The configuration of Toleration trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -3989,3 +3887,9 @@ spec:
storage: true
subresources:
status: {}
+status:
+ acceptedNames:
+ kind: ""
+ plural: ""
+ conditions: []
+ storedVersions: []
diff --git a/pkg/resources/config/crd/bases/camel.apache.org_integrations.yaml b/pkg/resources/config/crd/bases/camel.apache.org_integrations.yaml
index 1f8528993a..f81c870b74 100644
--- a/pkg/resources/config/crd/bases/camel.apache.org_integrations.yaml
+++ b/pkg/resources/config/crd/bases/camel.apache.org_integrations.yaml
@@ -15,12 +15,14 @@
# limitations under the License.
# ---------------------------------------------------------------------------
+
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
- controller-gen.kubebuilder.io/version: v0.15.0
+ controller-gen.kubebuilder.io/version: v0.6.1
+ creationTimestamp: null
name: integrations.camel.apache.org
spec:
group: camel.apache.org
@@ -67,19 +69,14 @@ spec:
description: Integration is the Schema for the integrations API.
properties:
apiVersion:
- description: |-
- APIVersion defines the versioned schema of this representation of an object.
- Servers should convert recognized schemas to the latest internal value, and
- may reject unrecognized values.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+ description: 'APIVersion defines the versioned schema of this representation
+ of an object. Servers should convert recognized schemas to the latest
+ internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: |-
- Kind is a string value representing the REST resource this object represents.
- Servers may infer this from the endpoint the client submits requests to.
- Cannot be updated.
- In CamelCase.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ description: 'Kind is a string value representing the REST resource this
+ object represents. Servers may infer this from the endpoint the client
+ submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
@@ -87,12 +84,10 @@ spec:
description: the desired Integration specification
properties:
configuration:
- description: |-
- Deprecated:
- Use camel trait (camel.properties) to manage properties
- Use mount trait (mount.configs) to manage configs
- Use mount trait (mount.resources) to manage resources
- Use mount trait (mount.volumes) to manage volumes
+ description: 'Deprecated: Use camel trait (camel.properties) to manage
+ properties Use mount trait (mount.configs) to manage configs Use
+ mount trait (mount.resources) to manage resources Use mount trait
+ (mount.volumes) to manage volumes'
items:
description: ConfigurationSpec represents a generic configuration
specification.
@@ -133,43 +128,35 @@ spec:
description: API version of the referent.
type: string
fieldPath:
- description: |-
- If referring to a piece of an object instead of an entire object, this string
- should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
- For example, if the object reference is to a container within a pod, this would take on a value like:
- "spec.containers{name}" (where "name" refers to the name of the container that triggered
- the event) or if no container name is specified "spec.containers[2]" (container with
- index 2 in this pod). This syntax is chosen only to have some well-defined way of
- referencing a part of an object.
- TODO: this design is not final and this field is subject to change in the future.
+ description: 'If referring to a piece of an object instead of
+ an entire object, this string should contain a valid JSON/Go
+ field access statement, such as desiredState.manifest.containers[2].
+ For example, if the object reference is to a container within
+ a pod, this would take on a value like: "spec.containers{name}"
+ (where "name" refers to the name of the container that triggered
+ the event) or if no container name is specified "spec.containers[2]"
+ (container with index 2 in this pod). This syntax is chosen
+ only to have some well-defined way of referencing a part of
+ an object. TODO: this design is not final and this field is
+ subject to change in the future.'
type: string
kind:
- description: |-
- Kind of the referent.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ 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: 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'
type: string
namespace:
- description: |-
- Namespace of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
+ description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type: string
resourceVersion:
- description: |-
- Specific resourceVersion to which this reference is made, if any.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
+ description: 'Specific resourceVersion to which this reference
+ is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
type: string
uid:
- description: |-
- UID of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
+ description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
type: string
type: object
- x-kubernetes-map-type: atomic
profile:
description: the profile needed to run this Integration
type: string
@@ -210,8 +197,7 @@ spec:
description: True if the spec is generated from a Kamelet
type: boolean
interceptors:
- description: |-
- Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
+ description: Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
uses to pre/post process sources
items:
type: string
@@ -221,9 +207,8 @@ spec:
to interpret this source code
type: string
loader:
- description: |-
- Loader is an optional id of the org.apache.camel.k.RoutesLoader that will
- interpret this source at runtime
+ description: Loader is an optional id of the org.apache.camel.k.RoutesLoader
+ that will interpret this source at runtime
type: string
name:
description: the name of the specification
@@ -267,35 +252,38 @@ spec:
to run within a pod.
properties:
args:
- description: |-
- Arguments to the entrypoint.
- The container image's CMD is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Arguments to the entrypoint. The container
+ image''s CMD is used if this is not provided. Variable
+ references $(VAR_NAME) are expanded using the container''s
+ environment. If a variable cannot be resolved, the
+ reference in the input string will be unchanged. Double
+ $$ are reduced to a single $, which allows for escaping
+ the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce
+ the string literal "$(VAR_NAME)". Escaped references
+ will never be expanded, regardless of whether the
+ variable exists or not. Cannot be updated. More info:
+ https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
command:
- description: |-
- Entrypoint array. Not executed within a shell.
- The container image's ENTRYPOINT is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Entrypoint array. Not executed within
+ a shell. The container image''s ENTRYPOINT is used
+ if this is not provided. Variable references $(VAR_NAME)
+ are expanded using the container''s environment. If
+ a variable cannot be resolved, the reference in the
+ input string will be unchanged. Double $$ are reduced
+ to a single $, which allows for escaping the $(VAR_NAME)
+ syntax: i.e. "$$(VAR_NAME)" will produce the string
+ literal "$(VAR_NAME)". Escaped references will never
+ be expanded, regardless of whether the variable exists
+ or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
env:
- description: |-
- List of environment variables to set in the container.
- Cannot be updated.
+ description: List of environment variables to set in
+ the container. Cannot be updated.
items:
description: EnvVar represents an environment variable
present in a Container.
@@ -305,16 +293,17 @@ spec:
Must be a C_IDENTIFIER.
type: string
value:
- description: |-
- Variable references $(VAR_NAME) are expanded
- using the previously defined environment variables in the container and
- any service environment variables. If a variable cannot be resolved,
- the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
- "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
- Escaped references will never be expanded, regardless of whether the variable
- exists or not.
- Defaults to "".
+ description: 'Variable references $(VAR_NAME)
+ are expanded using the previously defined environment
+ variables in the container and any service environment
+ variables. If a variable cannot be resolved,
+ the reference in the input string will be unchanged.
+ Double $$ are reduced to a single $, which allows
+ for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)"
+ will produce the string literal "$(VAR_NAME)".
+ Escaped references will never be expanded, regardless
+ of whether the variable exists or not. Defaults
+ to "".'
type: string
valueFrom:
description: Source for the environment variable's
@@ -327,10 +316,10 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
@@ -339,11 +328,12 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
fieldRef:
- description: |-
- Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`,
- spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ description: 'Selects a field of the pod:
+ supports metadata.name, metadata.namespace,
+ `metadata.labels['''']`, `metadata.annotations['''']`,
+ spec.nodeName, spec.serviceAccountName,
+ status.hostIP, status.podIP, status.podIPs.'
properties:
apiVersion:
description: Version of the schema the
@@ -357,11 +347,12 @@ spec:
required:
- fieldPath
type: object
- x-kubernetes-map-type: atomic
resourceFieldRef:
- description: |-
- Selects a resource of the container: only resources limits and requests
- (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
+ description: 'Selects a resource of the container:
+ only resources limits and requests (limits.cpu,
+ limits.memory, limits.ephemeral-storage,
+ requests.cpu, requests.memory and requests.ephemeral-storage)
+ are currently supported.'
properties:
containerName:
description: 'Container name: required
@@ -382,7 +373,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret in
the pod's namespace
@@ -393,10 +383,10 @@ spec:
key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret
@@ -405,20 +395,20 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
required:
- name
type: object
type: array
envFrom:
- description: |-
- List of sources to populate environment variables in the container.
- The keys defined within a source must be a C_IDENTIFIER. All invalid keys
- will be reported as an event when the container is starting. When a key exists in multiple
- sources, the value associated with the last source will take precedence.
- Values defined by an Env with a duplicate key will take precedence.
- Cannot be updated.
+ description: List of sources to populate environment
+ variables in the container. The keys defined within
+ a source must be a C_IDENTIFIER. All invalid keys
+ will be reported as an event when the container is
+ starting. When a key exists in multiple sources, the
+ value associated with the last source will take precedence.
+ Values defined by an Env with a duplicate key will
+ take precedence. Cannot be updated.
items:
description: EnvFromSource represents the source of
a set of ConfigMaps
@@ -427,17 +417,16 @@ spec:
description: The ConfigMap to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
prefix:
description: An optional identifier to prepend
to each key in the ConfigMap. Must be a C_IDENTIFIER.
@@ -446,56 +435,57 @@ spec:
description: The Secret to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret must
be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
image:
- description: |-
- Container image name.
- More info: https://kubernetes.io/docs/concepts/containers/images
- This field is optional to allow higher level config management to default or override
- container images in workload controllers like Deployments and StatefulSets.
+ description: 'Container image name. More info: https://kubernetes.io/docs/concepts/containers/images
+ This field is optional to allow higher level config
+ management to default or override container images
+ in workload controllers like Deployments and StatefulSets.'
type: string
imagePullPolicy:
- description: |-
- Image pull policy.
- One of Always, Never, IfNotPresent.
- Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
+ description: 'Image pull policy. One of Always, Never,
+ IfNotPresent. Defaults to Always if :latest tag is
+ specified, or IfNotPresent otherwise. Cannot be updated.
+ More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
- description: |-
- Actions that the management system should take in response to container lifecycle events.
- Cannot be updated.
+ description: Actions that the management system should
+ take in response to container lifecycle events. Cannot
+ be updated.
properties:
postStart:
- description: |-
- PostStart is called immediately after a container is created. If the handler fails,
- the container is terminated and restarted according to its restart policy.
- Other management of the container blocks until the hook completes.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PostStart is called immediately after
+ a container is created. If the handler fails,
+ the container is terminated and restarted according
+ to its restart policy. Other management of the
+ container blocks until the hook completes. More
+ info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
@@ -505,8 +495,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -517,9 +507,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -537,15 +528,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -563,10 +553,11 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT supported
+ as a LifecycleHandler and kept for the backward
+ compatibility. There are no validation of
+ this field and lifecycle hooks will fail in
+ runtime when tcp handler is specified.
properties:
host:
description: 'Optional: Host name to connect
@@ -576,37 +567,44 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
preStop:
- description: |-
- PreStop is called immediately before a container is terminated due to an
- API request or management event such as liveness/startup probe failure,
- preemption, resource contention, etc. The handler is not called if the
- container crashes or exits. The Pod's termination grace period countdown begins before the
- PreStop hook is executed. Regardless of the outcome of the handler, the
- container will eventually terminate within the Pod's termination grace
- period (unless delayed by finalizers). Other management of the container blocks until the hook completes
- or until the termination grace period is reached.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PreStop is called immediately before
+ a container is terminated due to an API request
+ or management event such as liveness/startup probe
+ failure, preemption, resource contention, etc.
+ The handler is not called if the container crashes
+ or exits. The Pod''s termination grace period
+ countdown begins before the PreStop hook is executed.
+ Regardless of the outcome of the handler, the
+ container will eventually terminate within the
+ Pod''s termination grace period (unless delayed
+ by finalizers). Other management of the container
+ blocks until the hook completes or until the termination
+ grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
@@ -616,8 +614,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -628,9 +626,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -648,15 +647,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -674,10 +672,11 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT supported
+ as a LifecycleHandler and kept for the backward
+ compatibility. There are no validation of
+ this field and lifecycle hooks will fail in
+ runtime when tcp handler is specified.
properties:
host:
description: 'Optional: Host name to connect
@@ -687,10 +686,10 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
@@ -698,29 +697,30 @@ spec:
type: object
type: object
livenessProbe:
- description: |-
- Periodic probe of container liveness.
- Container will be restarted if the probe fails.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Periodic probe of container liveness.
+ Container will be restarted if the probe fails. Cannot
+ be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to
+ execute inside the container, the working
+ directory for the command is root ('/') in
+ the container's filesystem. The command is
+ simply exec'd, it is not run inside a shell,
+ so traditional shell instructions ('|', etc)
+ won't work. To use a shell, you need to explicitly
+ call out to that shell. Exit status of 0 is
+ treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
format: int32
type: integer
@@ -734,12 +734,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
- (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ description: "Service is the name of the service
+ to place in the gRPC HealthCheckRequest (see
+ https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
+ \n If this is not specified, the default behavior
+ is defined by gRPC."
type: string
required:
- port
@@ -749,9 +748,9 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
description: Custom headers to set in the request.
@@ -761,9 +760,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name. This
+ will be canonicalized upon output, so
+ case-variant names will be understood
+ as the same header.
type: string
value:
description: The header field value
@@ -780,35 +780,34 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for the
+ probe to be considered successful after having
+ failed. Defaults to 1. Must be 1 for liveness
+ and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -823,59 +822,61 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod
+ needs to terminate gracefully upon probe failure.
+ The grace period is the duration in seconds after
+ the processes running in the pod are sent a termination
+ signal and the time when the processes are forcibly
+ halted with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value must
+ be non-negative integer. The value zero indicates
+ stop immediately via the kill signal (no opportunity
+ to shut down). This is a beta field and requires
+ enabling ProbeTerminationGracePeriod feature gate.
+ Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which the
+ probe times out. Defaults to 1 second. Minimum
+ value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
name:
- description: |-
- Name of the container specified as a DNS_LABEL.
+ description: Name of the container specified as a DNS_LABEL.
Each container in a pod must have a unique name (DNS_LABEL).
Cannot be updated.
type: string
ports:
- description: |-
- List of ports to expose from the container. Not specifying a port here
- DOES NOT prevent that port from being exposed. Any port which is
- listening on the default "0.0.0.0" address inside a container will be
- accessible from the network.
- Modifying this array with strategic merge patch may corrupt the data.
- For more information See https://github.com/kubernetes/kubernetes/issues/108255.
+ description: List of ports to expose from the container.
+ Not specifying a port here DOES NOT prevent that port
+ from being exposed. Any port which is listening on
+ the default "0.0.0.0" address inside a container will
+ be accessible from the network. Modifying this array
+ with strategic merge patch may corrupt the data. For
+ more information See https://github.com/kubernetes/kubernetes/issues/108255.
Cannot be updated.
items:
description: ContainerPort represents a network port
in a single container.
properties:
containerPort:
- description: |-
- Number of port to expose on the pod's IP address.
- This must be a valid port number, 0 < x < 65536.
+ description: Number of port to expose on the pod's
+ IP address. This must be a valid port number,
+ 0 < x < 65536.
format: int32
type: integer
hostIP:
@@ -883,24 +884,23 @@ spec:
port to.
type: string
hostPort:
- description: |-
- Number of port to expose on the host.
- If specified, this must be a valid port number, 0 < x < 65536.
- If HostNetwork is specified, this must match ContainerPort.
- Most containers do not need this.
+ description: Number of port to expose on the host.
+ If specified, this must be a valid port number,
+ 0 < x < 65536. If HostNetwork is specified,
+ this must match ContainerPort. Most containers
+ do not need this.
format: int32
type: integer
name:
- description: |-
- If specified, this must be an IANA_SVC_NAME and unique within the pod. Each
- named port in a pod must have a unique name. Name for the port that can be
- referred to by services.
+ description: If specified, this must be an IANA_SVC_NAME
+ and unique within the pod. Each named port in
+ a pod must have a unique name. Name for the
+ port that can be referred to by services.
type: string
protocol:
default: TCP
- description: |-
- Protocol for port. Must be UDP, TCP, or SCTP.
- Defaults to "TCP".
+ description: Protocol for port. Must be UDP, TCP,
+ or SCTP. Defaults to "TCP".
type: string
required:
- containerPort
@@ -911,29 +911,30 @@ spec:
- protocol
x-kubernetes-list-type: map
readinessProbe:
- description: |-
- Periodic probe of container service readiness.
- Container will be removed from service endpoints if the probe fails.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Periodic probe of container service readiness.
+ Container will be removed from service endpoints if
+ the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to
+ execute inside the container, the working
+ directory for the command is root ('/') in
+ the container's filesystem. The command is
+ simply exec'd, it is not run inside a shell,
+ so traditional shell instructions ('|', etc)
+ won't work. To use a shell, you need to explicitly
+ call out to that shell. Exit status of 0 is
+ treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
format: int32
type: integer
@@ -947,12 +948,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
- (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ description: "Service is the name of the service
+ to place in the gRPC HealthCheckRequest (see
+ https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
+ \n If this is not specified, the default behavior
+ is defined by gRPC."
type: string
required:
- port
@@ -962,9 +962,9 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
description: Custom headers to set in the request.
@@ -974,9 +974,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name. This
+ will be canonicalized upon output, so
+ case-variant names will be understood
+ as the same header.
type: string
value:
description: The header field value
@@ -993,35 +994,34 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for the
+ probe to be considered successful after having
+ failed. Defaults to 1. Must be 1 for liveness
+ and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -1036,33 +1036,36 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod
+ needs to terminate gracefully upon probe failure.
+ The grace period is the duration in seconds after
+ the processes running in the pod are sent a termination
+ signal and the time when the processes are forcibly
+ halted with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value must
+ be non-negative integer. The value zero indicates
+ stop immediately via the kill signal (no opportunity
+ to shut down). This is a beta field and requires
+ enabling ProbeTerminationGracePeriod feature gate.
+ Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which the
+ probe times out. Defaults to 1 second. Minimum
+ value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
@@ -1073,14 +1076,14 @@ spec:
resize policy for the container.
properties:
resourceName:
- description: |-
- Name of the resource to which this resource resize policy applies.
- Supported values: cpu, memory.
+ description: 'Name of the resource to which this
+ resource resize policy applies. Supported values:
+ cpu, memory.'
type: string
restartPolicy:
- description: |-
- Restart policy to apply when specified resource is resized.
- If not specified, it defaults to NotRequired.
+ description: Restart policy to apply when specified
+ resource is resized. If not specified, it defaults
+ to NotRequired.
type: string
required:
- resourceName
@@ -1089,31 +1092,25 @@ spec:
type: array
x-kubernetes-list-type: atomic
resources:
- description: |-
- Compute Resources required by this container.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Compute Resources required by this container.
+ Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
properties:
claims:
- description: |-
- Claims lists the names of resources, defined in spec.resourceClaims,
- that are used by this container.
-
-
- This is an alpha field and requires enabling the
- DynamicResourceAllocation feature gate.
-
-
- This field is immutable. It can only be set for containers.
+ description: "Claims lists the names of resources,
+ defined in spec.resourceClaims, that are used
+ by this container. \n This is an alpha field and
+ requires enabling the DynamicResourceAllocation
+ feature gate. \n This field is immutable. It can
+ only be set for containers."
items:
description: ResourceClaim references one entry
in PodSpec.ResourceClaims.
properties:
name:
- description: |-
- Name must match the name of one entry in pod.spec.resourceClaims of
- the Pod where this field is used. It makes that resource available
- inside a container.
+ description: Name must match the name of one
+ entry in pod.spec.resourceClaims of the
+ Pod where this field is used. It makes that
+ resource available inside a container.
type: string
required:
- name
@@ -1129,9 +1126,8 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Limits describes the maximum amount of compute resources allowed.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Limits describes the maximum amount
+ of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -1140,52 +1136,57 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Requests describes the minimum amount of compute resources required.
- If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
- otherwise to an implementation-defined value. Requests cannot exceed Limits.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Requests describes the minimum amount
+ of compute resources required. If Requests is
+ omitted for a container, it defaults to Limits
+ if that is explicitly specified, otherwise to
+ an implementation-defined value. Requests cannot
+ exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
restartPolicy:
- description: |-
- RestartPolicy defines the restart behavior of individual containers in a pod.
- This field may only be set for init containers, and the only allowed value is "Always".
- For non-init containers or when this field is not specified,
- the restart behavior is defined by the Pod's restart policy and the container type.
- Setting the RestartPolicy as "Always" for the init container will have the following effect:
- this init container will be continually restarted on
- exit until all regular containers have terminated. Once all regular
- containers have completed, all init containers with restartPolicy "Always"
- will be shut down. This lifecycle differs from normal init containers and
- is often referred to as a "sidecar" container. Although this init
- container still starts in the init container sequence, it does not wait
- for the container to complete before proceeding to the next init
- container. Instead, the next init container starts immediately after this
- init container is started, or after any startupProbe has successfully
- completed.
+ description: 'RestartPolicy defines the restart behavior
+ of individual containers in a pod. This field may
+ only be set for init containers, and the only allowed
+ value is "Always". For non-init containers or when
+ this field is not specified, the restart behavior
+ is defined by the Pod''s restart policy and the container
+ type. Setting the RestartPolicy as "Always" for the
+ init container will have the following effect: this
+ init container will be continually restarted on exit
+ until all regular containers have terminated. Once
+ all regular containers have completed, all init containers
+ with restartPolicy "Always" will be shut down. This
+ lifecycle differs from normal init containers and
+ is often referred to as a "sidecar" container. Although
+ this init container still starts in the init container
+ sequence, it does not wait for the container to complete
+ before proceeding to the next init container. Instead,
+ the next init container starts immediately after this
+ init container is started, or after any startupProbe
+ has successfully completed.'
type: string
securityContext:
- description: |-
- SecurityContext defines the security options the container should be run with.
- If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
- More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
+ description: 'SecurityContext defines the security options
+ the container should be run with. If set, the fields
+ of SecurityContext override the equivalent fields
+ of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
properties:
allowPrivilegeEscalation:
- description: |-
- AllowPrivilegeEscalation controls whether a process can gain more
- privileges than its parent process. This bool directly controls if
- the no_new_privs flag will be set on the container process.
- AllowPrivilegeEscalation is true always when the container is:
- 1) run as Privileged
- 2) has CAP_SYS_ADMIN
- Note that this field cannot be set when spec.os.name is windows.
+ description: 'AllowPrivilegeEscalation controls
+ whether a process can gain more privileges than
+ its parent process. This bool directly controls
+ if the no_new_privs flag will be set on the container
+ process. AllowPrivilegeEscalation is true always
+ when the container is: 1) run as Privileged 2)
+ has CAP_SYS_ADMIN Note that this field cannot
+ be set when spec.os.name is windows.'
type: boolean
capabilities:
- description: |-
- The capabilities to add/drop when running containers.
- Defaults to the default set of capabilities granted by the container runtime.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The capabilities to add/drop when running
+ containers. Defaults to the default set of capabilities
+ granted by the container runtime. Note that this
+ field cannot be set when spec.os.name is windows.
properties:
add:
description: Added capabilities
@@ -1203,60 +1204,66 @@ spec:
type: array
type: object
privileged:
- description: |-
- Run container in privileged mode.
- Processes in privileged containers are essentially equivalent to root on the host.
- Defaults to false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Run container in privileged mode. Processes
+ in privileged containers are essentially equivalent
+ to root on the host. Defaults to false. Note that
+ this field cannot be set when spec.os.name is
+ windows.
type: boolean
procMount:
- description: |-
- procMount denotes the type of proc mount to use for the containers.
- The default is DefaultProcMount which uses the container runtime defaults for
- readonly paths and masked paths.
- This requires the ProcMountType feature flag to be enabled.
- Note that this field cannot be set when spec.os.name is windows.
+ description: procMount denotes the type of proc
+ mount to use for the containers. The default is
+ DefaultProcMount which uses the container runtime
+ defaults for readonly paths and masked paths.
+ This requires the ProcMountType feature flag to
+ be enabled. Note that this field cannot be set
+ when spec.os.name is windows.
type: string
readOnlyRootFilesystem:
- description: |-
- Whether this container has a read-only root filesystem.
- Default is false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Whether this container has a read-only
+ root filesystem. Default is false. Note that this
+ field cannot be set when spec.os.name is windows.
type: boolean
runAsGroup:
- description: |-
- The GID to run the entrypoint of the container process.
- Uses runtime default if unset.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The GID to run the entrypoint of the
+ container process. Uses runtime default if unset.
+ May also be set in PodSecurityContext. If set
+ in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence.
+ Note that this field cannot be set when spec.os.name
+ is windows.
format: int64
type: integer
runAsNonRoot:
- description: |-
- Indicates that the container must run as a non-root user.
- If true, the Kubelet will validate the image at runtime to ensure that it
- does not run as UID 0 (root) and fail to start the container if it does.
- If unset or false, no such validation will be performed.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: Indicates that the container must run
+ as a non-root user. If true, the Kubelet will
+ validate the image at runtime to ensure that it
+ does not run as UID 0 (root) and fail to start
+ the container if it does. If unset or false, no
+ such validation will be performed. May also be
+ set in PodSecurityContext. If set in both SecurityContext
+ and PodSecurityContext, the value specified in
+ SecurityContext takes precedence.
type: boolean
runAsUser:
- description: |-
- The UID to run the entrypoint of the container process.
- Defaults to user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The UID to run the entrypoint of the
+ container process. Defaults to user specified
+ in image metadata if unspecified. May also be
+ set in PodSecurityContext. If set in both SecurityContext
+ and PodSecurityContext, the value specified in
+ SecurityContext takes precedence. Note that this
+ field cannot be set when spec.os.name is windows.
format: int64
type: integer
seLinuxOptions:
- description: |-
- The SELinux context to be applied to the container.
- If unspecified, the container runtime will allocate a random SELinux context for each
- container. May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The SELinux context to be applied to
+ the container. If unspecified, the container runtime
+ will allocate a random SELinux context for each
+ container. May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence.
+ Note that this field cannot be set when spec.os.name
+ is windows.
properties:
level:
description: Level is SELinux level label that
@@ -1276,92 +1283,104 @@ spec:
type: string
type: object
seccompProfile:
- description: |-
- The seccomp options to use by this container. If seccomp options are
- provided at both the pod & container level, the container options
- override the pod options.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The seccomp options to use by this
+ container. If seccomp options are provided at
+ both the pod & container level, the container
+ options override the pod options. Note that this
+ field cannot be set when spec.os.name is windows.
properties:
localhostProfile:
- description: |-
- localhostProfile indicates a profile defined in a file on the node should be used.
- The profile must be preconfigured on the node to work.
- Must be a descending path, relative to the kubelet's configured seccomp profile location.
- Must be set if type is "Localhost". Must NOT be set for any other type.
+ description: localhostProfile indicates a profile
+ defined in a file on the node should be used.
+ The profile must be preconfigured on the node
+ to work. Must be a descending path, relative
+ to the kubelet's configured seccomp profile
+ location. Must be set if type is "Localhost".
+ Must NOT be set for any other type.
type: string
type:
- description: |-
- type indicates which kind of seccomp profile will be applied.
- Valid options are:
-
-
- Localhost - a profile defined in a file on the node should be used.
- RuntimeDefault - the container runtime default profile should be used.
- Unconfined - no profile should be applied.
+ description: "type indicates which kind of seccomp
+ profile will be applied. Valid options are:
+ \n Localhost - a profile defined in a file
+ on the node should be used. RuntimeDefault
+ - the container runtime default profile should
+ be used. Unconfined - no profile should be
+ applied."
type: string
required:
- type
type: object
windowsOptions:
- description: |-
- The Windows specific settings applied to all containers.
- If unspecified, the options from the PodSecurityContext will be used.
- If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is linux.
+ description: The Windows specific settings applied
+ to all containers. If unspecified, the options
+ from the PodSecurityContext will be used. If set
+ in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence.
+ Note that this field cannot be set when spec.os.name
+ is linux.
properties:
gmsaCredentialSpec:
- description: |-
- GMSACredentialSpec is where the GMSA admission webhook
- (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
- GMSA credential spec named by the GMSACredentialSpecName field.
+ description: GMSACredentialSpec is where the
+ GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa)
+ inlines the contents of the GMSA credential
+ spec named by the GMSACredentialSpecName field.
type: string
gmsaCredentialSpecName:
description: GMSACredentialSpecName is the name
of the GMSA credential spec to use.
type: string
hostProcess:
- description: |-
- HostProcess determines if a container should be run as a 'Host Process' container.
- All of a Pod's containers must have the same effective HostProcess value
- (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
- In addition, if HostProcess is true then HostNetwork must also be set to true.
+ description: HostProcess determines if a container
+ should be run as a 'Host Process' container.
+ All of a Pod's containers must have the same
+ effective HostProcess value (it is not allowed
+ to have a mix of HostProcess containers and
+ non-HostProcess containers). In addition,
+ if HostProcess is true then HostNetwork must
+ also be set to true.
type: boolean
runAsUserName:
- description: |-
- The UserName in Windows to run the entrypoint of the container process.
- Defaults to the user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: The UserName in Windows to run
+ the entrypoint of the container process. Defaults
+ to the user specified in image metadata if
+ unspecified. May also be set in PodSecurityContext.
+ If set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence.
type: string
type: object
type: object
startupProbe:
- description: |-
- StartupProbe indicates that the Pod has successfully initialized.
- If specified, no other probes are executed until this completes successfully.
- If this probe fails, the Pod will be restarted, just as if the livenessProbe failed.
- This can be used to provide different probe parameters at the beginning of a Pod's lifecycle,
- when it might take a long time to load data or warm a cache, than during steady-state operation.
- This cannot be updated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'StartupProbe indicates that the Pod has
+ successfully initialized. If specified, no other probes
+ are executed until this completes successfully. If
+ this probe fails, the Pod will be restarted, just
+ as if the livenessProbe failed. This can be used to
+ provide different probe parameters at the beginning
+ of a Pod''s lifecycle, when it might take a long time
+ to load data or warm a cache, than during steady-state
+ operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to
+ execute inside the container, the working
+ directory for the command is root ('/') in
+ the container's filesystem. The command is
+ simply exec'd, it is not run inside a shell,
+ so traditional shell instructions ('|', etc)
+ won't work. To use a shell, you need to explicitly
+ call out to that shell. Exit status of 0 is
+ treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
format: int32
type: integer
@@ -1375,12 +1394,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
- (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ description: "Service is the name of the service
+ to place in the gRPC HealthCheckRequest (see
+ https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
+ \n If this is not specified, the default behavior
+ is defined by gRPC."
type: string
required:
- port
@@ -1390,9 +1408,9 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
description: Custom headers to set in the request.
@@ -1402,9 +1420,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name. This
+ will be canonicalized upon output, so
+ case-variant names will be understood
+ as the same header.
type: string
value:
description: The header field value
@@ -1421,35 +1440,34 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for the
+ probe to be considered successful after having
+ failed. Defaults to 1. Must be 1 for liveness
+ and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -1464,75 +1482,83 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod
+ needs to terminate gracefully upon probe failure.
+ The grace period is the duration in seconds after
+ the processes running in the pod are sent a termination
+ signal and the time when the processes are forcibly
+ halted with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value must
+ be non-negative integer. The value zero indicates
+ stop immediately via the kill signal (no opportunity
+ to shut down). This is a beta field and requires
+ enabling ProbeTerminationGracePeriod feature gate.
+ Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which the
+ probe times out. Defaults to 1 second. Minimum
+ value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
stdin:
- description: |-
- Whether this container should allocate a buffer for stdin in the container runtime. If this
- is not set, reads from stdin in the container will always result in EOF.
- Default is false.
+ description: Whether this container should allocate
+ a buffer for stdin in the container runtime. If this
+ is not set, reads from stdin in the container will
+ always result in EOF. Default is false.
type: boolean
stdinOnce:
- description: |-
- Whether the container runtime should close the stdin channel after it has been opened by
- a single attach. When stdin is true the stdin stream will remain open across multiple attach
- sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
- first client attaches to stdin, and then remains open and accepts data until the client disconnects,
- at which time stdin is closed and remains closed until the container is restarted. If this
- flag is false, a container processes that reads from stdin will never receive an EOF.
- Default is false
+ description: Whether the container runtime should close
+ the stdin channel after it has been opened by a single
+ attach. When stdin is true the stdin stream will remain
+ open across multiple attach sessions. If stdinOnce
+ is set to true, stdin is opened on container start,
+ is empty until the first client attaches to stdin,
+ and then remains open and accepts data until the client
+ disconnects, at which time stdin is closed and remains
+ closed until the container is restarted. If this flag
+ is false, a container processes that reads from stdin
+ will never receive an EOF. Default is false
type: boolean
terminationMessagePath:
- description: |-
- Optional: Path at which the file to which the container's termination message
- will be written is mounted into the container's filesystem.
- Message written is intended to be brief final status, such as an assertion failure message.
- Will be truncated by the node if greater than 4096 bytes. The total message length across
- all containers will be limited to 12kb.
- Defaults to /dev/termination-log.
- Cannot be updated.
+ description: 'Optional: Path at which the file to which
+ the container''s termination message will be written
+ is mounted into the container''s filesystem. Message
+ written is intended to be brief final status, such
+ as an assertion failure message. Will be truncated
+ by the node if greater than 4096 bytes. The total
+ message length across all containers will be limited
+ to 12kb. Defaults to /dev/termination-log. Cannot
+ be updated.'
type: string
terminationMessagePolicy:
- description: |-
- Indicate how the termination message should be populated. File will use the contents of
- terminationMessagePath to populate the container status message on both success and failure.
- FallbackToLogsOnError will use the last chunk of container log output if the termination
- message file is empty and the container exited with an error.
- The log output is limited to 2048 bytes or 80 lines, whichever is smaller.
- Defaults to File.
- Cannot be updated.
+ description: Indicate how the termination message should
+ be populated. File will use the contents of terminationMessagePath
+ to populate the container status message on both success
+ and failure. FallbackToLogsOnError will use the last
+ chunk of container log output if the termination message
+ file is empty and the container exited with an error.
+ The log output is limited to 2048 bytes or 80 lines,
+ whichever is smaller. Defaults to File. Cannot be
+ updated.
type: string
tty:
- description: |-
- Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
+ description: Whether this container should allocate
+ a TTY for itself, also requires 'stdin' to be true.
Default is false.
type: boolean
volumeDevices:
@@ -1557,44 +1583,44 @@ spec:
type: object
type: array
volumeMounts:
- description: |-
- Pod volumes to mount into the container's filesystem.
- Cannot be updated.
+ description: Pod volumes to mount into the container's
+ filesystem. Cannot be updated.
items:
description: VolumeMount describes a mounting of a
Volume within a container.
properties:
mountPath:
- description: |-
- Path within the container at which the volume should be mounted. Must
- not contain ':'.
+ description: Path within the container at which
+ the volume should be mounted. Must not contain
+ ':'.
type: string
mountPropagation:
- description: |-
- mountPropagation determines how mounts are propagated from the host
- to container and the other way around.
- When not set, MountPropagationNone is used.
- This field is beta in 1.10.
+ description: mountPropagation determines how mounts
+ are propagated from the host to container and
+ the other way around. When not set, MountPropagationNone
+ is used. This field is beta in 1.10.
type: string
name:
description: This must match the Name of a Volume.
type: string
readOnly:
- description: |-
- Mounted read-only if true, read-write otherwise (false or unspecified).
- Defaults to false.
+ description: Mounted read-only if true, read-write
+ otherwise (false or unspecified). Defaults to
+ false.
type: boolean
subPath:
- description: |-
- Path within the volume from which the container's volume should be mounted.
- Defaults to "" (volume's root).
+ description: Path within the volume from which
+ the container's volume should be mounted. Defaults
+ to "" (volume's root).
type: string
subPathExpr:
- description: |-
- Expanded path within the volume from which the container's volume should be mounted.
- Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.
- Defaults to "" (volume's root).
- SubPathExpr and SubPath are mutually exclusive.
+ description: Expanded path within the volume from
+ which the container's volume should be mounted.
+ Behaves similarly to SubPath but environment
+ variable references $(VAR_NAME) are expanded
+ using the container's environment. Defaults
+ to "" (volume's root). SubPathExpr and SubPath
+ are mutually exclusive.
type: string
required:
- mountPath
@@ -1602,11 +1628,10 @@ spec:
type: object
type: array
workingDir:
- description: |-
- Container's working directory.
- If not specified, the container runtime's default will be used, which
- might be configured in the container image.
- Cannot be updated.
+ description: Container's working directory. If not specified,
+ the container runtime's default will be used, which
+ might be configured in the container image. Cannot
+ be updated.
type: string
required:
- name
@@ -1618,47 +1643,50 @@ spec:
ephemeralContainers:
description: EphemeralContainers
items:
- description: |-
- An EphemeralContainer is a temporary container that you may add to an existing Pod for
- user-initiated activities such as debugging. Ephemeral containers have no resource or
- scheduling guarantees, and they will not be restarted when they exit or when a Pod is
- removed or restarted. The kubelet may evict a Pod if an ephemeral container causes the
- Pod to exceed its resource allocation.
-
-
- To add an ephemeral container, use the ephemeralcontainers subresource of an existing
- Pod. Ephemeral containers may not be removed or restarted.
+ description: "An EphemeralContainer is a temporary container
+ that you may add to an existing Pod for user-initiated
+ activities such as debugging. Ephemeral containers have
+ no resource or scheduling guarantees, and they will not
+ be restarted when they exit or when a Pod is removed or
+ restarted. The kubelet may evict a Pod if an ephemeral
+ container causes the Pod to exceed its resource allocation.
+ \n To add an ephemeral container, use the ephemeralcontainers
+ subresource of an existing Pod. Ephemeral containers may
+ not be removed or restarted."
properties:
args:
- description: |-
- Arguments to the entrypoint.
- The image's CMD is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Arguments to the entrypoint. The image''s
+ CMD is used if this is not provided. Variable references
+ $(VAR_NAME) are expanded using the container''s environment.
+ If a variable cannot be resolved, the reference in
+ the input string will be unchanged. Double $$ are
+ reduced to a single $, which allows for escaping the
+ $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce
+ the string literal "$(VAR_NAME)". Escaped references
+ will never be expanded, regardless of whether the
+ variable exists or not. Cannot be updated. More info:
+ https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
command:
- description: |-
- Entrypoint array. Not executed within a shell.
- The image's ENTRYPOINT is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Entrypoint array. Not executed within
+ a shell. The image''s ENTRYPOINT is used if this is
+ not provided. Variable references $(VAR_NAME) are
+ expanded using the container''s environment. If a
+ variable cannot be resolved, the reference in the
+ input string will be unchanged. Double $$ are reduced
+ to a single $, which allows for escaping the $(VAR_NAME)
+ syntax: i.e. "$$(VAR_NAME)" will produce the string
+ literal "$(VAR_NAME)". Escaped references will never
+ be expanded, regardless of whether the variable exists
+ or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
env:
- description: |-
- List of environment variables to set in the container.
- Cannot be updated.
+ description: List of environment variables to set in
+ the container. Cannot be updated.
items:
description: EnvVar represents an environment variable
present in a Container.
@@ -1668,16 +1696,17 @@ spec:
Must be a C_IDENTIFIER.
type: string
value:
- description: |-
- Variable references $(VAR_NAME) are expanded
- using the previously defined environment variables in the container and
- any service environment variables. If a variable cannot be resolved,
- the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
- "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
- Escaped references will never be expanded, regardless of whether the variable
- exists or not.
- Defaults to "".
+ description: 'Variable references $(VAR_NAME)
+ are expanded using the previously defined environment
+ variables in the container and any service environment
+ variables. If a variable cannot be resolved,
+ the reference in the input string will be unchanged.
+ Double $$ are reduced to a single $, which allows
+ for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)"
+ will produce the string literal "$(VAR_NAME)".
+ Escaped references will never be expanded, regardless
+ of whether the variable exists or not. Defaults
+ to "".'
type: string
valueFrom:
description: Source for the environment variable's
@@ -1690,10 +1719,10 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
@@ -1702,11 +1731,12 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
fieldRef:
- description: |-
- Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`,
- spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ description: 'Selects a field of the pod:
+ supports metadata.name, metadata.namespace,
+ `metadata.labels['''']`, `metadata.annotations['''']`,
+ spec.nodeName, spec.serviceAccountName,
+ status.hostIP, status.podIP, status.podIPs.'
properties:
apiVersion:
description: Version of the schema the
@@ -1720,11 +1750,12 @@ spec:
required:
- fieldPath
type: object
- x-kubernetes-map-type: atomic
resourceFieldRef:
- description: |-
- Selects a resource of the container: only resources limits and requests
- (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
+ description: 'Selects a resource of the container:
+ only resources limits and requests (limits.cpu,
+ limits.memory, limits.ephemeral-storage,
+ requests.cpu, requests.memory and requests.ephemeral-storage)
+ are currently supported.'
properties:
containerName:
description: 'Container name: required
@@ -1745,7 +1776,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret in
the pod's namespace
@@ -1756,10 +1786,10 @@ spec:
key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret
@@ -1768,20 +1798,20 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
required:
- name
type: object
type: array
envFrom:
- description: |-
- List of sources to populate environment variables in the container.
- The keys defined within a source must be a C_IDENTIFIER. All invalid keys
- will be reported as an event when the container is starting. When a key exists in multiple
- sources, the value associated with the last source will take precedence.
- Values defined by an Env with a duplicate key will take precedence.
- Cannot be updated.
+ description: List of sources to populate environment
+ variables in the container. The keys defined within
+ a source must be a C_IDENTIFIER. All invalid keys
+ will be reported as an event when the container is
+ starting. When a key exists in multiple sources, the
+ value associated with the last source will take precedence.
+ Values defined by an Env with a duplicate key will
+ take precedence. Cannot be updated.
items:
description: EnvFromSource represents the source of
a set of ConfigMaps
@@ -1790,17 +1820,16 @@ spec:
description: The ConfigMap to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
prefix:
description: An optional identifier to prepend
to each key in the ConfigMap. Must be a C_IDENTIFIER.
@@ -1809,53 +1838,53 @@ spec:
description: The Secret to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret must
be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
image:
- description: |-
- Container image name.
- More info: https://kubernetes.io/docs/concepts/containers/images
+ description: 'Container image name. More info: https://kubernetes.io/docs/concepts/containers/images'
type: string
imagePullPolicy:
- description: |-
- Image pull policy.
- One of Always, Never, IfNotPresent.
- Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
+ description: 'Image pull policy. One of Always, Never,
+ IfNotPresent. Defaults to Always if :latest tag is
+ specified, or IfNotPresent otherwise. Cannot be updated.
+ More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
description: Lifecycle is not allowed for ephemeral
containers.
properties:
postStart:
- description: |-
- PostStart is called immediately after a container is created. If the handler fails,
- the container is terminated and restarted according to its restart policy.
- Other management of the container blocks until the hook completes.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PostStart is called immediately after
+ a container is created. If the handler fails,
+ the container is terminated and restarted according
+ to its restart policy. Other management of the
+ container blocks until the hook completes. More
+ info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
@@ -1865,8 +1894,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -1877,9 +1906,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -1897,15 +1927,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -1923,10 +1952,11 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT supported
+ as a LifecycleHandler and kept for the backward
+ compatibility. There are no validation of
+ this field and lifecycle hooks will fail in
+ runtime when tcp handler is specified.
properties:
host:
description: 'Optional: Host name to connect
@@ -1936,37 +1966,44 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
preStop:
- description: |-
- PreStop is called immediately before a container is terminated due to an
- API request or management event such as liveness/startup probe failure,
- preemption, resource contention, etc. The handler is not called if the
- container crashes or exits. The Pod's termination grace period countdown begins before the
- PreStop hook is executed. Regardless of the outcome of the handler, the
- container will eventually terminate within the Pod's termination grace
- period (unless delayed by finalizers). Other management of the container blocks until the hook completes
- or until the termination grace period is reached.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PreStop is called immediately before
+ a container is terminated due to an API request
+ or management event such as liveness/startup probe
+ failure, preemption, resource contention, etc.
+ The handler is not called if the container crashes
+ or exits. The Pod''s termination grace period
+ countdown begins before the PreStop hook is executed.
+ Regardless of the outcome of the handler, the
+ container will eventually terminate within the
+ Pod''s termination grace period (unless delayed
+ by finalizers). Other management of the container
+ blocks until the hook completes or until the termination
+ grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
@@ -1976,8 +2013,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -1988,9 +2025,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -2008,15 +2046,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -2034,10 +2071,11 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT supported
+ as a LifecycleHandler and kept for the backward
+ compatibility. There are no validation of
+ this field and lifecycle hooks will fail in
+ runtime when tcp handler is specified.
properties:
host:
description: 'Optional: Host name to connect
@@ -2047,10 +2085,10 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
@@ -2064,19 +2102,22 @@ spec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to
+ execute inside the container, the working
+ directory for the command is root ('/') in
+ the container's filesystem. The command is
+ simply exec'd, it is not run inside a shell,
+ so traditional shell instructions ('|', etc)
+ won't work. To use a shell, you need to explicitly
+ call out to that shell. Exit status of 0 is
+ treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
format: int32
type: integer
@@ -2090,12 +2131,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
- (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ description: "Service is the name of the service
+ to place in the gRPC HealthCheckRequest (see
+ https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
+ \n If this is not specified, the default behavior
+ is defined by gRPC."
type: string
required:
- port
@@ -2105,9 +2145,9 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
description: Custom headers to set in the request.
@@ -2117,9 +2157,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name. This
+ will be canonicalized upon output, so
+ case-variant names will be understood
+ as the same header.
type: string
value:
description: The header field value
@@ -2136,35 +2177,34 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for the
+ probe to be considered successful after having
+ failed. Defaults to 1. Must be 1 for liveness
+ and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -2179,40 +2219,43 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod
+ needs to terminate gracefully upon probe failure.
+ The grace period is the duration in seconds after
+ the processes running in the pod are sent a termination
+ signal and the time when the processes are forcibly
+ halted with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value must
+ be non-negative integer. The value zero indicates
+ stop immediately via the kill signal (no opportunity
+ to shut down). This is a beta field and requires
+ enabling ProbeTerminationGracePeriod feature gate.
+ Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which the
+ probe times out. Defaults to 1 second. Minimum
+ value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
name:
- description: |-
- Name of the ephemeral container specified as a DNS_LABEL.
- This name must be unique among all containers, init containers and ephemeral containers.
+ description: Name of the ephemeral container specified
+ as a DNS_LABEL. This name must be unique among all
+ containers, init containers and ephemeral containers.
type: string
ports:
description: Ports are not allowed for ephemeral containers.
@@ -2221,9 +2264,9 @@ spec:
in a single container.
properties:
containerPort:
- description: |-
- Number of port to expose on the pod's IP address.
- This must be a valid port number, 0 < x < 65536.
+ description: Number of port to expose on the pod's
+ IP address. This must be a valid port number,
+ 0 < x < 65536.
format: int32
type: integer
hostIP:
@@ -2231,24 +2274,23 @@ spec:
port to.
type: string
hostPort:
- description: |-
- Number of port to expose on the host.
- If specified, this must be a valid port number, 0 < x < 65536.
- If HostNetwork is specified, this must match ContainerPort.
- Most containers do not need this.
+ description: Number of port to expose on the host.
+ If specified, this must be a valid port number,
+ 0 < x < 65536. If HostNetwork is specified,
+ this must match ContainerPort. Most containers
+ do not need this.
format: int32
type: integer
name:
- description: |-
- If specified, this must be an IANA_SVC_NAME and unique within the pod. Each
- named port in a pod must have a unique name. Name for the port that can be
- referred to by services.
+ description: If specified, this must be an IANA_SVC_NAME
+ and unique within the pod. Each named port in
+ a pod must have a unique name. Name for the
+ port that can be referred to by services.
type: string
protocol:
default: TCP
- description: |-
- Protocol for port. Must be UDP, TCP, or SCTP.
- Defaults to "TCP".
+ description: Protocol for port. Must be UDP, TCP,
+ or SCTP. Defaults to "TCP".
type: string
required:
- containerPort
@@ -2265,19 +2307,22 @@ spec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to
+ execute inside the container, the working
+ directory for the command is root ('/') in
+ the container's filesystem. The command is
+ simply exec'd, it is not run inside a shell,
+ so traditional shell instructions ('|', etc)
+ won't work. To use a shell, you need to explicitly
+ call out to that shell. Exit status of 0 is
+ treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
format: int32
type: integer
@@ -2291,12 +2336,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
- (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ description: "Service is the name of the service
+ to place in the gRPC HealthCheckRequest (see
+ https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
+ \n If this is not specified, the default behavior
+ is defined by gRPC."
type: string
required:
- port
@@ -2306,9 +2350,9 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
description: Custom headers to set in the request.
@@ -2318,9 +2362,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name. This
+ will be canonicalized upon output, so
+ case-variant names will be understood
+ as the same header.
type: string
value:
description: The header field value
@@ -2337,35 +2382,34 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for the
+ probe to be considered successful after having
+ failed. Defaults to 1. Must be 1 for liveness
+ and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -2380,33 +2424,36 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod
+ needs to terminate gracefully upon probe failure.
+ The grace period is the duration in seconds after
+ the processes running in the pod are sent a termination
+ signal and the time when the processes are forcibly
+ halted with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value must
+ be non-negative integer. The value zero indicates
+ stop immediately via the kill signal (no opportunity
+ to shut down). This is a beta field and requires
+ enabling ProbeTerminationGracePeriod feature gate.
+ Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which the
+ probe times out. Defaults to 1 second. Minimum
+ value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
@@ -2417,14 +2464,14 @@ spec:
resize policy for the container.
properties:
resourceName:
- description: |-
- Name of the resource to which this resource resize policy applies.
- Supported values: cpu, memory.
+ description: 'Name of the resource to which this
+ resource resize policy applies. Supported values:
+ cpu, memory.'
type: string
restartPolicy:
- description: |-
- Restart policy to apply when specified resource is resized.
- If not specified, it defaults to NotRequired.
+ description: Restart policy to apply when specified
+ resource is resized. If not specified, it defaults
+ to NotRequired.
type: string
required:
- resourceName
@@ -2433,30 +2480,26 @@ spec:
type: array
x-kubernetes-list-type: atomic
resources:
- description: |-
- Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources
+ description: Resources are not allowed for ephemeral
+ containers. Ephemeral containers use spare resources
already allocated to the pod.
properties:
claims:
- description: |-
- Claims lists the names of resources, defined in spec.resourceClaims,
- that are used by this container.
-
-
- This is an alpha field and requires enabling the
- DynamicResourceAllocation feature gate.
-
-
- This field is immutable. It can only be set for containers.
+ description: "Claims lists the names of resources,
+ defined in spec.resourceClaims, that are used
+ by this container. \n This is an alpha field and
+ requires enabling the DynamicResourceAllocation
+ feature gate. \n This field is immutable. It can
+ only be set for containers."
items:
description: ResourceClaim references one entry
in PodSpec.ResourceClaims.
properties:
name:
- description: |-
- Name must match the name of one entry in pod.spec.resourceClaims of
- the Pod where this field is used. It makes that resource available
- inside a container.
+ description: Name must match the name of one
+ entry in pod.spec.resourceClaims of the
+ Pod where this field is used. It makes that
+ resource available inside a container.
type: string
required:
- name
@@ -2472,9 +2515,8 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Limits describes the maximum amount of compute resources allowed.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Limits describes the maximum amount
+ of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -2483,40 +2525,41 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Requests describes the minimum amount of compute resources required.
- If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
- otherwise to an implementation-defined value. Requests cannot exceed Limits.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Requests describes the minimum amount
+ of compute resources required. If Requests is
+ omitted for a container, it defaults to Limits
+ if that is explicitly specified, otherwise to
+ an implementation-defined value. Requests cannot
+ exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
restartPolicy:
- description: |-
- Restart policy for the container to manage the restart behavior of each
- container within a pod.
- This may only be set for init containers. You cannot set this field on
- ephemeral containers.
+ description: Restart policy for the container to manage
+ the restart behavior of each container within a pod.
+ This may only be set for init containers. You cannot
+ set this field on ephemeral containers.
type: string
securityContext:
- description: |-
- Optional: SecurityContext defines the security options the ephemeral container should be run with.
- If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
+ description: 'Optional: SecurityContext defines the
+ security options the ephemeral container should be
+ run with. If set, the fields of SecurityContext override
+ the equivalent fields of PodSecurityContext.'
properties:
allowPrivilegeEscalation:
- description: |-
- AllowPrivilegeEscalation controls whether a process can gain more
- privileges than its parent process. This bool directly controls if
- the no_new_privs flag will be set on the container process.
- AllowPrivilegeEscalation is true always when the container is:
- 1) run as Privileged
- 2) has CAP_SYS_ADMIN
- Note that this field cannot be set when spec.os.name is windows.
+ description: 'AllowPrivilegeEscalation controls
+ whether a process can gain more privileges than
+ its parent process. This bool directly controls
+ if the no_new_privs flag will be set on the container
+ process. AllowPrivilegeEscalation is true always
+ when the container is: 1) run as Privileged 2)
+ has CAP_SYS_ADMIN Note that this field cannot
+ be set when spec.os.name is windows.'
type: boolean
capabilities:
- description: |-
- The capabilities to add/drop when running containers.
- Defaults to the default set of capabilities granted by the container runtime.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The capabilities to add/drop when running
+ containers. Defaults to the default set of capabilities
+ granted by the container runtime. Note that this
+ field cannot be set when spec.os.name is windows.
properties:
add:
description: Added capabilities
@@ -2534,60 +2577,66 @@ spec:
type: array
type: object
privileged:
- description: |-
- Run container in privileged mode.
- Processes in privileged containers are essentially equivalent to root on the host.
- Defaults to false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Run container in privileged mode. Processes
+ in privileged containers are essentially equivalent
+ to root on the host. Defaults to false. Note that
+ this field cannot be set when spec.os.name is
+ windows.
type: boolean
procMount:
- description: |-
- procMount denotes the type of proc mount to use for the containers.
- The default is DefaultProcMount which uses the container runtime defaults for
- readonly paths and masked paths.
- This requires the ProcMountType feature flag to be enabled.
- Note that this field cannot be set when spec.os.name is windows.
+ description: procMount denotes the type of proc
+ mount to use for the containers. The default is
+ DefaultProcMount which uses the container runtime
+ defaults for readonly paths and masked paths.
+ This requires the ProcMountType feature flag to
+ be enabled. Note that this field cannot be set
+ when spec.os.name is windows.
type: string
readOnlyRootFilesystem:
- description: |-
- Whether this container has a read-only root filesystem.
- Default is false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Whether this container has a read-only
+ root filesystem. Default is false. Note that this
+ field cannot be set when spec.os.name is windows.
type: boolean
runAsGroup:
- description: |-
- The GID to run the entrypoint of the container process.
- Uses runtime default if unset.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The GID to run the entrypoint of the
+ container process. Uses runtime default if unset.
+ May also be set in PodSecurityContext. If set
+ in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence.
+ Note that this field cannot be set when spec.os.name
+ is windows.
format: int64
type: integer
runAsNonRoot:
- description: |-
- Indicates that the container must run as a non-root user.
- If true, the Kubelet will validate the image at runtime to ensure that it
- does not run as UID 0 (root) and fail to start the container if it does.
- If unset or false, no such validation will be performed.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: Indicates that the container must run
+ as a non-root user. If true, the Kubelet will
+ validate the image at runtime to ensure that it
+ does not run as UID 0 (root) and fail to start
+ the container if it does. If unset or false, no
+ such validation will be performed. May also be
+ set in PodSecurityContext. If set in both SecurityContext
+ and PodSecurityContext, the value specified in
+ SecurityContext takes precedence.
type: boolean
runAsUser:
- description: |-
- The UID to run the entrypoint of the container process.
- Defaults to user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The UID to run the entrypoint of the
+ container process. Defaults to user specified
+ in image metadata if unspecified. May also be
+ set in PodSecurityContext. If set in both SecurityContext
+ and PodSecurityContext, the value specified in
+ SecurityContext takes precedence. Note that this
+ field cannot be set when spec.os.name is windows.
format: int64
type: integer
seLinuxOptions:
- description: |-
- The SELinux context to be applied to the container.
- If unspecified, the container runtime will allocate a random SELinux context for each
- container. May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The SELinux context to be applied to
+ the container. If unspecified, the container runtime
+ will allocate a random SELinux context for each
+ container. May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence.
+ Note that this field cannot be set when spec.os.name
+ is windows.
properties:
level:
description: Level is SELinux level label that
@@ -2607,62 +2656,70 @@ spec:
type: string
type: object
seccompProfile:
- description: |-
- The seccomp options to use by this container. If seccomp options are
- provided at both the pod & container level, the container options
- override the pod options.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The seccomp options to use by this
+ container. If seccomp options are provided at
+ both the pod & container level, the container
+ options override the pod options. Note that this
+ field cannot be set when spec.os.name is windows.
properties:
localhostProfile:
- description: |-
- localhostProfile indicates a profile defined in a file on the node should be used.
- The profile must be preconfigured on the node to work.
- Must be a descending path, relative to the kubelet's configured seccomp profile location.
- Must be set if type is "Localhost". Must NOT be set for any other type.
+ description: localhostProfile indicates a profile
+ defined in a file on the node should be used.
+ The profile must be preconfigured on the node
+ to work. Must be a descending path, relative
+ to the kubelet's configured seccomp profile
+ location. Must be set if type is "Localhost".
+ Must NOT be set for any other type.
type: string
type:
- description: |-
- type indicates which kind of seccomp profile will be applied.
- Valid options are:
-
-
- Localhost - a profile defined in a file on the node should be used.
- RuntimeDefault - the container runtime default profile should be used.
- Unconfined - no profile should be applied.
+ description: "type indicates which kind of seccomp
+ profile will be applied. Valid options are:
+ \n Localhost - a profile defined in a file
+ on the node should be used. RuntimeDefault
+ - the container runtime default profile should
+ be used. Unconfined - no profile should be
+ applied."
type: string
required:
- type
type: object
windowsOptions:
- description: |-
- The Windows specific settings applied to all containers.
- If unspecified, the options from the PodSecurityContext will be used.
- If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is linux.
+ description: The Windows specific settings applied
+ to all containers. If unspecified, the options
+ from the PodSecurityContext will be used. If set
+ in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence.
+ Note that this field cannot be set when spec.os.name
+ is linux.
properties:
gmsaCredentialSpec:
- description: |-
- GMSACredentialSpec is where the GMSA admission webhook
- (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
- GMSA credential spec named by the GMSACredentialSpecName field.
+ description: GMSACredentialSpec is where the
+ GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa)
+ inlines the contents of the GMSA credential
+ spec named by the GMSACredentialSpecName field.
type: string
gmsaCredentialSpecName:
description: GMSACredentialSpecName is the name
of the GMSA credential spec to use.
type: string
hostProcess:
- description: |-
- HostProcess determines if a container should be run as a 'Host Process' container.
- All of a Pod's containers must have the same effective HostProcess value
- (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
- In addition, if HostProcess is true then HostNetwork must also be set to true.
+ description: HostProcess determines if a container
+ should be run as a 'Host Process' container.
+ All of a Pod's containers must have the same
+ effective HostProcess value (it is not allowed
+ to have a mix of HostProcess containers and
+ non-HostProcess containers). In addition,
+ if HostProcess is true then HostNetwork must
+ also be set to true.
type: boolean
runAsUserName:
- description: |-
- The UserName in Windows to run the entrypoint of the container process.
- Defaults to the user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: The UserName in Windows to run
+ the entrypoint of the container process. Defaults
+ to the user specified in image metadata if
+ unspecified. May also be set in PodSecurityContext.
+ If set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence.
type: string
type: object
type: object
@@ -2673,19 +2730,22 @@ spec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to
+ execute inside the container, the working
+ directory for the command is root ('/') in
+ the container's filesystem. The command is
+ simply exec'd, it is not run inside a shell,
+ so traditional shell instructions ('|', etc)
+ won't work. To use a shell, you need to explicitly
+ call out to that shell. Exit status of 0 is
+ treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
format: int32
type: integer
@@ -2699,12 +2759,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
- (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ description: "Service is the name of the service
+ to place in the gRPC HealthCheckRequest (see
+ https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
+ \n If this is not specified, the default behavior
+ is defined by gRPC."
type: string
required:
- port
@@ -2714,9 +2773,9 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
description: Custom headers to set in the request.
@@ -2726,9 +2785,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name. This
+ will be canonicalized upon output, so
+ case-variant names will be understood
+ as the same header.
type: string
value:
description: The header field value
@@ -2745,35 +2805,34 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for the
+ probe to be considered successful after having
+ failed. Defaults to 1. Must be 1 for liveness
+ and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -2788,85 +2847,94 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod
+ needs to terminate gracefully upon probe failure.
+ The grace period is the duration in seconds after
+ the processes running in the pod are sent a termination
+ signal and the time when the processes are forcibly
+ halted with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value must
+ be non-negative integer. The value zero indicates
+ stop immediately via the kill signal (no opportunity
+ to shut down). This is a beta field and requires
+ enabling ProbeTerminationGracePeriod feature gate.
+ Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which the
+ probe times out. Defaults to 1 second. Minimum
+ value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
stdin:
- description: |-
- Whether this container should allocate a buffer for stdin in the container runtime. If this
- is not set, reads from stdin in the container will always result in EOF.
- Default is false.
+ description: Whether this container should allocate
+ a buffer for stdin in the container runtime. If this
+ is not set, reads from stdin in the container will
+ always result in EOF. Default is false.
type: boolean
stdinOnce:
- description: |-
- Whether the container runtime should close the stdin channel after it has been opened by
- a single attach. When stdin is true the stdin stream will remain open across multiple attach
- sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
- first client attaches to stdin, and then remains open and accepts data until the client disconnects,
- at which time stdin is closed and remains closed until the container is restarted. If this
- flag is false, a container processes that reads from stdin will never receive an EOF.
- Default is false
+ description: Whether the container runtime should close
+ the stdin channel after it has been opened by a single
+ attach. When stdin is true the stdin stream will remain
+ open across multiple attach sessions. If stdinOnce
+ is set to true, stdin is opened on container start,
+ is empty until the first client attaches to stdin,
+ and then remains open and accepts data until the client
+ disconnects, at which time stdin is closed and remains
+ closed until the container is restarted. If this flag
+ is false, a container processes that reads from stdin
+ will never receive an EOF. Default is false
type: boolean
targetContainerName:
- description: |-
- If set, the name of the container from PodSpec that this ephemeral container targets.
- The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container.
- If not set then the ephemeral container uses the namespaces configured in the Pod spec.
-
-
- The container runtime must implement support for this feature. If the runtime does not
- support namespace targeting then the result of setting this field is undefined.
+ description: "If set, the name of the container from
+ PodSpec that this ephemeral container targets. The
+ ephemeral container will be run in the namespaces
+ (IPC, PID, etc) of this container. If not set then
+ the ephemeral container uses the namespaces configured
+ in the Pod spec. \n The container runtime must implement
+ support for this feature. If the runtime does not
+ support namespace targeting then the result of setting
+ this field is undefined."
type: string
terminationMessagePath:
- description: |-
- Optional: Path at which the file to which the container's termination message
- will be written is mounted into the container's filesystem.
- Message written is intended to be brief final status, such as an assertion failure message.
- Will be truncated by the node if greater than 4096 bytes. The total message length across
- all containers will be limited to 12kb.
- Defaults to /dev/termination-log.
- Cannot be updated.
+ description: 'Optional: Path at which the file to which
+ the container''s termination message will be written
+ is mounted into the container''s filesystem. Message
+ written is intended to be brief final status, such
+ as an assertion failure message. Will be truncated
+ by the node if greater than 4096 bytes. The total
+ message length across all containers will be limited
+ to 12kb. Defaults to /dev/termination-log. Cannot
+ be updated.'
type: string
terminationMessagePolicy:
- description: |-
- Indicate how the termination message should be populated. File will use the contents of
- terminationMessagePath to populate the container status message on both success and failure.
- FallbackToLogsOnError will use the last chunk of container log output if the termination
- message file is empty and the container exited with an error.
- The log output is limited to 2048 bytes or 80 lines, whichever is smaller.
- Defaults to File.
- Cannot be updated.
+ description: Indicate how the termination message should
+ be populated. File will use the contents of terminationMessagePath
+ to populate the container status message on both success
+ and failure. FallbackToLogsOnError will use the last
+ chunk of container log output if the termination message
+ file is empty and the container exited with an error.
+ The log output is limited to 2048 bytes or 80 lines,
+ whichever is smaller. Defaults to File. Cannot be
+ updated.
type: string
tty:
- description: |-
- Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
+ description: Whether this container should allocate
+ a TTY for itself, also requires 'stdin' to be true.
Default is false.
type: boolean
volumeDevices:
@@ -2891,44 +2959,45 @@ spec:
type: object
type: array
volumeMounts:
- description: |-
- Pod volumes to mount into the container's filesystem. Subpath mounts are not allowed for ephemeral containers.
- Cannot be updated.
+ description: Pod volumes to mount into the container's
+ filesystem. Subpath mounts are not allowed for ephemeral
+ containers. Cannot be updated.
items:
description: VolumeMount describes a mounting of a
Volume within a container.
properties:
mountPath:
- description: |-
- Path within the container at which the volume should be mounted. Must
- not contain ':'.
+ description: Path within the container at which
+ the volume should be mounted. Must not contain
+ ':'.
type: string
mountPropagation:
- description: |-
- mountPropagation determines how mounts are propagated from the host
- to container and the other way around.
- When not set, MountPropagationNone is used.
- This field is beta in 1.10.
+ description: mountPropagation determines how mounts
+ are propagated from the host to container and
+ the other way around. When not set, MountPropagationNone
+ is used. This field is beta in 1.10.
type: string
name:
description: This must match the Name of a Volume.
type: string
readOnly:
- description: |-
- Mounted read-only if true, read-write otherwise (false or unspecified).
- Defaults to false.
+ description: Mounted read-only if true, read-write
+ otherwise (false or unspecified). Defaults to
+ false.
type: boolean
subPath:
- description: |-
- Path within the volume from which the container's volume should be mounted.
- Defaults to "" (volume's root).
+ description: Path within the volume from which
+ the container's volume should be mounted. Defaults
+ to "" (volume's root).
type: string
subPathExpr:
- description: |-
- Expanded path within the volume from which the container's volume should be mounted.
- Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.
- Defaults to "" (volume's root).
- SubPathExpr and SubPath are mutually exclusive.
+ description: Expanded path within the volume from
+ which the container's volume should be mounted.
+ Behaves similarly to SubPath but environment
+ variable references $(VAR_NAME) are expanded
+ using the container's environment. Defaults
+ to "" (volume's root). SubPathExpr and SubPath
+ are mutually exclusive.
type: string
required:
- mountPath
@@ -2936,11 +3005,10 @@ spec:
type: object
type: array
workingDir:
- description: |-
- Container's working directory.
- If not specified, the container runtime's default will be used, which
- might be configured in the container image.
- Cannot be updated.
+ description: Container's working directory. If not specified,
+ the container runtime's default will be used, which
+ might be configured in the container image. Cannot
+ be updated.
type: string
required:
- name
@@ -2953,35 +3021,38 @@ spec:
to run within a pod.
properties:
args:
- description: |-
- Arguments to the entrypoint.
- The container image's CMD is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Arguments to the entrypoint. The container
+ image''s CMD is used if this is not provided. Variable
+ references $(VAR_NAME) are expanded using the container''s
+ environment. If a variable cannot be resolved, the
+ reference in the input string will be unchanged. Double
+ $$ are reduced to a single $, which allows for escaping
+ the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce
+ the string literal "$(VAR_NAME)". Escaped references
+ will never be expanded, regardless of whether the
+ variable exists or not. Cannot be updated. More info:
+ https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
command:
- description: |-
- Entrypoint array. Not executed within a shell.
- The container image's ENTRYPOINT is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Entrypoint array. Not executed within
+ a shell. The container image''s ENTRYPOINT is used
+ if this is not provided. Variable references $(VAR_NAME)
+ are expanded using the container''s environment. If
+ a variable cannot be resolved, the reference in the
+ input string will be unchanged. Double $$ are reduced
+ to a single $, which allows for escaping the $(VAR_NAME)
+ syntax: i.e. "$$(VAR_NAME)" will produce the string
+ literal "$(VAR_NAME)". Escaped references will never
+ be expanded, regardless of whether the variable exists
+ or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
env:
- description: |-
- List of environment variables to set in the container.
- Cannot be updated.
+ description: List of environment variables to set in
+ the container. Cannot be updated.
items:
description: EnvVar represents an environment variable
present in a Container.
@@ -2991,16 +3062,17 @@ spec:
Must be a C_IDENTIFIER.
type: string
value:
- description: |-
- Variable references $(VAR_NAME) are expanded
- using the previously defined environment variables in the container and
- any service environment variables. If a variable cannot be resolved,
- the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
- "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
- Escaped references will never be expanded, regardless of whether the variable
- exists or not.
- Defaults to "".
+ description: 'Variable references $(VAR_NAME)
+ are expanded using the previously defined environment
+ variables in the container and any service environment
+ variables. If a variable cannot be resolved,
+ the reference in the input string will be unchanged.
+ Double $$ are reduced to a single $, which allows
+ for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)"
+ will produce the string literal "$(VAR_NAME)".
+ Escaped references will never be expanded, regardless
+ of whether the variable exists or not. Defaults
+ to "".'
type: string
valueFrom:
description: Source for the environment variable's
@@ -3013,10 +3085,10 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
@@ -3025,11 +3097,12 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
fieldRef:
- description: |-
- Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`,
- spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ description: 'Selects a field of the pod:
+ supports metadata.name, metadata.namespace,
+ `metadata.labels['''']`, `metadata.annotations['''']`,
+ spec.nodeName, spec.serviceAccountName,
+ status.hostIP, status.podIP, status.podIPs.'
properties:
apiVersion:
description: Version of the schema the
@@ -3043,11 +3116,12 @@ spec:
required:
- fieldPath
type: object
- x-kubernetes-map-type: atomic
resourceFieldRef:
- description: |-
- Selects a resource of the container: only resources limits and requests
- (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
+ description: 'Selects a resource of the container:
+ only resources limits and requests (limits.cpu,
+ limits.memory, limits.ephemeral-storage,
+ requests.cpu, requests.memory and requests.ephemeral-storage)
+ are currently supported.'
properties:
containerName:
description: 'Container name: required
@@ -3068,7 +3142,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret in
the pod's namespace
@@ -3079,10 +3152,10 @@ spec:
key.
type: string
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret
@@ -3091,20 +3164,20 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
required:
- name
type: object
type: array
envFrom:
- description: |-
- List of sources to populate environment variables in the container.
- The keys defined within a source must be a C_IDENTIFIER. All invalid keys
- will be reported as an event when the container is starting. When a key exists in multiple
- sources, the value associated with the last source will take precedence.
- Values defined by an Env with a duplicate key will take precedence.
- Cannot be updated.
+ description: List of sources to populate environment
+ variables in the container. The keys defined within
+ a source must be a C_IDENTIFIER. All invalid keys
+ will be reported as an event when the container is
+ starting. When a key exists in multiple sources, the
+ value associated with the last source will take precedence.
+ Values defined by an Env with a duplicate key will
+ take precedence. Cannot be updated.
items:
description: EnvFromSource represents the source of
a set of ConfigMaps
@@ -3113,17 +3186,16 @@ spec:
description: The ConfigMap to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
prefix:
description: An optional identifier to prepend
to each key in the ConfigMap. Must be a C_IDENTIFIER.
@@ -3132,56 +3204,57 @@ spec:
description: The Secret to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret must
be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
image:
- description: |-
- Container image name.
- More info: https://kubernetes.io/docs/concepts/containers/images
- This field is optional to allow higher level config management to default or override
- container images in workload controllers like Deployments and StatefulSets.
+ description: 'Container image name. More info: https://kubernetes.io/docs/concepts/containers/images
+ This field is optional to allow higher level config
+ management to default or override container images
+ in workload controllers like Deployments and StatefulSets.'
type: string
imagePullPolicy:
- description: |-
- Image pull policy.
- One of Always, Never, IfNotPresent.
- Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
+ description: 'Image pull policy. One of Always, Never,
+ IfNotPresent. Defaults to Always if :latest tag is
+ specified, or IfNotPresent otherwise. Cannot be updated.
+ More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
- description: |-
- Actions that the management system should take in response to container lifecycle events.
- Cannot be updated.
+ description: Actions that the management system should
+ take in response to container lifecycle events. Cannot
+ be updated.
properties:
postStart:
- description: |-
- PostStart is called immediately after a container is created. If the handler fails,
- the container is terminated and restarted according to its restart policy.
- Other management of the container blocks until the hook completes.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PostStart is called immediately after
+ a container is created. If the handler fails,
+ the container is terminated and restarted according
+ to its restart policy. Other management of the
+ container blocks until the hook completes. More
+ info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
@@ -3191,8 +3264,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -3203,9 +3276,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -3223,15 +3297,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -3249,10 +3322,11 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT supported
+ as a LifecycleHandler and kept for the backward
+ compatibility. There are no validation of
+ this field and lifecycle hooks will fail in
+ runtime when tcp handler is specified.
properties:
host:
description: 'Optional: Host name to connect
@@ -3262,37 +3336,44 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
preStop:
- description: |-
- PreStop is called immediately before a container is terminated due to an
- API request or management event such as liveness/startup probe failure,
- preemption, resource contention, etc. The handler is not called if the
- container crashes or exits. The Pod's termination grace period countdown begins before the
- PreStop hook is executed. Regardless of the outcome of the handler, the
- container will eventually terminate within the Pod's termination grace
- period (unless delayed by finalizers). Other management of the container blocks until the hook completes
- or until the termination grace period is reached.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PreStop is called immediately before
+ a container is terminated due to an API request
+ or management event such as liveness/startup probe
+ failure, preemption, resource contention, etc.
+ The handler is not called if the container crashes
+ or exits. The Pod''s termination grace period
+ countdown begins before the PreStop hook is executed.
+ Regardless of the outcome of the handler, the
+ container will eventually terminate within the
+ Pod''s termination grace period (unless delayed
+ by finalizers). Other management of the container
+ blocks until the hook completes or until the termination
+ grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
@@ -3302,8 +3383,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -3314,9 +3395,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -3334,15 +3416,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -3360,10 +3441,11 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT supported
+ as a LifecycleHandler and kept for the backward
+ compatibility. There are no validation of
+ this field and lifecycle hooks will fail in
+ runtime when tcp handler is specified.
properties:
host:
description: 'Optional: Host name to connect
@@ -3373,10 +3455,10 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
@@ -3384,29 +3466,30 @@ spec:
type: object
type: object
livenessProbe:
- description: |-
- Periodic probe of container liveness.
- Container will be restarted if the probe fails.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Periodic probe of container liveness.
+ Container will be restarted if the probe fails. Cannot
+ be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to
+ execute inside the container, the working
+ directory for the command is root ('/') in
+ the container's filesystem. The command is
+ simply exec'd, it is not run inside a shell,
+ so traditional shell instructions ('|', etc)
+ won't work. To use a shell, you need to explicitly
+ call out to that shell. Exit status of 0 is
+ treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
format: int32
type: integer
@@ -3420,12 +3503,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
- (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ description: "Service is the name of the service
+ to place in the gRPC HealthCheckRequest (see
+ https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
+ \n If this is not specified, the default behavior
+ is defined by gRPC."
type: string
required:
- port
@@ -3435,9 +3517,9 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
description: Custom headers to set in the request.
@@ -3447,9 +3529,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name. This
+ will be canonicalized upon output, so
+ case-variant names will be understood
+ as the same header.
type: string
value:
description: The header field value
@@ -3466,35 +3549,34 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for the
+ probe to be considered successful after having
+ failed. Defaults to 1. Must be 1 for liveness
+ and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -3509,59 +3591,61 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod
+ needs to terminate gracefully upon probe failure.
+ The grace period is the duration in seconds after
+ the processes running in the pod are sent a termination
+ signal and the time when the processes are forcibly
+ halted with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value must
+ be non-negative integer. The value zero indicates
+ stop immediately via the kill signal (no opportunity
+ to shut down). This is a beta field and requires
+ enabling ProbeTerminationGracePeriod feature gate.
+ Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which the
+ probe times out. Defaults to 1 second. Minimum
+ value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
name:
- description: |-
- Name of the container specified as a DNS_LABEL.
+ description: Name of the container specified as a DNS_LABEL.
Each container in a pod must have a unique name (DNS_LABEL).
Cannot be updated.
type: string
ports:
- description: |-
- List of ports to expose from the container. Not specifying a port here
- DOES NOT prevent that port from being exposed. Any port which is
- listening on the default "0.0.0.0" address inside a container will be
- accessible from the network.
- Modifying this array with strategic merge patch may corrupt the data.
- For more information See https://github.com/kubernetes/kubernetes/issues/108255.
+ description: List of ports to expose from the container.
+ Not specifying a port here DOES NOT prevent that port
+ from being exposed. Any port which is listening on
+ the default "0.0.0.0" address inside a container will
+ be accessible from the network. Modifying this array
+ with strategic merge patch may corrupt the data. For
+ more information See https://github.com/kubernetes/kubernetes/issues/108255.
Cannot be updated.
items:
description: ContainerPort represents a network port
in a single container.
properties:
containerPort:
- description: |-
- Number of port to expose on the pod's IP address.
- This must be a valid port number, 0 < x < 65536.
+ description: Number of port to expose on the pod's
+ IP address. This must be a valid port number,
+ 0 < x < 65536.
format: int32
type: integer
hostIP:
@@ -3569,24 +3653,23 @@ spec:
port to.
type: string
hostPort:
- description: |-
- Number of port to expose on the host.
- If specified, this must be a valid port number, 0 < x < 65536.
- If HostNetwork is specified, this must match ContainerPort.
- Most containers do not need this.
+ description: Number of port to expose on the host.
+ If specified, this must be a valid port number,
+ 0 < x < 65536. If HostNetwork is specified,
+ this must match ContainerPort. Most containers
+ do not need this.
format: int32
type: integer
name:
- description: |-
- If specified, this must be an IANA_SVC_NAME and unique within the pod. Each
- named port in a pod must have a unique name. Name for the port that can be
- referred to by services.
+ description: If specified, this must be an IANA_SVC_NAME
+ and unique within the pod. Each named port in
+ a pod must have a unique name. Name for the
+ port that can be referred to by services.
type: string
protocol:
default: TCP
- description: |-
- Protocol for port. Must be UDP, TCP, or SCTP.
- Defaults to "TCP".
+ description: Protocol for port. Must be UDP, TCP,
+ or SCTP. Defaults to "TCP".
type: string
required:
- containerPort
@@ -3597,29 +3680,30 @@ spec:
- protocol
x-kubernetes-list-type: map
readinessProbe:
- description: |-
- Periodic probe of container service readiness.
- Container will be removed from service endpoints if the probe fails.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Periodic probe of container service readiness.
+ Container will be removed from service endpoints if
+ the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to
+ execute inside the container, the working
+ directory for the command is root ('/') in
+ the container's filesystem. The command is
+ simply exec'd, it is not run inside a shell,
+ so traditional shell instructions ('|', etc)
+ won't work. To use a shell, you need to explicitly
+ call out to that shell. Exit status of 0 is
+ treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
format: int32
type: integer
@@ -3633,12 +3717,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
- (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ description: "Service is the name of the service
+ to place in the gRPC HealthCheckRequest (see
+ https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
+ \n If this is not specified, the default behavior
+ is defined by gRPC."
type: string
required:
- port
@@ -3648,9 +3731,9 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
description: Custom headers to set in the request.
@@ -3660,9 +3743,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name. This
+ will be canonicalized upon output, so
+ case-variant names will be understood
+ as the same header.
type: string
value:
description: The header field value
@@ -3679,35 +3763,34 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for the
+ probe to be considered successful after having
+ failed. Defaults to 1. Must be 1 for liveness
+ and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -3722,33 +3805,36 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod
+ needs to terminate gracefully upon probe failure.
+ The grace period is the duration in seconds after
+ the processes running in the pod are sent a termination
+ signal and the time when the processes are forcibly
+ halted with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value must
+ be non-negative integer. The value zero indicates
+ stop immediately via the kill signal (no opportunity
+ to shut down). This is a beta field and requires
+ enabling ProbeTerminationGracePeriod feature gate.
+ Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which the
+ probe times out. Defaults to 1 second. Minimum
+ value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
@@ -3759,14 +3845,14 @@ spec:
resize policy for the container.
properties:
resourceName:
- description: |-
- Name of the resource to which this resource resize policy applies.
- Supported values: cpu, memory.
+ description: 'Name of the resource to which this
+ resource resize policy applies. Supported values:
+ cpu, memory.'
type: string
restartPolicy:
- description: |-
- Restart policy to apply when specified resource is resized.
- If not specified, it defaults to NotRequired.
+ description: Restart policy to apply when specified
+ resource is resized. If not specified, it defaults
+ to NotRequired.
type: string
required:
- resourceName
@@ -3775,31 +3861,25 @@ spec:
type: array
x-kubernetes-list-type: atomic
resources:
- description: |-
- Compute Resources required by this container.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Compute Resources required by this container.
+ Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
properties:
claims:
- description: |-
- Claims lists the names of resources, defined in spec.resourceClaims,
- that are used by this container.
-
-
- This is an alpha field and requires enabling the
- DynamicResourceAllocation feature gate.
-
-
- This field is immutable. It can only be set for containers.
+ description: "Claims lists the names of resources,
+ defined in spec.resourceClaims, that are used
+ by this container. \n This is an alpha field and
+ requires enabling the DynamicResourceAllocation
+ feature gate. \n This field is immutable. It can
+ only be set for containers."
items:
description: ResourceClaim references one entry
in PodSpec.ResourceClaims.
properties:
name:
- description: |-
- Name must match the name of one entry in pod.spec.resourceClaims of
- the Pod where this field is used. It makes that resource available
- inside a container.
+ description: Name must match the name of one
+ entry in pod.spec.resourceClaims of the
+ Pod where this field is used. It makes that
+ resource available inside a container.
type: string
required:
- name
@@ -3815,9 +3895,8 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Limits describes the maximum amount of compute resources allowed.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Limits describes the maximum amount
+ of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -3826,52 +3905,57 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Requests describes the minimum amount of compute resources required.
- If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
- otherwise to an implementation-defined value. Requests cannot exceed Limits.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Requests describes the minimum amount
+ of compute resources required. If Requests is
+ omitted for a container, it defaults to Limits
+ if that is explicitly specified, otherwise to
+ an implementation-defined value. Requests cannot
+ exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
restartPolicy:
- description: |-
- RestartPolicy defines the restart behavior of individual containers in a pod.
- This field may only be set for init containers, and the only allowed value is "Always".
- For non-init containers or when this field is not specified,
- the restart behavior is defined by the Pod's restart policy and the container type.
- Setting the RestartPolicy as "Always" for the init container will have the following effect:
- this init container will be continually restarted on
- exit until all regular containers have terminated. Once all regular
- containers have completed, all init containers with restartPolicy "Always"
- will be shut down. This lifecycle differs from normal init containers and
- is often referred to as a "sidecar" container. Although this init
- container still starts in the init container sequence, it does not wait
- for the container to complete before proceeding to the next init
- container. Instead, the next init container starts immediately after this
- init container is started, or after any startupProbe has successfully
- completed.
+ description: 'RestartPolicy defines the restart behavior
+ of individual containers in a pod. This field may
+ only be set for init containers, and the only allowed
+ value is "Always". For non-init containers or when
+ this field is not specified, the restart behavior
+ is defined by the Pod''s restart policy and the container
+ type. Setting the RestartPolicy as "Always" for the
+ init container will have the following effect: this
+ init container will be continually restarted on exit
+ until all regular containers have terminated. Once
+ all regular containers have completed, all init containers
+ with restartPolicy "Always" will be shut down. This
+ lifecycle differs from normal init containers and
+ is often referred to as a "sidecar" container. Although
+ this init container still starts in the init container
+ sequence, it does not wait for the container to complete
+ before proceeding to the next init container. Instead,
+ the next init container starts immediately after this
+ init container is started, or after any startupProbe
+ has successfully completed.'
type: string
securityContext:
- description: |-
- SecurityContext defines the security options the container should be run with.
- If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
- More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
+ description: 'SecurityContext defines the security options
+ the container should be run with. If set, the fields
+ of SecurityContext override the equivalent fields
+ of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
properties:
allowPrivilegeEscalation:
- description: |-
- AllowPrivilegeEscalation controls whether a process can gain more
- privileges than its parent process. This bool directly controls if
- the no_new_privs flag will be set on the container process.
- AllowPrivilegeEscalation is true always when the container is:
- 1) run as Privileged
- 2) has CAP_SYS_ADMIN
- Note that this field cannot be set when spec.os.name is windows.
+ description: 'AllowPrivilegeEscalation controls
+ whether a process can gain more privileges than
+ its parent process. This bool directly controls
+ if the no_new_privs flag will be set on the container
+ process. AllowPrivilegeEscalation is true always
+ when the container is: 1) run as Privileged 2)
+ has CAP_SYS_ADMIN Note that this field cannot
+ be set when spec.os.name is windows.'
type: boolean
capabilities:
- description: |-
- The capabilities to add/drop when running containers.
- Defaults to the default set of capabilities granted by the container runtime.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The capabilities to add/drop when running
+ containers. Defaults to the default set of capabilities
+ granted by the container runtime. Note that this
+ field cannot be set when spec.os.name is windows.
properties:
add:
description: Added capabilities
@@ -3889,60 +3973,66 @@ spec:
type: array
type: object
privileged:
- description: |-
- Run container in privileged mode.
- Processes in privileged containers are essentially equivalent to root on the host.
- Defaults to false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Run container in privileged mode. Processes
+ in privileged containers are essentially equivalent
+ to root on the host. Defaults to false. Note that
+ this field cannot be set when spec.os.name is
+ windows.
type: boolean
procMount:
- description: |-
- procMount denotes the type of proc mount to use for the containers.
- The default is DefaultProcMount which uses the container runtime defaults for
- readonly paths and masked paths.
- This requires the ProcMountType feature flag to be enabled.
- Note that this field cannot be set when spec.os.name is windows.
+ description: procMount denotes the type of proc
+ mount to use for the containers. The default is
+ DefaultProcMount which uses the container runtime
+ defaults for readonly paths and masked paths.
+ This requires the ProcMountType feature flag to
+ be enabled. Note that this field cannot be set
+ when spec.os.name is windows.
type: string
readOnlyRootFilesystem:
- description: |-
- Whether this container has a read-only root filesystem.
- Default is false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Whether this container has a read-only
+ root filesystem. Default is false. Note that this
+ field cannot be set when spec.os.name is windows.
type: boolean
runAsGroup:
- description: |-
- The GID to run the entrypoint of the container process.
- Uses runtime default if unset.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The GID to run the entrypoint of the
+ container process. Uses runtime default if unset.
+ May also be set in PodSecurityContext. If set
+ in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence.
+ Note that this field cannot be set when spec.os.name
+ is windows.
format: int64
type: integer
runAsNonRoot:
- description: |-
- Indicates that the container must run as a non-root user.
- If true, the Kubelet will validate the image at runtime to ensure that it
- does not run as UID 0 (root) and fail to start the container if it does.
- If unset or false, no such validation will be performed.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: Indicates that the container must run
+ as a non-root user. If true, the Kubelet will
+ validate the image at runtime to ensure that it
+ does not run as UID 0 (root) and fail to start
+ the container if it does. If unset or false, no
+ such validation will be performed. May also be
+ set in PodSecurityContext. If set in both SecurityContext
+ and PodSecurityContext, the value specified in
+ SecurityContext takes precedence.
type: boolean
runAsUser:
- description: |-
- The UID to run the entrypoint of the container process.
- Defaults to user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The UID to run the entrypoint of the
+ container process. Defaults to user specified
+ in image metadata if unspecified. May also be
+ set in PodSecurityContext. If set in both SecurityContext
+ and PodSecurityContext, the value specified in
+ SecurityContext takes precedence. Note that this
+ field cannot be set when spec.os.name is windows.
format: int64
type: integer
seLinuxOptions:
- description: |-
- The SELinux context to be applied to the container.
- If unspecified, the container runtime will allocate a random SELinux context for each
- container. May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The SELinux context to be applied to
+ the container. If unspecified, the container runtime
+ will allocate a random SELinux context for each
+ container. May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence.
+ Note that this field cannot be set when spec.os.name
+ is windows.
properties:
level:
description: Level is SELinux level label that
@@ -3962,92 +4052,104 @@ spec:
type: string
type: object
seccompProfile:
- description: |-
- The seccomp options to use by this container. If seccomp options are
- provided at both the pod & container level, the container options
- override the pod options.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The seccomp options to use by this
+ container. If seccomp options are provided at
+ both the pod & container level, the container
+ options override the pod options. Note that this
+ field cannot be set when spec.os.name is windows.
properties:
localhostProfile:
- description: |-
- localhostProfile indicates a profile defined in a file on the node should be used.
- The profile must be preconfigured on the node to work.
- Must be a descending path, relative to the kubelet's configured seccomp profile location.
- Must be set if type is "Localhost". Must NOT be set for any other type.
+ description: localhostProfile indicates a profile
+ defined in a file on the node should be used.
+ The profile must be preconfigured on the node
+ to work. Must be a descending path, relative
+ to the kubelet's configured seccomp profile
+ location. Must be set if type is "Localhost".
+ Must NOT be set for any other type.
type: string
type:
- description: |-
- type indicates which kind of seccomp profile will be applied.
- Valid options are:
-
-
- Localhost - a profile defined in a file on the node should be used.
- RuntimeDefault - the container runtime default profile should be used.
- Unconfined - no profile should be applied.
+ description: "type indicates which kind of seccomp
+ profile will be applied. Valid options are:
+ \n Localhost - a profile defined in a file
+ on the node should be used. RuntimeDefault
+ - the container runtime default profile should
+ be used. Unconfined - no profile should be
+ applied."
type: string
required:
- type
type: object
windowsOptions:
- description: |-
- The Windows specific settings applied to all containers.
- If unspecified, the options from the PodSecurityContext will be used.
- If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is linux.
+ description: The Windows specific settings applied
+ to all containers. If unspecified, the options
+ from the PodSecurityContext will be used. If set
+ in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence.
+ Note that this field cannot be set when spec.os.name
+ is linux.
properties:
gmsaCredentialSpec:
- description: |-
- GMSACredentialSpec is where the GMSA admission webhook
- (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
- GMSA credential spec named by the GMSACredentialSpecName field.
+ description: GMSACredentialSpec is where the
+ GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa)
+ inlines the contents of the GMSA credential
+ spec named by the GMSACredentialSpecName field.
type: string
gmsaCredentialSpecName:
description: GMSACredentialSpecName is the name
of the GMSA credential spec to use.
type: string
hostProcess:
- description: |-
- HostProcess determines if a container should be run as a 'Host Process' container.
- All of a Pod's containers must have the same effective HostProcess value
- (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
- In addition, if HostProcess is true then HostNetwork must also be set to true.
+ description: HostProcess determines if a container
+ should be run as a 'Host Process' container.
+ All of a Pod's containers must have the same
+ effective HostProcess value (it is not allowed
+ to have a mix of HostProcess containers and
+ non-HostProcess containers). In addition,
+ if HostProcess is true then HostNetwork must
+ also be set to true.
type: boolean
runAsUserName:
- description: |-
- The UserName in Windows to run the entrypoint of the container process.
- Defaults to the user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: The UserName in Windows to run
+ the entrypoint of the container process. Defaults
+ to the user specified in image metadata if
+ unspecified. May also be set in PodSecurityContext.
+ If set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence.
type: string
type: object
type: object
startupProbe:
- description: |-
- StartupProbe indicates that the Pod has successfully initialized.
- If specified, no other probes are executed until this completes successfully.
- If this probe fails, the Pod will be restarted, just as if the livenessProbe failed.
- This can be used to provide different probe parameters at the beginning of a Pod's lifecycle,
- when it might take a long time to load data or warm a cache, than during steady-state operation.
- This cannot be updated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'StartupProbe indicates that the Pod has
+ successfully initialized. If specified, no other probes
+ are executed until this completes successfully. If
+ this probe fails, the Pod will be restarted, just
+ as if the livenessProbe failed. This can be used to
+ provide different probe parameters at the beginning
+ of a Pod''s lifecycle, when it might take a long time
+ to load data or warm a cache, than during steady-state
+ operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line to
+ execute inside the container, the working
+ directory for the command is root ('/') in
+ the container's filesystem. The command is
+ simply exec'd, it is not run inside a shell,
+ so traditional shell instructions ('|', etc)
+ won't work. To use a shell, you need to explicitly
+ call out to that shell. Exit status of 0 is
+ treated as live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
format: int32
type: integer
@@ -4061,12 +4163,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
- (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ description: "Service is the name of the service
+ to place in the gRPC HealthCheckRequest (see
+ https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
+ \n If this is not specified, the default behavior
+ is defined by gRPC."
type: string
required:
- port
@@ -4076,9 +4177,9 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
description: Custom headers to set in the request.
@@ -4088,9 +4189,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name. This
+ will be canonicalized upon output, so
+ case-variant names will be understood
+ as the same header.
type: string
value:
description: The header field value
@@ -4107,35 +4209,34 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for the
+ probe to be considered successful after having
+ failed. Defaults to 1. Must be 1 for liveness
+ and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -4150,75 +4251,83 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port to access
+ on the container. Number must be in the range
+ 1 to 65535. Name must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the pod
+ needs to terminate gracefully upon probe failure.
+ The grace period is the duration in seconds after
+ the processes running in the pod are sent a termination
+ signal and the time when the processes are forcibly
+ halted with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value must
+ be non-negative integer. The value zero indicates
+ stop immediately via the kill signal (no opportunity
+ to shut down). This is a beta field and requires
+ enabling ProbeTerminationGracePeriod feature gate.
+ Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which the
+ probe times out. Defaults to 1 second. Minimum
+ value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
stdin:
- description: |-
- Whether this container should allocate a buffer for stdin in the container runtime. If this
- is not set, reads from stdin in the container will always result in EOF.
- Default is false.
+ description: Whether this container should allocate
+ a buffer for stdin in the container runtime. If this
+ is not set, reads from stdin in the container will
+ always result in EOF. Default is false.
type: boolean
stdinOnce:
- description: |-
- Whether the container runtime should close the stdin channel after it has been opened by
- a single attach. When stdin is true the stdin stream will remain open across multiple attach
- sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
- first client attaches to stdin, and then remains open and accepts data until the client disconnects,
- at which time stdin is closed and remains closed until the container is restarted. If this
- flag is false, a container processes that reads from stdin will never receive an EOF.
- Default is false
+ description: Whether the container runtime should close
+ the stdin channel after it has been opened by a single
+ attach. When stdin is true the stdin stream will remain
+ open across multiple attach sessions. If stdinOnce
+ is set to true, stdin is opened on container start,
+ is empty until the first client attaches to stdin,
+ and then remains open and accepts data until the client
+ disconnects, at which time stdin is closed and remains
+ closed until the container is restarted. If this flag
+ is false, a container processes that reads from stdin
+ will never receive an EOF. Default is false
type: boolean
terminationMessagePath:
- description: |-
- Optional: Path at which the file to which the container's termination message
- will be written is mounted into the container's filesystem.
- Message written is intended to be brief final status, such as an assertion failure message.
- Will be truncated by the node if greater than 4096 bytes. The total message length across
- all containers will be limited to 12kb.
- Defaults to /dev/termination-log.
- Cannot be updated.
+ description: 'Optional: Path at which the file to which
+ the container''s termination message will be written
+ is mounted into the container''s filesystem. Message
+ written is intended to be brief final status, such
+ as an assertion failure message. Will be truncated
+ by the node if greater than 4096 bytes. The total
+ message length across all containers will be limited
+ to 12kb. Defaults to /dev/termination-log. Cannot
+ be updated.'
type: string
terminationMessagePolicy:
- description: |-
- Indicate how the termination message should be populated. File will use the contents of
- terminationMessagePath to populate the container status message on both success and failure.
- FallbackToLogsOnError will use the last chunk of container log output if the termination
- message file is empty and the container exited with an error.
- The log output is limited to 2048 bytes or 80 lines, whichever is smaller.
- Defaults to File.
- Cannot be updated.
+ description: Indicate how the termination message should
+ be populated. File will use the contents of terminationMessagePath
+ to populate the container status message on both success
+ and failure. FallbackToLogsOnError will use the last
+ chunk of container log output if the termination message
+ file is empty and the container exited with an error.
+ The log output is limited to 2048 bytes or 80 lines,
+ whichever is smaller. Defaults to File. Cannot be
+ updated.
type: string
tty:
- description: |-
- Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
+ description: Whether this container should allocate
+ a TTY for itself, also requires 'stdin' to be true.
Default is false.
type: boolean
volumeDevices:
@@ -4243,44 +4352,44 @@ spec:
type: object
type: array
volumeMounts:
- description: |-
- Pod volumes to mount into the container's filesystem.
- Cannot be updated.
+ description: Pod volumes to mount into the container's
+ filesystem. Cannot be updated.
items:
description: VolumeMount describes a mounting of a
Volume within a container.
properties:
mountPath:
- description: |-
- Path within the container at which the volume should be mounted. Must
- not contain ':'.
+ description: Path within the container at which
+ the volume should be mounted. Must not contain
+ ':'.
type: string
mountPropagation:
- description: |-
- mountPropagation determines how mounts are propagated from the host
- to container and the other way around.
- When not set, MountPropagationNone is used.
- This field is beta in 1.10.
+ description: mountPropagation determines how mounts
+ are propagated from the host to container and
+ the other way around. When not set, MountPropagationNone
+ is used. This field is beta in 1.10.
type: string
name:
description: This must match the Name of a Volume.
type: string
readOnly:
- description: |-
- Mounted read-only if true, read-write otherwise (false or unspecified).
- Defaults to false.
+ description: Mounted read-only if true, read-write
+ otherwise (false or unspecified). Defaults to
+ false.
type: boolean
subPath:
- description: |-
- Path within the volume from which the container's volume should be mounted.
- Defaults to "" (volume's root).
+ description: Path within the volume from which
+ the container's volume should be mounted. Defaults
+ to "" (volume's root).
type: string
subPathExpr:
- description: |-
- Expanded path within the volume from which the container's volume should be mounted.
- Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.
- Defaults to "" (volume's root).
- SubPathExpr and SubPath are mutually exclusive.
+ description: Expanded path within the volume from
+ which the container's volume should be mounted.
+ Behaves similarly to SubPath but environment
+ variable references $(VAR_NAME) are expanded
+ using the container's environment. Defaults
+ to "" (volume's root). SubPathExpr and SubPath
+ are mutually exclusive.
type: string
required:
- mountPath
@@ -4288,11 +4397,10 @@ spec:
type: object
type: array
workingDir:
- description: |-
- Container's working directory.
- If not specified, the container runtime's default will be used, which
- might be configured in the container image.
- Cannot be updated.
+ description: Container's working directory. If not specified,
+ the container runtime's default will be used, which
+ might be configured in the container image. Cannot
+ be updated.
type: string
required:
- name
@@ -4310,68 +4418,66 @@ spec:
description: 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.
- Note that this field cannot be set when spec.os.name is windows.
+ description: "A special supplemental group that applies
+ to all containers in a pod. Some volume types allow
+ the Kubelet to change the ownership of that volume to
+ be owned by the pod: \n 1. The owning GID will be the
+ FSGroup 2. The setgid bit is set (new files created
+ in the volume will be owned by FSGroup) 3. The permission
+ bits are OR'd with rw-rw---- \n If unset, the Kubelet
+ will not modify the ownership and permissions of any
+ volume. Note that this field cannot be set when spec.os.name
+ is windows."
format: int64
type: integer
fsGroupChangePolicy:
- description: |-
- fsGroupChangePolicy defines behavior of changing ownership and permission of the volume
- before being exposed inside Pod. This field will only apply to
- volume types which support fsGroup based ownership(and permissions).
- It will have no effect on ephemeral volume types such as: secret, configmaps
- and emptydir.
- Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used.
- Note that this field cannot be set when spec.os.name is windows.
+ description: 'fsGroupChangePolicy defines behavior of
+ changing ownership and permission of the volume before
+ being exposed inside Pod. This field will only apply
+ to volume types which support fsGroup based ownership(and
+ permissions). It will have no effect on ephemeral volume
+ types such as: secret, configmaps and emptydir. Valid
+ values are "OnRootMismatch" and "Always". If not specified,
+ "Always" is used. Note that this field cannot be set
+ when spec.os.name is windows.'
type: string
runAsGroup:
- description: |-
- The GID to run the entrypoint of the container process.
- Uses runtime default if unset.
- May also be set in SecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence
- for that container.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The GID to run the entrypoint of the container
+ process. Uses runtime default if unset. May also be
+ set in SecurityContext. If set in both SecurityContext
+ and PodSecurityContext, the value specified in SecurityContext
+ takes precedence for that container. Note that this
+ field cannot be set when spec.os.name is windows.
format: int64
type: integer
runAsNonRoot:
- description: |-
- Indicates that the container must run as a non-root user.
- If true, the Kubelet will validate the image at runtime to ensure that it
- does not run as UID 0 (root) and fail to start the container if it does.
- If unset or false, no such validation will be performed.
- May also be set in SecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: Indicates that the container must run as
+ a non-root user. If true, the Kubelet will validate
+ the image at runtime to ensure that it does not run
+ as UID 0 (root) and fail to start the container if it
+ does. If unset or false, no such validation will be
+ performed. May also be set in SecurityContext. If set
+ in both SecurityContext and PodSecurityContext, the
+ value specified in SecurityContext takes precedence.
type: boolean
runAsUser:
- description: |-
- The UID to run the entrypoint of the container process.
- Defaults to user specified in image metadata if unspecified.
- May also be set in SecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence
- for that container.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The UID to run the entrypoint of the container
+ process. Defaults to user specified in image metadata
+ if unspecified. May also be set in SecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence
+ for that container. Note that this field cannot be set
+ when spec.os.name is windows.
format: int64
type: integer
seLinuxOptions:
- description: |-
- The SELinux context to be applied to all containers.
- If unspecified, the container runtime will allocate a random SELinux context for each
- container. May also be set in SecurityContext. If set in
- both SecurityContext and PodSecurityContext, the value specified in SecurityContext
- takes precedence for that container.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The SELinux context to be applied to all
+ containers. If unspecified, the container runtime will
+ allocate a random SELinux context for each container. May
+ also be set in SecurityContext. If set in both SecurityContext
+ and PodSecurityContext, the value specified in SecurityContext
+ takes precedence for that container. Note that this
+ field cannot be set when spec.os.name is windows.
properties:
level:
description: Level is SELinux level label that applies
@@ -4391,48 +4497,50 @@ spec:
type: string
type: object
seccompProfile:
- description: |-
- The seccomp options to use by the containers in this pod.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The seccomp options to use by the containers
+ in this pod. Note that this field cannot be set when
+ spec.os.name is windows.
properties:
localhostProfile:
- description: |-
- localhostProfile indicates a profile defined in a file on the node should be used.
- The profile must be preconfigured on the node to work.
- Must be a descending path, relative to the kubelet's configured seccomp profile location.
- Must be set if type is "Localhost". Must NOT be set for any other type.
+ description: localhostProfile indicates a profile
+ defined in a file on the node should be used. The
+ profile must be preconfigured on the node to work.
+ Must be a descending path, relative to the kubelet's
+ configured seccomp profile location. Must be set
+ if type is "Localhost". Must NOT be set for any
+ other type.
type: string
type:
- description: |-
- type indicates which kind of seccomp profile will be applied.
- Valid options are:
-
-
- Localhost - a profile defined in a file on the node should be used.
- RuntimeDefault - the container runtime default profile should be used.
- Unconfined - no profile should be applied.
+ description: "type indicates which kind of seccomp
+ profile will be applied. Valid options are: \n Localhost
+ - a profile defined in a file on the node should
+ be used. RuntimeDefault - the container runtime
+ default profile should be used. Unconfined - no
+ profile should be applied."
type: string
required:
- type
type: object
supplementalGroups:
- description: |-
- A list of groups applied to the first process run in each container, in addition
- to the container's primary GID, the fsGroup (if specified), and group memberships
- defined in the container image for the uid of the container process. If unspecified,
- no additional groups are added to any container. Note that group memberships
- defined in the container image for the uid of the container process are still effective,
- even if they are not included in this list.
- Note that this field cannot be set when spec.os.name is windows.
+ description: A list of groups applied to the first process
+ run in each container, in addition to the container's
+ primary GID, the fsGroup (if specified), and group memberships
+ defined in the container image for the uid of the container
+ process. If unspecified, no additional groups are added
+ to any container. Note that group memberships defined
+ in the container image for the uid of the container
+ process are still effective, even if they are not included
+ in this list. Note that this field cannot be set when
+ spec.os.name is windows.
items:
format: int64
type: integer
type: array
sysctls:
- description: |-
- Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported
- sysctls (by the container runtime) might fail to launch.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Sysctls hold a list of namespaced sysctls
+ used for the pod. Pods with unsupported sysctls (by
+ the container runtime) might fail to launch. Note that
+ this field cannot be set when spec.os.name is windows.
items:
description: Sysctl defines a kernel parameter to be
set
@@ -4449,35 +4557,39 @@ spec:
type: object
type: array
windowsOptions:
- description: |-
- The Windows specific settings applied to all containers.
- If unspecified, the options within a container's SecurityContext will be used.
- If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is linux.
+ description: The Windows specific settings applied to
+ all containers. If unspecified, the options within a
+ container's SecurityContext will be used. If set in
+ both SecurityContext and PodSecurityContext, the value
+ specified in SecurityContext takes precedence. Note
+ that this field cannot be set when spec.os.name is linux.
properties:
gmsaCredentialSpec:
- description: |-
- GMSACredentialSpec is where the GMSA admission webhook
- (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
- GMSA credential spec named by the GMSACredentialSpecName field.
+ description: GMSACredentialSpec is where the GMSA
+ admission webhook (https://github.com/kubernetes-sigs/windows-gmsa)
+ inlines the contents of the GMSA credential spec
+ named by the GMSACredentialSpecName field.
type: string
gmsaCredentialSpecName:
description: GMSACredentialSpecName is the name of
the GMSA credential spec to use.
type: string
hostProcess:
- description: |-
- HostProcess determines if a container should be run as a 'Host Process' container.
- All of a Pod's containers must have the same effective HostProcess value
- (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
- In addition, if HostProcess is true then HostNetwork must also be set to true.
+ description: HostProcess determines if a container
+ should be run as a 'Host Process' container. All
+ of a Pod's containers must have the same effective
+ HostProcess value (it is not allowed to have a mix
+ of HostProcess containers and non-HostProcess containers).
+ In addition, if HostProcess is true then HostNetwork
+ must also be set to true.
type: boolean
runAsUserName:
- description: |-
- The UserName in Windows to run the entrypoint of the container process.
- Defaults to the user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: The UserName in Windows to run the entrypoint
+ of the container process. Defaults to the user specified
+ in image metadata if unspecified. May also be set
+ in PodSecurityContext. If set in both SecurityContext
+ and PodSecurityContext, the value specified in SecurityContext
+ takes precedence.
type: string
type: object
type: object
@@ -4492,34 +4604,35 @@ spec:
matching pods among the given topology.
properties:
labelSelector:
- description: |-
- LabelSelector is used to find matching pods.
- Pods that match this label selector are counted to determine the number of pods
- in their corresponding topology domain.
+ description: LabelSelector is used to find matching
+ pods. Pods that match this label selector are counted
+ to determine the number of pods in their corresponding
+ topology domain.
properties:
matchExpressions:
description: matchExpressions is a list of label
selector requirements. The requirements are ANDed.
items:
- description: |-
- A label selector requirement is a selector that contains values, a key, and an operator that
- relates the key and values.
+ description: A label selector requirement is a
+ selector that contains values, a key, and an
+ operator that relates the key and values.
properties:
key:
description: key is the label key that the
selector applies to.
type: string
operator:
- description: |-
- operator represents a key's relationship to a set of values.
- Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents a key's relationship
+ to a set of values. Valid operators are
+ In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: |-
- values is an array of string values. If the operator is In or NotIn,
- the values array must be non-empty. If the operator is Exists or DoesNotExist,
- the values array must be empty. This array is replaced during a strategic
- merge patch.
+ description: values is an array of string
+ values. If the operator is In or NotIn,
+ the values array must be non-empty. If the
+ operator is Exists or DoesNotExist, the
+ values array must be empty. This array is
+ replaced during a strategic merge patch.
items:
type: string
type: array
@@ -4531,134 +4644,138 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: |-
- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions, whose key field is "key", the
- operator is "In", and the values array contains only "value". The requirements are ANDed.
+ description: matchLabels is a map of {key,value}
+ pairs. A single {key,value} in the matchLabels
+ map is equivalent to an element of matchExpressions,
+ whose key field is "key", the operator is "In",
+ and the values array contains only "value". The
+ requirements are ANDed.
type: object
type: object
- x-kubernetes-map-type: atomic
matchLabelKeys:
- description: |-
- MatchLabelKeys is a set of pod label keys to select the pods over which
- spreading will be calculated. The keys are used to lookup values from the
- incoming pod labels, those key-value labels are ANDed with labelSelector
- to select the group of existing pods over which spreading will be calculated
- for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.
- MatchLabelKeys cannot be set when LabelSelector isn't set.
- Keys that don't exist in the incoming pod labels will
- be ignored. A null or empty list means only match against labelSelector.
-
-
- This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).
+ description: "MatchLabelKeys is a set of pod label keys
+ to select the pods over which spreading will be calculated.
+ The keys are used to lookup values from the incoming
+ pod labels, those key-value labels are ANDed with
+ labelSelector to select the group of existing pods
+ over which spreading will be calculated for the incoming
+ pod. The same key is forbidden to exist in both MatchLabelKeys
+ and LabelSelector. MatchLabelKeys cannot be set when
+ LabelSelector isn't set. Keys that don't exist in
+ the incoming pod labels will be ignored. A null or
+ empty list means only match against labelSelector.
+ \n This is a beta field and requires the MatchLabelKeysInPodTopologySpread
+ feature gate to be enabled (enabled by default)."
items:
type: string
type: array
x-kubernetes-list-type: atomic
maxSkew:
- description: |-
- MaxSkew describes the degree to which pods may be unevenly distributed.
- When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference
- between the number of matching pods in the target topology and the global minimum.
- The global minimum is the minimum number of matching pods in an eligible domain
- or zero if the number of eligible domains is less than MinDomains.
- For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same
- labelSelector spread as 2/2/1:
- In this case, the global minimum is 1.
- | zone1 | zone2 | zone3 |
- | P P | P P | P |
- - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2;
- scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2)
- violate MaxSkew(1).
- - if MaxSkew is 2, incoming pod can be scheduled onto any zone.
- When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence
- to topologies that satisfy it.
- It's a required field. Default value is 1 and 0 is not allowed.
+ description: 'MaxSkew describes the degree to which
+ pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`,
+ it is the maximum permitted difference between the
+ number of matching pods in the target topology and
+ the global minimum. The global minimum is the minimum
+ number of matching pods in an eligible domain or zero
+ if the number of eligible domains is less than MinDomains.
+ For example, in a 3-zone cluster, MaxSkew is set to
+ 1, and pods with the same labelSelector spread as
+ 2/2/1: In this case, the global minimum is 1. | zone1
+ | zone2 | zone3 | | P P | P P | P | - if MaxSkew
+ is 1, incoming pod can only be scheduled to zone3
+ to become 2/2/2; scheduling it onto zone1(zone2) would
+ make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1).
+ - if MaxSkew is 2, incoming pod can be scheduled onto
+ any zone. When `whenUnsatisfiable=ScheduleAnyway`,
+ it is used to give higher precedence to topologies
+ that satisfy it. It''s a required field. Default value
+ is 1 and 0 is not allowed.'
format: int32
type: integer
minDomains:
- description: |-
- MinDomains indicates a minimum number of eligible domains.
- When the number of eligible domains with matching topology keys is less than minDomains,
- Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed.
- And when the number of eligible domains with matching topology keys equals or greater than minDomains,
- this value has no effect on scheduling.
- As a result, when the number of eligible domains is less than minDomains,
- scheduler won't schedule more than maxSkew Pods to those domains.
- If value is nil, the constraint behaves as if MinDomains is equal to 1.
- Valid values are integers greater than 0.
- When value is not nil, WhenUnsatisfiable must be DoNotSchedule.
-
-
- For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same
- labelSelector spread as 2/2/2:
- | zone1 | zone2 | zone3 |
- | P P | P P | P P |
- The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0.
- In this situation, new pod with the same labelSelector cannot be scheduled,
- because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones,
- it will violate MaxSkew.
-
-
- This is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default).
+ description: "MinDomains indicates a minimum number
+ of eligible domains. When the number of eligible domains
+ with matching topology keys is less than minDomains,
+ Pod Topology Spread treats \"global minimum\" as 0,
+ and then the calculation of Skew is performed. And
+ when the number of eligible domains with matching
+ topology keys equals or greater than minDomains, this
+ value has no effect on scheduling. As a result, when
+ the number of eligible domains is less than minDomains,
+ scheduler won't schedule more than maxSkew Pods to
+ those domains. If value is nil, the constraint behaves
+ as if MinDomains is equal to 1. Valid values are integers
+ greater than 0. When value is not nil, WhenUnsatisfiable
+ must be DoNotSchedule. \n For example, in a 3-zone
+ cluster, MaxSkew is set to 2, MinDomains is set to
+ 5 and pods with the same labelSelector spread as 2/2/2:
+ | zone1 | zone2 | zone3 | | P P | P P | P P |
+ The number of domains is less than 5(MinDomains),
+ so \"global minimum\" is treated as 0. In this situation,
+ new pod with the same labelSelector cannot be scheduled,
+ because computed skew will be 3(3 - 0) if new Pod
+ is scheduled to any of the three zones, it will violate
+ MaxSkew. \n This is a beta field and requires the
+ MinDomainsInPodTopologySpread feature gate to be enabled
+ (enabled by default)."
format: int32
type: integer
nodeAffinityPolicy:
- description: |-
- NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector
- when calculating pod topology spread skew. Options are:
- - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations.
- - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.
-
-
- If this value is nil, the behavior is equivalent to the Honor policy.
- This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
+ description: "NodeAffinityPolicy indicates how we will
+ treat Pod's nodeAffinity/nodeSelector when calculating
+ pod topology spread skew. Options are: - Honor: only
+ nodes matching nodeAffinity/nodeSelector are included
+ in the calculations. - Ignore: nodeAffinity/nodeSelector
+ are ignored. All nodes are included in the calculations.
+ \n If this value is nil, the behavior is equivalent
+ to the Honor policy. This is a beta-level feature
+ default enabled by the NodeInclusionPolicyInPodTopologySpread
+ feature flag."
type: string
nodeTaintsPolicy:
- description: |-
- NodeTaintsPolicy indicates how we will treat node taints when calculating
- pod topology spread skew. Options are:
- - Honor: nodes without taints, along with tainted nodes for which the incoming pod
- has a toleration, are included.
- - Ignore: node taints are ignored. All nodes are included.
-
-
- If this value is nil, the behavior is equivalent to the Ignore policy.
- This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
+ description: "NodeTaintsPolicy indicates how we will
+ treat node taints when calculating pod topology spread
+ skew. Options are: - Honor: nodes without taints,
+ along with tainted nodes for which the incoming pod
+ has a toleration, are included. - Ignore: node taints
+ are ignored. All nodes are included. \n If this value
+ is nil, the behavior is equivalent to the Ignore policy.
+ This is a beta-level feature default enabled by the
+ NodeInclusionPolicyInPodTopologySpread feature flag."
type: string
topologyKey:
- description: |-
- TopologyKey is the key of node labels. Nodes that have a label with this key
- and identical values are considered to be in the same topology.
- We consider each as a "bucket", and try to put balanced number
- of pods into each bucket.
- We define a domain as a particular instance of a topology.
- Also, we define an eligible domain as a domain whose nodes meet the requirements of
- nodeAffinityPolicy and nodeTaintsPolicy.
- e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology.
- And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology.
- It's a required field.
+ description: TopologyKey is the key of node labels.
+ Nodes that have a label with this key and identical
+ values are considered to be in the same topology.
+ We consider each as a "bucket", and try
+ to put balanced number of pods into each bucket. We
+ define a domain as a particular instance of a topology.
+ Also, we define an eligible domain as a domain whose
+ nodes meet the requirements of nodeAffinityPolicy
+ and nodeTaintsPolicy. e.g. If TopologyKey is "kubernetes.io/hostname",
+ each Node is a domain of that topology. And, if TopologyKey
+ is "topology.kubernetes.io/zone", each zone is a domain
+ of that topology. It's a required field.
type: string
whenUnsatisfiable:
- description: |-
- WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy
- the spread constraint.
- - DoNotSchedule (default) tells the scheduler not to schedule it.
- - ScheduleAnyway tells the scheduler to schedule the pod in any location,
- but giving higher precedence to topologies that would help reduce the
- skew.
- A constraint is considered "Unsatisfiable" for an incoming pod
- if and only if every possible node assignment for that pod would violate
- "MaxSkew" on some topology.
- For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same
- labelSelector spread as 3/1/1:
- | zone1 | zone2 | zone3 |
- | P P P | P | P |
- If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled
- to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies
- MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler
- won't make it *more* imbalanced.
- It's a required field.
+ description: 'WhenUnsatisfiable indicates how to deal
+ with a pod if it doesn''t satisfy the spread constraint.
+ - DoNotSchedule (default) tells the scheduler not
+ to schedule it. - ScheduleAnyway tells the scheduler
+ to schedule the pod in any location, but giving
+ higher precedence to topologies that would help reduce
+ the skew. A constraint is considered "Unsatisfiable"
+ for an incoming pod if and only if every possible
+ node assignment for that pod would violate "MaxSkew"
+ on some topology. For example, in a 3-zone cluster,
+ MaxSkew is set to 1, and pods with the same labelSelector
+ spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P
+ | P | P | If WhenUnsatisfiable is set to DoNotSchedule,
+ incoming pod can only be scheduled to zone2(zone3)
+ to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3)
+ satisfies MaxSkew(1). In other words, the cluster
+ can still be imbalanced, but scheduler won''t make
+ it *more* imbalanced. It''s a required field.'
type: string
required:
- maxSkew
@@ -4673,36 +4790,37 @@ spec:
may be accessed by any container in the pod.
properties:
awsElasticBlockStore:
- description: |-
- awsElasticBlockStore represents an AWS Disk resource that is attached to a
- kubelet's host machine and then exposed to the pod.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ description: 'awsElasticBlockStore represents an AWS
+ Disk resource that is attached to a kubelet''s host
+ machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
properties:
fsType:
- description: |-
- fsType is the filesystem type of the volume that you want to mount.
- Tip: Ensure that the filesystem type is supported by the host operating system.
- Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
- TODO: how do we prevent errors in the filesystem from compromising the machine
+ description: 'fsType is the filesystem type of the
+ volume that you want to mount. Tip: Ensure that
+ the filesystem type is supported by the host operating
+ system. Examples: "ext4", "xfs", "ntfs". Implicitly
+ inferred to be "ext4" if unspecified. More info:
+ https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
partition:
- description: |-
- partition is the partition in the volume that you want to mount.
- If omitted, the default is to mount by volume name.
- Examples: For volume /dev/sda1, you specify the partition as "1".
- Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
+ description: 'partition is the partition in the
+ volume that you want to mount. If omitted, the
+ default is to mount by volume name. Examples:
+ For volume /dev/sda1, you specify the partition
+ as "1". Similarly, the volume partition for /dev/sda
+ is "0" (or you can leave the property empty).'
format: int32
type: integer
readOnly:
- description: |-
- readOnly value true will force the readOnly setting in VolumeMounts.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ description: 'readOnly value true will force the
+ readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
type: boolean
volumeID:
- description: |-
- volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume).
- More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ description: 'volumeID is unique ID of the persistent
+ disk resource in AWS (Amazon EBS volume). More
+ info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
type: string
required:
- volumeID
@@ -4724,10 +4842,10 @@ spec:
the blob storage
type: string
fsType:
- description: |-
- fsType is Filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: fsType is Filesystem type to mount.
+ Must be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs". Implicitly
+ inferred to be "ext4" if unspecified.
type: string
kind:
description: 'kind expected values are Shared: multiple
@@ -4737,9 +4855,9 @@ spec:
set). defaults to shared'
type: string
readOnly:
- description: |-
- readOnly Defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: readOnly Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
required:
- diskName
@@ -4750,9 +4868,9 @@ spec:
mount on the host and bind mount to the pod.
properties:
readOnly:
- description: |-
- readOnly defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: readOnly defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
secretName:
description: secretName is the name of secret that
@@ -4770,9 +4888,8 @@ spec:
host that shares a pod's lifetime
properties:
monitors:
- description: |-
- monitors is Required: Monitors is a collection of Ceph monitors
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ description: 'monitors is Required: Monitors is
+ a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
items:
type: string
type: array
@@ -4782,72 +4899,65 @@ spec:
is /'
type: string
readOnly:
- description: |-
- readOnly is Optional: Defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ description: 'readOnly is Optional: Defaults to
+ false (read/write). ReadOnly here will force the
+ ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
type: boolean
secretFile:
- description: |-
- secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ description: 'secretFile is Optional: SecretFile
+ is the path to key ring for User, default is /etc/ceph/user.secret
+ More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
type: string
secretRef:
- description: |-
- secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty.
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ description: 'secretRef is Optional: SecretRef is
+ reference to the authentication secret for User,
+ default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
user:
- description: |-
- user is optional: User is the rados user name, default is admin
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ description: 'user is optional: User is the rados
+ user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
type: string
required:
- monitors
type: object
cinder:
- description: |-
- cinder represents a cinder volume attached and mounted on kubelets host machine.
- More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ description: 'cinder represents a cinder volume attached
+ and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
properties:
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ description: 'fsType is the filesystem type to mount.
+ Must be a filesystem type supported by the host
+ operating system. Examples: "ext4", "xfs", "ntfs".
+ Implicitly inferred to be "ext4" if unspecified.
+ More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
type: string
readOnly:
- description: |-
- readOnly defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
- More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ description: 'readOnly defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
type: boolean
secretRef:
- description: |-
- secretRef is optional: points to a secret object containing parameters used to connect
- to OpenStack.
+ description: 'secretRef is optional: points to a
+ secret object containing parameters used to connect
+ to OpenStack.'
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
volumeID:
- description: |-
- volumeID used to identify the volume in cinder.
- More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ description: 'volumeID used to identify the volume
+ in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
type: string
required:
- volumeID
@@ -4857,25 +4967,30 @@ spec:
populate this volume
properties:
defaultMode:
- description: |-
- defaultMode is optional: mode bits used to set permissions on created files by default.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- Defaults to 0644.
- Directories within the path are not affected by this setting.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'defaultMode is optional: mode bits
+ used to set permissions on created files by default.
+ Must be an octal value between 0000 and 0777 or
+ a decimal value between 0 and 511. YAML accepts
+ both octal and decimal values, JSON requires decimal
+ values for mode bits. Defaults to 0644. Directories
+ within the path are not affected by this setting.
+ This might be in conflict with other options that
+ affect the file mode, like fsGroup, and the result
+ can be other mode bits set.'
format: int32
type: integer
items:
- description: |-
- items if unspecified, each key-value pair in the Data field of the referenced
- ConfigMap will be projected into the volume as a file whose name is the
- key and content is the value. If specified, the listed keys will be
- projected into the specified paths, and unlisted keys will not be
- present. If a key is specified which is not present in the ConfigMap,
- the volume setup will error unless it is marked optional. Paths must be
- relative and may not contain the '..' path or start with '..'.
+ description: items if unspecified, each key-value
+ pair in the Data field of the referenced ConfigMap
+ will be projected into the volume as a file whose
+ name is the key and content is the value. If specified,
+ the listed keys will be projected into the specified
+ paths, and unlisted keys will not be present.
+ If a key is specified which is not present in
+ the ConfigMap, the volume setup will error unless
+ it is marked optional. Paths must be relative
+ and may not contain the '..' path or start with
+ '..'.
items:
description: Maps a string key to a path within
a volume.
@@ -4884,21 +4999,25 @@ spec:
description: key is the key to project.
type: string
mode:
- description: |-
- mode is Optional: mode bits used to set permissions on this file.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'mode is Optional: mode bits
+ used to set permissions on this file. Must
+ be an octal value between 0000 and 0777
+ or a decimal value between 0 and 511. YAML
+ accepts both octal and decimal values, JSON
+ requires decimal values for mode bits. If
+ not specified, the volume defaultMode will
+ be used. This might be in conflict with
+ other options that affect the file mode,
+ like fsGroup, and the result can be other
+ mode bits set.'
format: int32
type: integer
path:
- description: |-
- path is the relative path of the file to map the key to.
- May not be an absolute path.
- May not contain the path element '..'.
- May not start with the string '..'.
+ description: path is the relative path of
+ the file to map the key to. May not be an
+ absolute path. May not contain the path
+ element '..'. May not start with the string
+ '..'.
type: string
required:
- key
@@ -4906,60 +5025,59 @@ spec:
type: object
type: array
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
description: optional specify whether the ConfigMap
or its keys must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
csi:
description: csi (Container Storage Interface) represents
ephemeral storage that is handled by certain external
CSI drivers (Beta feature).
properties:
driver:
- description: |-
- driver is the name of the CSI driver that handles this volume.
- Consult with your admin for the correct name as registered in the cluster.
+ description: driver is the name of the CSI driver
+ that handles this volume. Consult with your admin
+ for the correct name as registered in the cluster.
type: string
fsType:
- description: |-
- fsType to mount. Ex. "ext4", "xfs", "ntfs".
- If not provided, the empty value is passed to the associated CSI driver
- which will determine the default filesystem to apply.
+ description: fsType to mount. Ex. "ext4", "xfs",
+ "ntfs". If not provided, the empty value is passed
+ to the associated CSI driver which will determine
+ the default filesystem to apply.
type: string
nodePublishSecretRef:
- description: |-
- nodePublishSecretRef is a reference to the secret object containing
- sensitive information to pass to the CSI driver to complete the CSI
+ 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.
+ This field is optional, and may be empty if no
+ secret is required. If the secret object contains
+ more than one secret, all secret references are
+ passed.
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
readOnly:
- description: |-
- readOnly specifies a read-only configuration for the volume.
- Defaults to false (read/write).
+ description: readOnly specifies a read-only configuration
+ for the volume. Defaults to false (read/write).
type: boolean
volumeAttributes:
additionalProperties:
type: string
- description: |-
- volumeAttributes stores driver-specific properties that are passed to the CSI
- driver. Consult your driver's documentation for supported values.
+ description: volumeAttributes stores driver-specific
+ properties that are passed to the CSI driver.
+ Consult your driver's documentation for supported
+ values.
type: object
required:
- driver
@@ -4969,15 +5087,17 @@ spec:
the pod that should populate this volume
properties:
defaultMode:
- description: |-
- Optional: mode bits to use on created files by default. Must be a
- Optional: mode bits used to set permissions on created files by default.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- Defaults to 0644.
- Directories within the path are not affected by this setting.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'Optional: mode bits to use on created
+ files by default. Must be a Optional: mode bits
+ used to set permissions on created files by default.
+ Must be an octal value between 0000 and 0777 or
+ a decimal value between 0 and 511. YAML accepts
+ both octal and decimal values, JSON requires decimal
+ values for mode bits. Defaults to 0644. Directories
+ within the path are not affected by this setting.
+ This might be in conflict with other options that
+ affect the file mode, like fsGroup, and the result
+ can be other mode bits set.'
format: int32
type: integer
items:
@@ -5005,15 +5125,17 @@ spec:
required:
- fieldPath
type: object
- x-kubernetes-map-type: atomic
mode:
- description: |-
- Optional: mode bits used to set permissions on this file, must be an octal value
- between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'Optional: mode bits used to
+ set permissions on this file, must be an
+ octal value between 0000 and 0777 or a decimal
+ value between 0 and 511. YAML accepts both
+ octal and decimal values, JSON requires
+ decimal values for mode bits. If not specified,
+ the volume defaultMode will be used. This
+ might be in conflict with other options
+ that affect the file mode, like fsGroup,
+ and the result can be other mode bits set.'
format: int32
type: integer
path:
@@ -5024,9 +5146,10 @@ spec:
the relative path must not start with ''..'''
type: string
resourceFieldRef:
- description: |-
- Selects a resource of the container: only resources limits and requests
- (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
+ description: 'Selects a resource of the container:
+ only resources limits and requests (limits.cpu,
+ limits.memory, requests.cpu and requests.memory)
+ are currently supported.'
properties:
containerName:
description: 'Container name: required
@@ -5047,132 +5170,128 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
required:
- path
type: object
type: array
type: object
emptyDir:
- description: |-
- emptyDir represents a temporary directory that shares a pod's lifetime.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
+ description: 'emptyDir represents a temporary directory
+ that shares a pod''s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
properties:
medium:
- description: |-
- medium represents what type of storage medium should back this directory.
- The default is "" which means to use the node's default medium.
- Must be an empty string (default) or Memory.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
+ description: 'medium represents what type of storage
+ medium should back this directory. The default
+ is "" which means to use the node''s default medium.
+ Must be an empty string (default) or Memory. More
+ info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
type: string
sizeLimit:
anyOf:
- type: integer
- type: string
- description: |-
- sizeLimit is the total amount of local storage required for this EmptyDir volume.
- The size limit is also applicable for memory medium.
- The maximum usage on memory medium EmptyDir would be the minimum value between
- the SizeLimit specified here and the sum of memory limits of all containers in a pod.
- The default is nil which means that the limit is undefined.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
+ description: 'sizeLimit is the total amount of local
+ storage required for this EmptyDir volume. The
+ size limit is also applicable for memory medium.
+ The maximum usage on memory medium EmptyDir would
+ be the minimum value between the SizeLimit specified
+ here and the sum of memory limits of all containers
+ in a pod. The default is nil which means that
+ the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
type: object
ephemeral:
- description: |-
- ephemeral represents a volume that is handled by a cluster storage driver.
- The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts,
- and deleted when the pod is removed.
-
-
- Use this if:
- a) the volume is only needed while the pod runs,
- b) features of normal volumes like restoring from snapshot or capacity
- tracking are needed,
- c) the storage driver is specified through a storage class, and
- d) the storage driver supports dynamic volume provisioning through
- a PersistentVolumeClaim (see EphemeralVolumeSource for more
- information on the connection between this volume type
- and PersistentVolumeClaim).
-
-
+ description: "ephemeral represents a volume that is
+ handled by a cluster storage driver. The volume's
+ lifecycle is tied to the pod that defines it - it
+ will be created before the pod starts, and deleted
+ when the pod is removed. \n Use this if: a) the volume
+ is only needed while the pod runs, b) features of
+ normal volumes like restoring from snapshot or capacity
+ \ tracking are needed, c) the storage driver is
+ specified through a storage class, and d) the storage
+ driver supports dynamic volume provisioning through
+ \ a PersistentVolumeClaim (see EphemeralVolumeSource
+ for more information on the connection between
+ this volume type and PersistentVolumeClaim). \n
Use PersistentVolumeClaim or one of the vendor-specific
- APIs for volumes that persist for longer than the lifecycle
- of an individual pod.
-
-
- Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to
- be used that way - see the documentation of the driver for
- more information.
-
-
- A pod can use both types of ephemeral volumes and
- persistent volumes at the same time.
+ APIs for volumes that persist for longer than the
+ lifecycle of an individual pod. \n Use CSI for light-weight
+ local ephemeral volumes if the CSI driver is meant
+ to be used that way - see the documentation of the
+ driver for more information. \n A pod can use both
+ types of ephemeral volumes and persistent volumes
+ at the same time."
properties:
volumeClaimTemplate:
- description: |-
- Will be used to create a stand-alone PVC to provision the volume.
- The pod in which this EphemeralVolumeSource is embedded will be the
- owner of the PVC, i.e. the PVC will be deleted together with the
- pod. The name of the PVC will be `-` where
- `` is the name from the `PodSpec.Volumes` array
- entry. Pod validation will reject the pod if the concatenated name
- is not valid for a PVC (for example, too long).
-
-
- An existing PVC with that name that is not owned by the pod
- will *not* be used for the pod to avoid using an unrelated
- volume by mistake. Starting the pod is then blocked until
- the unrelated PVC is removed. If such a pre-created PVC is
- meant to be used by the pod, the PVC has to updated with an
- owner reference to the pod once the pod exists. Normally
- this should not be necessary, but it may be useful when
- manually reconstructing a broken cluster.
-
-
- This field is read-only and no changes will be made by Kubernetes
- to the PVC after it has been created.
-
-
- Required, must not be nil.
+ description: "Will be used to create a stand-alone
+ PVC to provision the volume. The pod in which
+ this EphemeralVolumeSource is embedded will be
+ the owner of the PVC, i.e. the PVC will be deleted
+ together with the pod. The name of the PVC will
+ be `-` where ``
+ is the name from the `PodSpec.Volumes` array entry.
+ Pod validation will reject the pod if the concatenated
+ name is not valid for a PVC (for example, too
+ long). \n An existing PVC with that name that
+ is not owned by the pod will *not* be used for
+ the pod to avoid using an unrelated volume by
+ mistake. Starting the pod is then blocked until
+ the unrelated PVC is removed. If such a pre-created
+ PVC is meant to be used by the pod, the PVC has
+ to updated with an owner reference to the pod
+ once the pod exists. Normally this should not
+ be necessary, but it may be useful when manually
+ reconstructing a broken cluster. \n This field
+ is read-only and no changes will be made by Kubernetes
+ to the PVC after it has been created. \n Required,
+ must not be nil."
properties:
metadata:
- description: |-
- May contain labels and annotations that will be copied into the PVC
- when creating it. No other fields are allowed and will be rejected during
- validation.
+ description: May contain labels and annotations
+ that will be copied into the PVC when creating
+ it. No other fields are allowed and will be
+ rejected during validation.
type: object
spec:
- description: |-
- The specification for the PersistentVolumeClaim. The entire content is
- copied unchanged into the PVC that gets created from this
- template. The same fields as in a PersistentVolumeClaim
+ description: The specification for the PersistentVolumeClaim.
+ The entire content is copied unchanged into
+ the PVC that gets created from this template.
+ The same fields as in a PersistentVolumeClaim
are also valid here.
properties:
accessModes:
- description: |-
- accessModes contains the desired access modes the volume should have.
- More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
+ description: 'accessModes contains the desired
+ access modes the volume should have. More
+ info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
items:
type: string
type: array
dataSource:
- description: |-
- dataSource field can be used to specify either:
- * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
+ description: 'dataSource field can be used
+ to specify either: * An existing VolumeSnapshot
+ object (snapshot.storage.k8s.io/VolumeSnapshot)
* An existing PVC (PersistentVolumeClaim)
- If the provisioner or an external controller can support the specified data source,
- it will create a new volume based on the contents of the specified data source.
- When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,
- and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.
- If the namespace is specified, then dataSourceRef will not be copied to dataSource.
+ If the provisioner or an external controller
+ can support the specified data source,
+ it will create a new volume based on the
+ contents of the specified data source.
+ When the AnyVolumeDataSource feature gate
+ is enabled, dataSource contents will be
+ copied to dataSourceRef, and dataSourceRef
+ contents will be copied to dataSource
+ when dataSourceRef.namespace is not specified.
+ If the namespace is specified, then dataSourceRef
+ will not be copied to dataSource.'
properties:
apiGroup:
- description: |-
- APIGroup is the group for the resource being referenced.
- If APIGroup is not specified, the specified Kind must be in the core API group.
- For any other third-party types, APIGroup is required.
+ description: APIGroup is the group for
+ the resource being referenced. If
+ APIGroup is not specified, the specified
+ Kind must be in the core API group.
+ For any other third-party types, APIGroup
+ is required.
type: string
kind:
description: Kind is the type of resource
@@ -5186,38 +5305,51 @@ spec:
- kind
- name
type: object
- x-kubernetes-map-type: atomic
dataSourceRef:
- description: |-
- dataSourceRef specifies the object from which to populate the volume with data, if a non-empty
- volume is desired. This may be any object from a non-empty API group (non
- core object) or a PersistentVolumeClaim object.
- When this field is specified, volume binding will only succeed if the type of
- the specified object matches some installed volume populator or dynamic
- provisioner.
- This field will replace the functionality of the dataSource field and as such
- if both fields are non-empty, they must have the same value. For backwards
- compatibility, when namespace isn't specified in dataSourceRef,
- both fields (dataSource and dataSourceRef) will be set to the same
- value automatically if one of them is empty and the other is non-empty.
- When namespace is specified in dataSourceRef,
- dataSource isn't set to the same value and must be empty.
- There are three important differences between dataSource and dataSourceRef:
- * While dataSource only allows two specific types of objects, dataSourceRef
- allows any non-core object, as well as PersistentVolumeClaim objects.
- * While dataSource ignores disallowed values (dropping them), dataSourceRef
- preserves all values, and generates an error if a disallowed value is
- specified.
- * While dataSource only allows local objects, dataSourceRef allows objects
- in any namespaces.
- (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
- (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
+ description: 'dataSourceRef specifies the
+ object from which to populate the volume
+ with data, if a non-empty volume is desired.
+ This may be any object from a non-empty
+ API group (non core object) or a PersistentVolumeClaim
+ object. When this field is specified,
+ volume binding will only succeed if the
+ type of the specified object matches some
+ installed volume populator or dynamic
+ provisioner. This field will replace the
+ functionality of the dataSource field
+ and as such if both fields are non-empty,
+ they must have the same value. For backwards
+ compatibility, when namespace isn''t specified
+ in dataSourceRef, both fields (dataSource
+ and dataSourceRef) will be set to the
+ same value automatically if one of them
+ is empty and the other is non-empty. When
+ namespace is specified in dataSourceRef,
+ dataSource isn''t set to the same value
+ and must be empty. There are three important
+ differences between dataSource and dataSourceRef:
+ * While dataSource only allows two specific
+ types of objects, dataSourceRef allows
+ any non-core object, as well as PersistentVolumeClaim
+ objects. * While dataSource ignores disallowed
+ values (dropping them), dataSourceRef preserves
+ all values, and generates an error if
+ a disallowed value is specified. * While
+ dataSource only allows local objects,
+ dataSourceRef allows objects in any
+ namespaces. (Beta) Using this field requires
+ the AnyVolumeDataSource feature gate to
+ be enabled. (Alpha) Using the namespace
+ field of dataSourceRef requires the CrossNamespaceVolumeDataSource
+ feature gate to be enabled.'
properties:
apiGroup:
- description: |-
- APIGroup is the group for the resource being referenced.
- If APIGroup is not specified, the specified Kind must be in the core API group.
- For any other third-party types, APIGroup is required.
+ description: APIGroup is the group for
+ the resource being referenced. If
+ APIGroup is not specified, the specified
+ Kind must be in the core API group.
+ For any other third-party types, APIGroup
+ is required.
type: string
kind:
description: Kind is the type of resource
@@ -5228,22 +5360,31 @@ spec:
being referenced
type: string
namespace:
- description: |-
- Namespace is the namespace of resource being referenced
- Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.
- (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
+ description: Namespace is the namespace
+ of resource being referenced Note
+ that when a namespace is specified,
+ a gateway.networking.k8s.io/ReferenceGrant
+ object is required in the referent
+ namespace to allow that namespace's
+ owner to accept the reference. See
+ the ReferenceGrant documentation for
+ details. (Alpha) This field requires
+ the CrossNamespaceVolumeDataSource
+ feature gate to be enabled.
type: string
required:
- kind
- name
type: object
resources:
- description: |-
- resources represents the minimum resources the volume should have.
- If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements
- that are lower than previous value but must still be higher than capacity recorded in the
- status field of the claim.
- More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
+ description: 'resources represents the minimum
+ resources the volume should have. If RecoverVolumeExpansionFailure
+ feature is enabled users are allowed to
+ specify resource requirements that are
+ lower than previous value but must still
+ be higher than capacity recorded in the
+ status field of the claim. More info:
+ https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
properties:
limits:
additionalProperties:
@@ -5252,9 +5393,9 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Limits describes the maximum amount of compute resources allowed.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Limits describes the maximum
+ amount of compute resources allowed.
+ More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -5263,11 +5404,14 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Requests describes the minimum amount of compute resources required.
- If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
- otherwise to an implementation-defined value. Requests cannot exceed Limits.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Requests describes the
+ minimum amount of compute resources
+ required. If Requests is omitted for
+ a container, it defaults to Limits
+ if that is explicitly specified, otherwise
+ to an implementation-defined value.
+ Requests cannot exceed Limits. More
+ info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
selector:
@@ -5279,9 +5423,10 @@ spec:
of label selector requirements. The
requirements are ANDed.
items:
- description: |-
- A label selector requirement is a selector that contains values, a key, and an operator that
- relates the key and values.
+ description: A label selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
description: key is the label
@@ -5289,16 +5434,20 @@ spec:
to.
type: string
operator:
- description: |-
- operator represents a key's relationship to a set of values.
- Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents
+ a key's relationship to a set
+ of values. Valid operators are
+ In, NotIn, Exists and DoesNotExist.
type: string
values:
- description: |-
- values is an array of string values. If the operator is In or NotIn,
- the values array must be non-empty. If the operator is Exists or DoesNotExist,
- the values array must be empty. This array is replaced during a strategic
- merge patch.
+ description: values is an array
+ of string values. If the operator
+ is In or NotIn, the values array
+ must be non-empty. If the operator
+ is Exists or DoesNotExist, the
+ values array must be empty.
+ This array is replaced during
+ a strategic merge patch.
items:
type: string
type: array
@@ -5310,37 +5459,52 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: |-
- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions, whose key field is "key", the
- operator is "In", and the values array contains only "value". The requirements are ANDed.
+ description: matchLabels is a map of
+ {key,value} pairs. A single {key,value}
+ in the matchLabels map is equivalent
+ to an element of matchExpressions,
+ whose key field is "key", the operator
+ is "In", and the values array contains
+ only "value". The requirements are
+ ANDed.
type: object
type: object
- x-kubernetes-map-type: atomic
storageClassName:
- description: |-
- storageClassName is the name of the StorageClass required by the claim.
- More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
+ description: 'storageClassName is the name
+ of the StorageClass required by the claim.
+ More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
type: string
volumeAttributesClassName:
- description: |-
- volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.
- If specified, the CSI driver will create or update the volume with the attributes defined
- in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,
- it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass
- will be applied to the claim but it's not allowed to reset this field to empty string once it is set.
- If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass
- will be set by the persistentvolume controller if it exists.
- If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be
- set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource
- exists.
- More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass
- (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.
+ description: 'volumeAttributesClassName
+ may be used to set the VolumeAttributesClass
+ used by this claim. If specified, the
+ CSI driver will create or update the volume
+ with the attributes defined in the corresponding
+ VolumeAttributesClass. This has a different
+ purpose than storageClassName, it can
+ be changed after the claim is created.
+ An empty string value means that no VolumeAttributesClass
+ will be applied to the claim but it''s
+ not allowed to reset this field to empty
+ string once it is set. If unspecified
+ and the PersistentVolumeClaim is unbound,
+ the default VolumeAttributesClass will
+ be set by the persistentvolume controller
+ if it exists. If the resource referred
+ to by volumeAttributesClass does not exist,
+ this PersistentVolumeClaim will be set
+ to a Pending state, as reflected by the
+ modifyVolumeStatus field, until such as
+ a resource exists. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass
+ (Alpha) Using this field requires the
+ VolumeAttributesClass feature gate to
+ be enabled.'
type: string
volumeMode:
- description: |-
- volumeMode defines what type of volume is required by the claim.
- Value of Filesystem is implied when not included in claim spec.
+ description: volumeMode defines what type
+ of volume is required by the claim. Value
+ of Filesystem is implied when not included
+ in claim spec.
type: string
volumeName:
description: volumeName is the binding reference
@@ -5357,20 +5521,21 @@ spec:
exposed to the pod.
properties:
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- TODO: how do we prevent errors in the filesystem from compromising the machine
+ description: 'fsType is the filesystem type to mount.
+ Must be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs". Implicitly
+ inferred to be "ext4" if unspecified. TODO: how
+ do we prevent errors in the filesystem from compromising
+ the machine'
type: string
lun:
description: 'lun is Optional: FC target lun number'
format: int32
type: integer
readOnly:
- description: |-
- readOnly is Optional: Defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: 'readOnly is Optional: Defaults to
+ false (read/write). ReadOnly here will force the
+ ReadOnly setting in VolumeMounts.'
type: boolean
targetWWNs:
description: 'targetWWNs is Optional: FC target
@@ -5379,27 +5544,28 @@ spec:
type: string
type: array
wwids:
- description: |-
- wwids Optional: FC volume world wide identifiers (wwids)
- Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
+ description: 'wwids Optional: FC volume world wide
+ identifiers (wwids) Either wwids or combination
+ of targetWWNs and lun must be set, but not both
+ simultaneously.'
items:
type: string
type: array
type: object
flexVolume:
- description: |-
- flexVolume represents a generic volume resource that is
- provisioned/attached using an exec based plugin.
+ description: flexVolume represents a generic volume
+ resource that is provisioned/attached using an exec
+ based plugin.
properties:
driver:
description: driver is the name of the driver to
use for this volume.
type: string
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
+ description: fsType is the filesystem type to mount.
+ Must be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs". The
+ default filesystem depends on FlexVolume script.
type: string
options:
additionalProperties:
@@ -5408,26 +5574,25 @@ spec:
extra command options if any.'
type: object
readOnly:
- description: |-
- readOnly is Optional: defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: 'readOnly is Optional: defaults to
+ false (read/write). ReadOnly here will force the
+ ReadOnly setting in VolumeMounts.'
type: boolean
secretRef:
- description: |-
- secretRef is Optional: secretRef is reference to the secret object containing
- sensitive information to pass to the plugin scripts. This may be
- empty if no secret object is specified. If the secret object
- contains more than one secret, all secrets are passed to the plugin
- scripts.
+ description: 'secretRef is Optional: secretRef is
+ reference to the secret object containing sensitive
+ information to pass to the plugin scripts. This
+ may be empty if no secret object is specified.
+ If the secret object contains more than one secret,
+ all secrets are passed to the plugin scripts.'
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
required:
- driver
type: object
@@ -5437,9 +5602,9 @@ spec:
control service being running
properties:
datasetName:
- description: |-
- datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker
- should be considered as deprecated
+ description: datasetName is Name of the dataset
+ stored as metadata -> name on the dataset for
+ Flocker should be considered as deprecated
type: string
datasetUUID:
description: datasetUUID is the UUID of the dataset.
@@ -5447,55 +5612,57 @@ spec:
type: string
type: object
gcePersistentDisk:
- description: |-
- gcePersistentDisk represents a GCE Disk resource that is attached to a
- kubelet's host machine and then exposed to the pod.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ description: 'gcePersistentDisk represents a GCE Disk
+ resource that is attached to a kubelet''s host machine
+ and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
properties:
fsType:
- description: |-
- fsType is filesystem type of the volume that you want to mount.
- Tip: Ensure that the filesystem type is supported by the host operating system.
- Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
- TODO: how do we prevent errors in the filesystem from compromising the machine
+ description: 'fsType is filesystem type of the volume
+ that you want to mount. Tip: Ensure that the filesystem
+ type is supported by the host operating system.
+ Examples: "ext4", "xfs", "ntfs". Implicitly inferred
+ to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
partition:
- description: |-
- partition is the partition in the volume that you want to mount.
- If omitted, the default is to mount by volume name.
- Examples: For volume /dev/sda1, you specify the partition as "1".
- Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ description: 'partition is the partition in the
+ volume that you want to mount. If omitted, the
+ default is to mount by volume name. Examples:
+ For volume /dev/sda1, you specify the partition
+ as "1". Similarly, the volume partition for /dev/sda
+ is "0" (or you can leave the property empty).
+ More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
format: int32
type: integer
pdName:
- description: |-
- pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ description: 'pdName is unique name of the PD resource
+ in GCE. Used to identify the disk in GCE. More
+ info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
type: string
readOnly:
- description: |-
- readOnly here will force the ReadOnly setting in VolumeMounts.
- Defaults to false.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ description: 'readOnly here will force the ReadOnly
+ setting in VolumeMounts. Defaults to false. More
+ info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
type: boolean
required:
- pdName
type: object
gitRepo:
- description: |-
- gitRepo represents a git repository at a particular revision.
- DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an
- EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir
- into the Pod's container.
+ description: 'gitRepo represents a git repository at
+ a particular revision. DEPRECATED: GitRepo is deprecated.
+ To provision a container with a git repo, mount an
+ EmptyDir into an InitContainer that clones the repo
+ using git, then mount the EmptyDir into the Pod''s
+ container.'
properties:
directory:
- description: |-
- directory is the target directory name.
- Must not contain or start with '..'. If '.' is supplied, the volume directory will be the
- git repository. Otherwise, if specified, the volume will contain the git repository in
- the subdirectory with the given name.
+ description: directory is the target directory name.
+ Must not contain or start with '..'. If '.' is
+ supplied, the volume directory will be the git
+ repository. Otherwise, if specified, the volume
+ will contain the git repository in the subdirectory
+ with the given name.
type: string
repository:
description: repository is the URL
@@ -5508,61 +5675,54 @@ spec:
- repository
type: object
glusterfs:
- description: |-
- glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.
- More info: https://examples.k8s.io/volumes/glusterfs/README.md
+ description: 'glusterfs represents a Glusterfs mount
+ on the host that shares a pod''s lifetime. More info:
+ https://examples.k8s.io/volumes/glusterfs/README.md'
properties:
endpoints:
- description: |-
- endpoints is the endpoint name that details Glusterfs topology.
- More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
+ description: 'endpoints is the endpoint name that
+ details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: string
path:
- description: |-
- path is the Glusterfs volume path.
- More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
+ description: 'path is the Glusterfs volume path.
+ More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: string
readOnly:
- description: |-
- readOnly here will force the Glusterfs volume to be mounted with read-only permissions.
- Defaults to false.
- More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
+ description: 'readOnly here will force the Glusterfs
+ volume to be mounted with read-only permissions.
+ Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: boolean
required:
- endpoints
- path
type: object
hostPath:
- description: |-
- hostPath represents a pre-existing file or directory on the host
- machine that is directly exposed to the container. This is generally
- used for system agents or other privileged things that are allowed
- to see the host machine. Most containers will NOT need this.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
- ---
- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not
- mount host directories as read/write.
+ description: 'hostPath represents a pre-existing file
+ or directory on the host machine that is directly
+ exposed to the container. This is generally used for
+ system agents or other privileged things that are
+ allowed to see the host machine. Most containers will
+ NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
+ --- TODO(jonesdl) We need to restrict who can use
+ host directory mounts and who can/can not mount host
+ directories as read/write.'
properties:
path:
- description: |-
- path of the directory on the host.
- If the path is a symlink, it will follow the link to the real path.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
+ description: 'path of the directory on the host.
+ If the path is a symlink, it will follow the link
+ to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
type: string
type:
- description: |-
- type for HostPath Volume
- Defaults to ""
- More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
+ description: 'type for HostPath Volume Defaults
+ to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
type: string
required:
- path
type: object
iscsi:
- description: |-
- iscsi represents an ISCSI Disk resource that is attached to a
- kubelet's host machine and then exposed to the pod.
- More info: https://examples.k8s.io/volumes/iscsi/README.md
+ description: 'iscsi represents an ISCSI Disk resource
+ that is attached to a kubelet''s host machine and
+ then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md'
properties:
chapAuthDiscovery:
description: chapAuthDiscovery defines whether support
@@ -5573,59 +5733,61 @@ spec:
iSCSI Session CHAP authentication
type: boolean
fsType:
- description: |-
- fsType is the filesystem type of the volume that you want to mount.
- Tip: Ensure that the filesystem type is supported by the host operating system.
- Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
- TODO: how do we prevent errors in the filesystem from compromising the machine
+ description: 'fsType is the filesystem type of the
+ volume that you want to mount. Tip: Ensure that
+ the filesystem type is supported by the host operating
+ system. Examples: "ext4", "xfs", "ntfs". Implicitly
+ inferred to be "ext4" if unspecified. More info:
+ https://kubernetes.io/docs/concepts/storage/volumes#iscsi
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
initiatorName:
- description: |-
- initiatorName is the custom iSCSI Initiator Name.
- If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface
- : will be created for the connection.
+ description: initiatorName is the custom iSCSI Initiator
+ Name. If initiatorName is specified with iscsiInterface
+ simultaneously, new iSCSI interface : will be created for the connection.
type: string
iqn:
description: iqn is the target iSCSI Qualified Name.
type: string
iscsiInterface:
- description: |-
- iscsiInterface is the interface Name that uses an iSCSI transport.
- Defaults to 'default' (tcp).
+ description: iscsiInterface is the interface Name
+ that uses an iSCSI transport. Defaults to 'default'
+ (tcp).
type: string
lun:
description: lun represents iSCSI Target Lun number.
format: int32
type: integer
portals:
- description: |-
- portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port
- is other than default (typically TCP ports 860 and 3260).
+ description: portals is the iSCSI Target Portal
+ List. The portal is either an IP or ip_addr:port
+ if the port is other than default (typically TCP
+ ports 860 and 3260).
items:
type: string
type: array
readOnly:
- description: |-
- readOnly here will force the ReadOnly setting in VolumeMounts.
- Defaults to false.
+ description: readOnly here will force the ReadOnly
+ setting in VolumeMounts. Defaults to false.
type: boolean
secretRef:
description: secretRef is the CHAP Secret for iSCSI
target and initiator authentication
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
targetPortal:
- description: |-
- targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port
- is other than default (typically TCP ports 860 and 3260).
+ description: targetPortal is iSCSI Target Portal.
+ The Portal is either an IP or ip_addr:port if
+ the port is other than default (typically TCP
+ ports 860 and 3260).
type: string
required:
- iqn
@@ -5633,51 +5795,43 @@ spec:
- targetPortal
type: object
name:
- description: |-
- name of the volume.
- Must be a DNS_LABEL and unique within the pod.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ description: 'name of the volume. Must be a DNS_LABEL
+ and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
type: string
nfs:
- description: |-
- nfs represents an NFS mount on the host that shares a pod's lifetime
- More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ description: 'nfs represents an NFS mount on the host
+ that shares a pod''s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
properties:
path:
- description: |-
- path that is exported by the NFS server.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ description: 'path that is exported by the NFS server.
+ More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: string
readOnly:
- description: |-
- readOnly here will force the NFS export to be mounted with read-only permissions.
- Defaults to false.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ description: 'readOnly here will force the NFS export
+ to be mounted with read-only permissions. Defaults
+ to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: boolean
server:
- description: |-
- server is the hostname or IP address of the NFS server.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ description: 'server is the hostname or IP address
+ of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: string
required:
- path
- server
type: object
persistentVolumeClaim:
- description: |-
- persistentVolumeClaimVolumeSource represents a reference to a
- PersistentVolumeClaim in the same namespace.
- More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
+ description: 'persistentVolumeClaimVolumeSource represents
+ a reference to a PersistentVolumeClaim in the same
+ namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
properties:
claimName:
- description: |-
- claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.
- More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
+ description: 'claimName is the name of a PersistentVolumeClaim
+ in the same namespace as the pod using this volume.
+ More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
type: string
readOnly:
- description: |-
- readOnly Will force the ReadOnly setting in VolumeMounts.
- Default false.
+ description: readOnly Will force the ReadOnly setting
+ in VolumeMounts. Default false.
type: boolean
required:
- claimName
@@ -5688,10 +5842,10 @@ spec:
machine
properties:
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: fsType is the filesystem type to mount.
+ Must be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs". Implicitly
+ inferred to be "ext4" if unspecified.
type: string
pdID:
description: pdID is the ID that identifies Photon
@@ -5705,15 +5859,15 @@ spec:
attached and mounted on kubelets host machine
properties:
fsType:
- description: |-
- fSType represents the filesystem type to mount
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
+ description: fSType represents the filesystem type
+ to mount Must be a filesystem type supported by
+ the host operating system. Ex. "ext4", "xfs".
+ Implicitly inferred to be "ext4" if unspecified.
type: string
readOnly:
- description: |-
- readOnly defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: readOnly defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
volumeID:
description: volumeID uniquely identifies a Portworx
@@ -5727,13 +5881,16 @@ spec:
secrets, configmaps, and downward API
properties:
defaultMode:
- description: |-
- defaultMode are the mode bits used to set permissions on created files by default.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- Directories within the path are not affected by this setting.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: defaultMode are the mode bits used
+ to set permissions on created files by default.
+ Must be an octal value between 0000 and 0777 or
+ a decimal value between 0 and 511. YAML accepts
+ both octal and decimal values, JSON requires decimal
+ values for mode bits. Directories within the path
+ are not affected by this setting. This might be
+ in conflict with other options that affect the
+ file mode, like fsGroup, and the result can be
+ other mode bits set.
format: int32
type: integer
sources:
@@ -5743,39 +5900,39 @@ spec:
along with other supported volume types
properties:
clusterTrustBundle:
- description: |-
- ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field
- of ClusterTrustBundle objects in an auto-updating file.
-
-
- Alpha, gated by the ClusterTrustBundleProjection feature gate.
-
-
- ClusterTrustBundle objects can either be selected by name, or by the
+ description: "ClusterTrustBundle allows a
+ pod to access the `.spec.trustBundle` field
+ of ClusterTrustBundle objects in an auto-updating
+ file. \n Alpha, gated by the ClusterTrustBundleProjection
+ feature gate. \n ClusterTrustBundle objects
+ can either be selected by name, or by the
combination of signer name and a label selector.
-
-
- Kubelet performs aggressive normalization of the PEM contents written
- into the pod filesystem. Esoteric PEM features such as inter-block
- comments and block headers are stripped. Certificates are deduplicated.
- The ordering of certificates within the file is arbitrary, and Kubelet
- may change the order over time.
+ \n Kubelet performs aggressive normalization
+ of the PEM contents written into the pod
+ filesystem. Esoteric PEM features such
+ as inter-block comments and block headers
+ are stripped. Certificates are deduplicated.
+ The ordering of certificates within the
+ file is arbitrary, and Kubelet may change
+ the order over time."
properties:
labelSelector:
- description: |-
- Select all ClusterTrustBundles that match this label selector. Only has
- effect if signerName is set. Mutually-exclusive with name. If unset,
- interpreted as "match nothing". If set but empty, interpreted as "match
- everything".
+ description: Select all ClusterTrustBundles
+ that match this label selector. Only
+ has effect if signerName is set. Mutually-exclusive
+ with name. If unset, interpreted as
+ "match nothing". If set but empty,
+ interpreted as "match everything".
properties:
matchExpressions:
description: matchExpressions is a
list of label selector requirements.
The requirements are ANDed.
items:
- description: |-
- A label selector requirement is a selector that contains values, a key, and an operator that
- relates the key and values.
+ description: A label selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
description: key is the label
@@ -5783,15 +5940,21 @@ spec:
to.
type: string
operator:
- description: |-
- operator represents a key's relationship to a set of values.
- Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents
+ a key's relationship to a
+ set of values. Valid operators
+ are In, NotIn, Exists and
+ DoesNotExist.
type: string
values:
- description: |-
- values is an array of string values. If the operator is In or NotIn,
- the values array must be non-empty. If the operator is Exists or DoesNotExist,
- the values array must be empty. This array is replaced during a strategic
+ description: values is an array
+ of string values. If the operator
+ is In or NotIn, the values
+ array must be non-empty. If
+ the operator is Exists or
+ DoesNotExist, the values array
+ must be empty. This array
+ is replaced during a strategic
merge patch.
items:
type: string
@@ -5804,24 +5967,29 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: |-
- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions, whose key field is "key", the
- operator is "In", and the values array contains only "value". The requirements are ANDed.
+ description: matchLabels is a map
+ of {key,value} pairs. A single {key,value}
+ in the matchLabels map is equivalent
+ to an element of matchExpressions,
+ whose key field is "key", the operator
+ is "In", and the values array contains
+ only "value". The requirements are
+ ANDed.
type: object
type: object
- x-kubernetes-map-type: atomic
name:
- description: |-
- Select a single ClusterTrustBundle by object name. Mutually-exclusive
+ description: Select a single ClusterTrustBundle
+ by object name. Mutually-exclusive
with signerName and labelSelector.
type: string
optional:
- description: |-
- If true, don't block pod startup if the referenced ClusterTrustBundle(s)
- aren't available. If using name, then the named ClusterTrustBundle is
- allowed not to exist. If using signerName, then the combination of
- signerName and labelSelector is allowed to match zero
+ description: If true, don't block pod
+ startup if the referenced ClusterTrustBundle(s)
+ aren't available. If using name, then
+ the named ClusterTrustBundle is allowed
+ not to exist. If using signerName,
+ then the combination of signerName and
+ labelSelector is allowed to match zero
ClusterTrustBundles.
type: boolean
path:
@@ -5829,10 +5997,11 @@ spec:
root to write the bundle.
type: string
signerName:
- description: |-
- Select all ClusterTrustBundles that match this signer name.
- Mutually-exclusive with name. The contents of all selected
- ClusterTrustBundles will be unified and deduplicated.
+ description: Select all ClusterTrustBundles
+ that match this signer name. Mutually-exclusive
+ with name. The contents of all selected
+ ClusterTrustBundles will be unified
+ and deduplicated.
type: string
required:
- path
@@ -5842,14 +6011,19 @@ spec:
configMap data to project
properties:
items:
- description: |-
- items if unspecified, each key-value pair in the Data field of the referenced
- ConfigMap will be projected into the volume as a file whose name is the
- key and content is the value. If specified, the listed keys will be
- projected into the specified paths, and unlisted keys will not be
- present. If a key is specified which is not present in the ConfigMap,
- the volume setup will error unless it is marked optional. Paths must be
- relative and may not contain the '..' path or start with '..'.
+ description: items if unspecified, each
+ key-value pair in the Data field of
+ the referenced ConfigMap will be projected
+ into the volume as a file whose name
+ is the key and content is the value.
+ If specified, the listed keys will be
+ projected into the specified paths,
+ and unlisted keys will not be present.
+ If a key is specified which is not present
+ in the ConfigMap, the volume setup will
+ error unless it is marked optional.
+ Paths must be relative and may not contain
+ the '..' path or start with '..'.
items:
description: Maps a string key to a
path within a volume.
@@ -5858,21 +6032,29 @@ spec:
description: key is the key to project.
type: string
mode:
- description: |-
- mode is Optional: mode bits used to set permissions on this file.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'mode is Optional:
+ mode bits used to set permissions
+ on this file. Must be an octal
+ value between 0000 and 0777 or
+ a decimal value between 0 and
+ 511. YAML accepts both octal and
+ decimal values, JSON requires
+ decimal values for mode bits.
+ If not specified, the volume defaultMode
+ will be used. This might be in
+ conflict with other options that
+ affect the file mode, like fsGroup,
+ and the result can be other mode
+ bits set.'
format: int32
type: integer
path:
- description: |-
- path is the relative path of the file to map the key to.
- May not be an absolute path.
- May not contain the path element '..'.
- May not start with the string '..'.
+ description: path is the relative
+ path of the file to map the key
+ to. May not be an absolute path.
+ May not contain the path element
+ '..'. May not start with the string
+ '..'.
type: string
required:
- key
@@ -5880,17 +6062,16 @@ spec:
type: object
type: array
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: optional specify whether
the ConfigMap or its keys must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
downwardAPI:
description: downwardAPI information about
the downwardAPI data to project
@@ -5922,15 +6103,21 @@ spec:
required:
- fieldPath
type: object
- x-kubernetes-map-type: atomic
mode:
- description: |-
- Optional: mode bits used to set permissions on this file, must be an octal value
- between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'Optional: mode bits
+ used to set permissions on this
+ file, must be an octal value between
+ 0000 and 0777 or a decimal value
+ between 0 and 511. YAML accepts
+ both octal and decimal values,
+ JSON requires decimal values for
+ mode bits. If not specified, the
+ volume defaultMode will be used.
+ This might be in conflict with
+ other options that affect the
+ file mode, like fsGroup, and the
+ result can be other mode bits
+ set.'
format: int32
type: integer
path:
@@ -5943,9 +6130,12 @@ spec:
start with ''..'''
type: string
resourceFieldRef:
- description: |-
- Selects a resource of the container: only resources limits and requests
- (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
+ description: 'Selects a resource
+ of the container: only resources
+ limits and requests (limits.cpu,
+ limits.memory, requests.cpu and
+ requests.memory) are currently
+ supported.'
properties:
containerName:
description: 'Container name:
@@ -5968,7 +6158,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
required:
- path
type: object
@@ -5979,14 +6168,19 @@ spec:
secret data to project
properties:
items:
- description: |-
- items if unspecified, each key-value pair in the Data field of the referenced
- Secret will be projected into the volume as a file whose name is the
- key and content is the value. If specified, the listed keys will be
- projected into the specified paths, and unlisted keys will not be
- present. If a key is specified which is not present in the Secret,
- the volume setup will error unless it is marked optional. Paths must be
- relative and may not contain the '..' path or start with '..'.
+ description: items if unspecified, each
+ key-value pair in the Data field of
+ the referenced Secret will be projected
+ into the volume as a file whose name
+ is the key and content is the value.
+ If specified, the listed keys will be
+ projected into the specified paths,
+ and unlisted keys will not be present.
+ If a key is specified which is not present
+ in the Secret, the volume setup will
+ error unless it is marked optional.
+ Paths must be relative and may not contain
+ the '..' path or start with '..'.
items:
description: Maps a string key to a
path within a volume.
@@ -5995,21 +6189,29 @@ spec:
description: key is the key to project.
type: string
mode:
- description: |-
- mode is Optional: mode bits used to set permissions on this file.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'mode is Optional:
+ mode bits used to set permissions
+ on this file. Must be an octal
+ value between 0000 and 0777 or
+ a decimal value between 0 and
+ 511. YAML accepts both octal and
+ decimal values, JSON requires
+ decimal values for mode bits.
+ If not specified, the volume defaultMode
+ will be used. This might be in
+ conflict with other options that
+ affect the file mode, like fsGroup,
+ and the result can be other mode
+ bits set.'
format: int32
type: integer
path:
- description: |-
- path is the relative path of the file to map the key to.
- May not be an absolute path.
- May not contain the path element '..'.
- May not start with the string '..'.
+ description: path is the relative
+ path of the file to map the key
+ to. May not be an absolute path.
+ May not contain the path element
+ '..'. May not start with the string
+ '..'.
type: string
required:
- key
@@ -6017,42 +6219,47 @@ spec:
type: object
type: array
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: optional field specify whether
the Secret or its key must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
serviceAccountToken:
description: serviceAccountToken is information
about the serviceAccountToken data to project
properties:
audience:
- description: |-
- audience is the intended audience of the token. A recipient of a token
- must identify itself with an identifier specified in the audience of the
- token, and otherwise should reject the token. The audience defaults to the
- identifier of the apiserver.
+ description: audience is the intended
+ audience of the token. A recipient of
+ a token must identify itself with an
+ identifier specified in the audience
+ of the token, and otherwise should reject
+ the token. The audience defaults to
+ the identifier of the apiserver.
type: string
expirationSeconds:
- description: |-
- expirationSeconds is the requested duration of validity of the service
- account token. As the token approaches expiration, the kubelet volume
- plugin will proactively rotate the service account token. The kubelet will
- start trying to rotate the token if the token is older than 80 percent of
- its time to live or if the token is older than 24 hours.Defaults to 1 hour
- and must be at least 10 minutes.
+ description: expirationSeconds is the
+ requested duration of validity of the
+ service account token. As the token
+ approaches expiration, the kubelet volume
+ plugin will proactively rotate the service
+ account token. The kubelet will start
+ trying to rotate the token if the token
+ is older than 80 percent of its time
+ to live or if the token is older than
+ 24 hours.Defaults to 1 hour and must
+ be at least 10 minutes.
format: int64
type: integer
path:
- description: |-
- path is the path relative to the mount point of the file to project the
- token into.
+ description: path is the path relative
+ to the mount point of the file to project
+ the token into.
type: string
required:
- path
@@ -6065,30 +6272,29 @@ spec:
host that shares a pod's lifetime
properties:
group:
- description: |-
- group to map volume access to
- Default is no group
+ description: group to map volume access to Default
+ is no group
type: string
readOnly:
- description: |-
- readOnly here will force the Quobyte volume to be mounted with read-only permissions.
+ description: readOnly here will force the Quobyte
+ volume to be mounted with read-only permissions.
Defaults to false.
type: boolean
registry:
- description: |-
- registry represents a single or multiple Quobyte Registry services
- specified as a string as host:port pair (multiple entries are separated with commas)
- which acts as the central registry for volumes
+ description: registry represents a single or multiple
+ Quobyte Registry services specified as a string
+ as host:port pair (multiple entries are separated
+ with commas) which acts as the central registry
+ for volumes
type: string
tenant:
- description: |-
- tenant owning the given Quobyte volume in the Backend
- Used with dynamically provisioned Quobyte volumes, value is set by the plugin
+ description: tenant owning the given Quobyte volume
+ in the Backend Used with dynamically provisioned
+ Quobyte volumes, value is set by the plugin
type: string
user:
- description: |-
- user to map volume access to
- Defaults to serivceaccount user
+ description: user to map volume access to Defaults
+ to serivceaccount user
type: string
volume:
description: volume is a string that references
@@ -6099,68 +6305,59 @@ spec:
- volume
type: object
rbd:
- description: |-
- rbd represents a Rados Block Device mount on the host that shares a pod's lifetime.
- More info: https://examples.k8s.io/volumes/rbd/README.md
+ description: 'rbd represents a Rados Block Device mount
+ on the host that shares a pod''s lifetime. More info:
+ https://examples.k8s.io/volumes/rbd/README.md'
properties:
fsType:
- description: |-
- fsType is the filesystem type of the volume that you want to mount.
- Tip: Ensure that the filesystem type is supported by the host operating system.
- Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd
- TODO: how do we prevent errors in the filesystem from compromising the machine
+ description: 'fsType is the filesystem type of the
+ volume that you want to mount. Tip: Ensure that
+ the filesystem type is supported by the host operating
+ system. Examples: "ext4", "xfs", "ntfs". Implicitly
+ inferred to be "ext4" if unspecified. More info:
+ https://kubernetes.io/docs/concepts/storage/volumes#rbd
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
image:
- description: |-
- image is the rados image name.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'image is the rados image name. More
+ info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
keyring:
- description: |-
- keyring is the path to key ring for RBDUser.
- Default is /etc/ceph/keyring.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'keyring is the path to key ring for
+ RBDUser. Default is /etc/ceph/keyring. More info:
+ https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
monitors:
- description: |-
- monitors is a collection of Ceph monitors.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'monitors is a collection of Ceph monitors.
+ More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
items:
type: string
type: array
pool:
- description: |-
- pool is the rados pool name.
- Default is rbd.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'pool is the rados pool name. Default
+ is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
readOnly:
- description: |-
- readOnly here will force the ReadOnly setting in VolumeMounts.
- Defaults to false.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'readOnly here will force the ReadOnly
+ setting in VolumeMounts. Defaults to false. More
+ info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: boolean
secretRef:
- description: |-
- secretRef is name of the authentication secret for RBDUser. If provided
- overrides keyring.
- Default is nil.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'secretRef is name of the authentication
+ secret for RBDUser. If provided overrides keyring.
+ Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
user:
- description: |-
- user is the rados user name.
- Default is admin.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'user is the rados user name. Default
+ is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
required:
- image
@@ -6171,11 +6368,10 @@ spec:
volume attached and mounted on Kubernetes nodes.
properties:
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs".
- Default is "xfs".
+ description: fsType is the filesystem type to mount.
+ Must be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs". Default
+ is "xfs".
type: string
gateway:
description: gateway is the host address of the
@@ -6186,30 +6382,30 @@ spec:
ScaleIO Protection Domain for the configured storage.
type: string
readOnly:
- description: |-
- readOnly Defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: readOnly Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
secretRef:
- description: |-
- secretRef references to the secret for ScaleIO user and other
- sensitive information. If this is not provided, Login operation will fail.
+ description: secretRef references to the secret
+ for ScaleIO user and other sensitive information.
+ If this is not provided, Login operation will
+ fail.
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
sslEnabled:
description: sslEnabled Flag enable/disable SSL
communication with Gateway, default false
type: boolean
storageMode:
- description: |-
- storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.
+ description: storageMode indicates whether the storage
+ for a volume should be ThickProvisioned or ThinProvisioned.
Default is ThinProvisioned.
type: string
storagePool:
@@ -6221,9 +6417,9 @@ spec:
as configured in ScaleIO.
type: string
volumeName:
- description: |-
- volumeName is the name of a volume already created in the ScaleIO system
- that is associated with this volume source.
+ description: volumeName is the name of a volume
+ already created in the ScaleIO system that is
+ associated with this volume source.
type: string
required:
- gateway
@@ -6231,30 +6427,34 @@ spec:
- system
type: object
secret:
- description: |-
- secret represents a secret that should populate this volume.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
+ description: 'secret represents a secret that should
+ populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
properties:
defaultMode:
- description: |-
- defaultMode is Optional: mode bits used to set permissions on created files by default.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values
- for mode bits. Defaults to 0644.
- Directories within the path are not affected by this setting.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'defaultMode is Optional: mode bits
+ used to set permissions on created files by default.
+ Must be an octal value between 0000 and 0777 or
+ a decimal value between 0 and 511. YAML accepts
+ both octal and decimal values, JSON requires decimal
+ values for mode bits. Defaults to 0644. Directories
+ within the path are not affected by this setting.
+ This might be in conflict with other options that
+ affect the file mode, like fsGroup, and the result
+ can be other mode bits set.'
format: int32
type: integer
items:
- description: |-
- items If unspecified, each key-value pair in the Data field of the referenced
- Secret will be projected into the volume as a file whose name is the
- key and content is the value. If specified, the listed keys will be
- projected into the specified paths, and unlisted keys will not be
- present. If a key is specified which is not present in the Secret,
- the volume setup will error unless it is marked optional. Paths must be
- relative and may not contain the '..' path or start with '..'.
+ description: items If unspecified, each key-value
+ pair in the Data field of the referenced Secret
+ will be projected into the volume as a file whose
+ name is the key and content is the value. If specified,
+ the listed keys will be projected into the specified
+ paths, and unlisted keys will not be present.
+ If a key is specified which is not present in
+ the Secret, the volume setup will error unless
+ it is marked optional. Paths must be relative
+ and may not contain the '..' path or start with
+ '..'.
items:
description: Maps a string key to a path within
a volume.
@@ -6263,21 +6463,25 @@ spec:
description: key is the key to project.
type: string
mode:
- description: |-
- mode is Optional: mode bits used to set permissions on this file.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'mode is Optional: mode bits
+ used to set permissions on this file. Must
+ be an octal value between 0000 and 0777
+ or a decimal value between 0 and 511. YAML
+ accepts both octal and decimal values, JSON
+ requires decimal values for mode bits. If
+ not specified, the volume defaultMode will
+ be used. This might be in conflict with
+ other options that affect the file mode,
+ like fsGroup, and the result can be other
+ mode bits set.'
format: int32
type: integer
path:
- description: |-
- path is the relative path of the file to map the key to.
- May not be an absolute path.
- May not contain the path element '..'.
- May not start with the string '..'.
+ description: path is the relative path of
+ the file to map the key to. May not be an
+ absolute path. May not contain the path
+ element '..'. May not start with the string
+ '..'.
type: string
required:
- key
@@ -6289,9 +6493,8 @@ spec:
Secret or its keys must be defined
type: boolean
secretName:
- description: |-
- secretName is the name of the secret in the pod's namespace to use.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
+ description: 'secretName is the name of the secret
+ in the pod''s namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
type: string
type: object
storageos:
@@ -6299,42 +6502,43 @@ spec:
attached and mounted on Kubernetes nodes.
properties:
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: fsType is the filesystem type to mount.
+ Must be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs". Implicitly
+ inferred to be "ext4" if unspecified.
type: string
readOnly:
- description: |-
- readOnly defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: readOnly defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
secretRef:
- description: |-
- secretRef specifies the secret to use for obtaining the StorageOS API
- credentials. If not specified, default values will be attempted.
+ description: secretRef specifies the secret to use
+ for obtaining the StorageOS API credentials. If
+ not specified, default values will be attempted.
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
volumeName:
- description: |-
- volumeName is the human-readable name of the StorageOS volume. Volume
- names are only unique within a namespace.
+ description: volumeName is the human-readable name
+ of the StorageOS volume. Volume names are only
+ unique within a namespace.
type: string
volumeNamespace:
- description: |-
- volumeNamespace specifies the scope of the volume within StorageOS. If no
- namespace is specified then the Pod's namespace will be used. This allows the
- Kubernetes name scoping to be mirrored within StorageOS for tighter integration.
- Set VolumeName to any name to override the default behaviour.
- Set to "default" if you are not using namespaces within StorageOS.
- Namespaces that do not pre-exist within StorageOS will be created.
+ description: volumeNamespace specifies the scope
+ of the volume within StorageOS. If no namespace
+ is specified then the Pod's namespace will be
+ used. This allows the Kubernetes name scoping
+ to be mirrored within StorageOS for tighter integration.
+ Set VolumeName to any name to override the default
+ behaviour. Set to "default" if you are not using
+ namespaces within StorageOS. Namespaces that do
+ not pre-exist within StorageOS will be created.
type: string
type: object
vsphereVolume:
@@ -6342,10 +6546,10 @@ spec:
attached and mounted on kubelets host machine
properties:
fsType:
- description: |-
- fsType is filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: fsType is filesystem type to mount.
+ Must be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs". Implicitly
+ inferred to be "ext4" if unspecified.
type: string
storagePolicyID:
description: storagePolicyID is the storage Policy
@@ -6396,9 +6600,8 @@ spec:
description: The configuration of Affinity trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6417,9 +6620,9 @@ spec:
in the same node (default `false`).
type: boolean
podAffinityLabels:
- description: |-
- Defines a set of pods (namely those matching the label selector, relative to the given namespace) that the
- integration pod(s) should be co-located with.
+ description: Defines a set of pods (namely those matching
+ the label selector, relative to the given namespace) that
+ the integration pod(s) should be co-located with.
items:
type: string
type: array
@@ -6428,9 +6631,9 @@ spec:
in the same node (default `false`).
type: boolean
podAntiAffinityLabels:
- description: |-
- Defines a set of pods (namely those matching the label selector, relative to the given namespace) that the
- integration pod(s) should not be co-located with.
+ description: Defines a set of pods (namely those matching
+ the label selector, relative to the given namespace) that
+ the integration pod(s) should not be co-located with.
items:
type: string
type: array
@@ -6445,14 +6648,13 @@ spec:
for the builder pod.
type: object
baseImage:
- description: |-
- Specify a base image. In order to have the application working properly it must be a container image which has a Java JDK
- installed and ready to use on path (ie `/usr/bin/java`).
+ description: Specify a base image. In order to have the application
+ working properly it must be a container image which has
+ a Java JDK installed and ready to use on path (ie `/usr/bin/java`).
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6463,21 +6665,27 @@ spec:
existing containers (default `true`)
type: boolean
limitCPU:
- description: |-
- When using `pod` strategy, the maximum amount of CPU required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the maximum amount
+ of CPU required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
limitMemory:
- description: |-
- When using `pod` strategy, the maximum amount of memory required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the maximum amount
+ of memory required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
mavenProfiles:
- description: |-
- A list of references pointing to configmaps/secrets that contains a maven profile.
- This configmap/secret is a resource of the IntegrationKit created, therefore it needs to be present in the namespace where the operator is going to create the IntegrationKit.
- The content of the maven profile is expected to be a text containing a valid maven profile starting with `` and ending with `` that will be integrated as an inline profile in the POM.
- Syntax: [configmap|secret]:name[/key], where name represents the resource name, key optionally represents the resource key to be filtered (default key value = profile.xml).
+ description: 'A list of references pointing to configmaps/secrets
+ that contains a maven profile. This configmap/secret is
+ a resource of the IntegrationKit created, therefore it needs
+ to be present in the namespace where the operator is going
+ to create the IntegrationKit. The content of the maven profile
+ is expected to be a text containing a valid maven profile
+ starting with `` and ending with `` that
+ will be integrated as an inline profile in the POM. Syntax:
+ [configmap|secret]:name[/key], where name represents the
+ resource name, key optionally represents the resource key
+ to be filtered (default key value = profile.xml).'
items:
type: string
type: array
@@ -6508,14 +6716,14 @@ spec:
type: string
type: array
requestCPU:
- description: |-
- When using `pod` strategy, the minimum amount of CPU required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the minimum amount
+ of CPU required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
requestMemory:
- description: |-
- When using `pod` strategy, the minimum amount of memory required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the minimum amount
+ of memory required by the pod builder. Deprecated: use TasksRequestCPU
+ instead with task name `builder`.'
type: string
strategy:
description: The strategy to use, either `pod` or `routine`
@@ -6531,10 +6739,11 @@ spec:
type: string
type: array
tasksFilter:
- description: |-
- A list of tasks sorted by the order of execution in a csv format, ie, `,,...`.
- Mind that you must include also the operator tasks (`builder`, `quarkus-native`, `package`, `jib`, `s2i`)
- if you need to execute them. Useful only with `pod` strategy.
+ description: A list of tasks sorted by the order of execution
+ in a csv format, ie, `,,...`. Mind
+ that you must include also the operator tasks (`builder`,
+ `quarkus-native`, `package`, `jib`, `s2i`) if you need to
+ execute them. Useful only with `pod` strategy.
type: string
tasksLimitCPU:
description: A list of limit cpu configuration for the specific
@@ -6561,18 +6770,17 @@ spec:
type: string
type: array
verbose:
- description: |-
- Enable verbose logging on build components that support it (e.g. Kaniko build pod).
- Deprecated no longer in use
+ description: Enable verbose logging on build components that
+ support it (e.g. Kaniko build pod). Deprecated no longer
+ in use
type: boolean
type: object
camel:
description: The configuration of Camel trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6585,10 +6793,12 @@ spec:
type: string
type: array
runtimeVersion:
- description: |-
- The camel-k-runtime version to use for the integration. It overrides the default version set in the Integration Platform.
- You can use a fixed version (for example "3.2.3") or a semantic version (for example "3.x") which will try to resolve
- to the best matching Catalog existing on the cluster.
+ description: The camel-k-runtime version to use for the integration.
+ It overrides the default version set in the Integration
+ Platform. You can use a fixed version (for example "3.2.3")
+ or a semantic version (for example "3.x") which will try
+ to resolve to the best matching Catalog existing on the
+ cluster.
type: string
type: object
container:
@@ -6616,9 +6826,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6629,10 +6838,13 @@ spec:
Service.
type: boolean
image:
- description: |-
- The main container image to use for the Integration. When using this parameter the operator will create a synthetic IntegrationKit which
- won't be able to execute traits requiring CamelCatalog. If the container image you're using is coming from an IntegrationKit, use instead
- Integration `.spec.integrationKit` parameter. If you're moving the Integration across environments, you will also need to create an "external" IntegrationKit.
+ description: The main container image to use for the Integration.
+ When using this parameter the operator will create a synthetic
+ IntegrationKit which won't be able to execute traits requiring
+ CamelCatalog. If the container image you're using is coming
+ from an IntegrationKit, use instead Integration `.spec.integrationKit`
+ parameter. If you're moving the Integration across environments,
+ you will also need to create an "external" IntegrationKit.
type: string
imagePullPolicy:
description: 'The pull policy: Always|Never|IfNotPresent'
@@ -6700,52 +6912,50 @@ spec:
description: The configuration of Cron trait
properties:
activeDeadlineSeconds:
- description: |-
- Specifies the duration in seconds, relative to the start time, that the job
- may be continuously active before it is considered to be failed.
- It defaults to 60s.
+ description: Specifies the duration in seconds, relative to
+ the start time, that the job may be continuously active
+ before it is considered to be failed. It defaults to 60s.
format: int64
type: integer
auto:
- description: |-
- Automatically deploy the integration as CronJob when all routes are
- either starting from a periodic consumer (only `cron`, `timer` and `quartz` are supported) or a passive consumer (e.g. `direct` is a passive consumer).
-
-
- It's required that all periodic consumers have the same period, and it can be expressed as cron schedule (e.g. `1m` can be expressed as `0/1 * * * *`,
- while `35m` or `50s` cannot).
+ description: "Automatically deploy the integration as CronJob
+ when all routes are either starting from a periodic consumer
+ (only `cron`, `timer` and `quartz` are supported) or a passive
+ consumer (e.g. `direct` is a passive consumer). \n It's
+ required that all periodic consumers have the same period,
+ and it can be expressed as cron schedule (e.g. `1m` can
+ be expressed as `0/1 * * * *`, while `35m` or `50s` cannot)."
type: boolean
backoffLimit:
- description: |-
- Specifies the number of retries before marking the job failed.
- It defaults to 2.
+ description: Specifies the number of retries before marking
+ the job failed. It defaults to 2.
format: int32
type: integer
components:
- description: |-
- A comma separated list of the Camel components that need to be customized in order for them to work when the schedule is triggered externally by Kubernetes.
- A specific customizer is activated for each specified component. E.g. for the `timer` component, the `cron-timer` customizer is
- activated (it's present in the `org.apache.camel.k:camel-k-cron` library).
-
-
- Supported components are currently: `cron`, `timer` and `quartz`.
+ description: "A comma separated list of the Camel components
+ that need to be customized in order for them to work when
+ the schedule is triggered externally by Kubernetes. A specific
+ customizer is activated for each specified component. E.g.
+ for the `timer` component, the `cron-timer` customizer is
+ activated (it's present in the `org.apache.camel.k:camel-k-cron`
+ library). \n Supported components are currently: `cron`,
+ `timer` and `quartz`."
type: string
concurrencyPolicy:
- description: |-
- Specifies how to treat concurrent executions of a Job.
- Valid values are:
- - "Allow": allows CronJobs to run concurrently;
- - "Forbid" (default): forbids concurrent runs, skipping next run if previous run hasn't finished yet;
- - "Replace": cancels currently running job and replaces it with a new one
+ description: 'Specifies how to treat concurrent executions
+ of a Job. Valid values are: - "Allow": allows CronJobs to
+ run concurrently; - "Forbid" (default): forbids concurrent
+ runs, skipping next run if previous run hasn''t finished
+ yet; - "Replace": cancels currently running job and replaces
+ it with a new one'
enum:
- Allow
- Forbid
- Replace
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6753,19 +6963,19 @@ spec:
traits share this common property.
type: boolean
fallback:
- description: |-
- Use the default Camel implementation of the `cron` endpoint (`quartz`) instead of trying to materialize the integration
- as Kubernetes CronJob.
+ description: Use the default Camel implementation of the `cron`
+ endpoint (`quartz`) instead of trying to materialize the
+ integration as Kubernetes CronJob.
type: boolean
schedule:
- description: |-
- The CronJob schedule for the whole integration. If multiple routes are declared, they must have the same schedule for this
- mechanism to work correctly.
+ description: The CronJob schedule for the whole integration.
+ If multiple routes are declared, they must have the same
+ schedule for this mechanism to work correctly.
type: string
startingDeadlineSeconds:
- description: |-
- Optional deadline in seconds for starting the job if it misses scheduled
- time for any reason. Missed jobs executions will be counted as failed ones.
+ description: Optional deadline in seconds for starting the
+ job if it misses scheduled time for any reason. Missed
+ jobs executions will be counted as failed ones.
format: int64
type: integer
timeZone:
@@ -6776,9 +6986,8 @@ spec:
description: The configuration of Dependencies trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6789,9 +6998,8 @@ spec:
description: The configuration of Deployer trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6807,51 +7015,49 @@ spec:
- knative-service
type: string
useSSA:
- description: |-
- Use server-side apply to update the owned resources (default `true`).
- Note that it automatically falls back to client-side patching, if SSA is not available, e.g., on old Kubernetes clusters.
+ description: Use server-side apply to update the owned resources
+ (default `true`). Note that it automatically falls back
+ to client-side patching, if SSA is not available, e.g.,
+ on old Kubernetes clusters.
type: boolean
type: object
deployment:
description: The configuration of Deployment trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
description: 'Deprecated: no longer in use.'
type: boolean
progressDeadlineSeconds:
- description: |-
- The maximum time in seconds for the deployment to make progress before it
- is considered to be failed. It defaults to `60s`.
+ description: The maximum time in seconds for the deployment
+ to make progress before it is considered to be failed. It
+ defaults to `60s`.
format: int32
type: integer
rollingUpdateMaxSurge:
anyOf:
- type: integer
- type: string
- description: |-
- The maximum number of pods that can be scheduled above the desired number of
- pods.
- Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
- This can not be 0 if MaxUnavailable is 0.
- Absolute number is calculated from percentage by rounding up.
- Defaults to `25%`.
+ description: 'The maximum number of pods that can be scheduled
+ above the desired number of pods. Value can be an absolute
+ number (ex: 5) or a percentage of desired pods (ex: 10%).
+ This can not be 0 if MaxUnavailable is 0. Absolute number
+ is calculated from percentage by rounding up. Defaults to
+ `25%`.'
x-kubernetes-int-or-string: true
rollingUpdateMaxUnavailable:
anyOf:
- type: integer
- type: string
- description: |-
- The maximum number of pods that can be unavailable during the update.
- Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
- Absolute number is calculated from percentage by rounding down.
- This can not be 0 if MaxSurge is 0.
- Defaults to `25%`.
+ description: 'The maximum number of pods that can be unavailable
+ during the update. Value can be an absolute number (ex:
+ 5) or a percentage of desired pods (ex: 10%). Absolute number
+ is calculated from percentage by rounding down. This can
+ not be 0 if MaxSurge is 0. Defaults to `25%`.'
x-kubernetes-int-or-string: true
strategy:
description: The deployment strategy to use to replace existing
@@ -6865,9 +7071,8 @@ spec:
description: The configuration of Environment trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
containerMeta:
@@ -6882,11 +7087,12 @@ spec:
`NO_PROXY` environment variables (default `true`)
type: boolean
vars:
- description: |-
- A list of environment variables to be added to the integration container.
- The syntax is either VAR=VALUE or VAR=[configmap|secret]:name/key, where name represents the resource name,
- and key represents the resource key to be mapped as and environment variable.
- These take precedence over any previously defined environment variables.
+ description: A list of environment variables to be added to
+ the integration container. The syntax is either VAR=VALUE
+ or VAR=[configmap|secret]:name/key, where name represents
+ the resource name, and key represents the resource key to
+ be mapped as and environment variable. These take precedence
+ over any previously defined environment variables.
items:
type: string
type: array
@@ -6895,9 +7101,8 @@ spec:
description: The configuration of Error Handler trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6912,15 +7117,14 @@ spec:
description: The configuration of GC trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
discoveryCache:
- description: |-
- Discovery client cache to be used, either `disabled`, `disk` or `memory` (default `memory`).
- Deprecated: to be removed from trait configuration.
+ description: 'Discovery client cache to be used, either `disabled`,
+ `disk` or `memory` (default `memory`). Deprecated: to be
+ removed from trait configuration.'
enum:
- disabled
- disk
@@ -6935,9 +7139,8 @@ spec:
description: The configuration of Health trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7059,19 +7262,17 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to the ingress.
- This can be used to set controller specific annotations, e.g., when using the NGINX Ingress controller:
- See https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md
+ description: 'The annotations added to the ingress. This can
+ be used to set controller specific annotations, e.g., when
+ using the NGINX Ingress controller: See https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md'
type: object
auto:
description: To automatically add an ingress whenever the
integration uses an HTTP endpoint consumer.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7081,14 +7282,18 @@ spec:
host:
description: To configure the host exposed by the ingress.
type: string
+ ingressClassName:
+ description: The Ingress class name as defined by the Ingress
+ spec See https://kubernetes.io/docs/concepts/services-networking/ingress/
+ type: string
path:
description: To configure the path exposed by the ingress
(default `/`).
type: string
pathType:
- description: |-
- To configure the path type exposed by the ingress.
- One of `Exact`, `Prefix`, `ImplementationSpecific` (default to `Prefix`).
+ description: To configure the path type exposed by the ingress.
+ One of `Exact`, `Prefix`, `ImplementationSpecific` (default
+ to `Prefix`).
enum:
- Exact
- Prefix
@@ -7112,9 +7317,8 @@ spec:
by default).
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7131,23 +7335,25 @@ spec:
description: The configuration of Jolokia trait
properties:
CACert:
- description: |-
- The PEM encoded CA certification file path, used to verify client certificates,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt` for OpenShift).
+ description: The PEM encoded CA certification file path, used
+ to verify client certificates, applicable when `protocol`
+ is `https` and `use-ssl-client-authentication` is `true`
+ (default `/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt`
+ for OpenShift).
type: string
clientPrincipal:
- description: |-
- The principal(s) which must be given in a client certificate to allow access to the Jolokia endpoint,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `clientPrincipal=cn=system:master-proxy`, `cn=hawtio-online.hawtio.svc` and `cn=fuse-console.fuse.svc` for OpenShift).
+ description: The principal(s) which must be given in a client
+ certificate to allow access to the Jolokia endpoint, applicable
+ when `protocol` is `https` and `use-ssl-client-authentication`
+ is `true` (default `clientPrincipal=cn=system:master-proxy`,
+ `cn=hawtio-online.hawtio.svc` and `cn=fuse-console.fuse.svc`
+ for OpenShift).
items:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
discoveryEnabled:
@@ -7158,20 +7364,20 @@ spec:
traits share this common property.
type: boolean
extendedClientCheck:
- description: |-
- Mandate the client certificate contains a client flag in the extended key usage section,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `true` for OpenShift).
+ description: Mandate the client certificate contains a client
+ flag in the extended key usage section, applicable when
+ `protocol` is `https` and `use-ssl-client-authentication`
+ is `true` (default `true` for OpenShift).
type: boolean
host:
- description: |-
- The Host address to which the Jolokia agent should bind to. If `"\*"` or `"0.0.0.0"` is given,
- the servers binds to every network interface (default `"*"`).
+ description: The Host address to which the Jolokia agent should
+ bind to. If `"\*"` or `"0.0.0.0"` is given, the servers
+ binds to every network interface (default `"*"`).
type: string
options:
- description: |-
- A list of additional Jolokia options as defined
- in https://jolokia.org/reference/html/agents.html#agent-jvm-config[JVM agent configuration options]
+ description: A list of additional Jolokia options as defined
+ in https://jolokia.org/reference/html/agents.html#agent-jvm-config[JVM
+ agent configuration options]
items:
type: string
type: array
@@ -7202,9 +7408,8 @@ spec:
separator)
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
debug:
@@ -7233,9 +7438,9 @@ spec:
type: string
type: array
printCommand:
- description: |-
- Prints the command used the start the JVM in the container logs (default `true`)
- Deprecated: no longer in use.
+ description: 'Prints the command used the start the JVM in
+ the container logs (default `true`) Deprecated: no longer
+ in use.'
type: boolean
type: object
kamelets:
@@ -7246,9 +7451,8 @@ spec:
and their default configuration (enabled by default)
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7281,16 +7485,14 @@ spec:
description: Enable automatic discovery of all trait properties.
type: boolean
channelSinks:
- description: |-
- List of channels used as destination of integration routes.
- Can contain simple channel names or full Camel URIs.
+ description: List of channels used as destination of integration
+ routes. Can contain simple channel names or full Camel URIs.
items:
type: string
type: array
channelSources:
- description: |-
- List of channels used as source of integration routes.
- Can contain simple channel names or full Camel URIs.
+ description: List of channels used as source of integration
+ routes. Can contain simple channel names or full Camel URIs.
items:
type: string
type: array
@@ -7299,9 +7501,8 @@ spec:
in JSON format.
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7309,9 +7510,9 @@ spec:
traits share this common property.
type: boolean
endpointSinks:
- description: |-
- List of endpoints used as destination of integration routes.
- Can contain simple endpoint names or full Camel URIs.
+ description: List of endpoints used as destination of integration
+ routes. Can contain simple endpoint names or full Camel
+ URIs.
items:
type: string
type: array
@@ -7322,50 +7523,54 @@ spec:
type: string
type: array
eventSinks:
- description: |-
- List of event types that the integration will produce.
- Can contain simple event types or full Camel URIs (to use a specific broker).
+ description: List of event types that the integration will
+ produce. Can contain simple event types or full Camel URIs
+ (to use a specific broker).
items:
type: string
type: array
eventSources:
- description: |-
- List of event types that the integration will be subscribed to.
- Can contain simple event types or full Camel URIs (to use a specific broker different from "default").
+ description: List of event types that the integration will
+ be subscribed to. Can contain simple event types or full
+ Camel URIs (to use a specific broker different from "default").
items:
type: string
type: array
filterEventType:
- description: |-
- Enables the default filtering for the Knative trigger using the event type
- If this is true, the created Knative trigger uses the event type as a filter on the event stream when no other filter criteria is given. (default: true)
+ description: 'Enables the default filtering for the Knative
+ trigger using the event type If this is true, the created
+ Knative trigger uses the event type as a filter on the event
+ stream when no other filter criteria is given. (default:
+ true)'
type: boolean
filterSourceChannels:
- description: |-
- Enables filtering on events based on the header "ce-knativehistory". Since this header has been removed in newer versions of
- Knative, filtering is disabled by default.
+ description: Enables filtering on events based on the header
+ "ce-knativehistory". Since this header has been removed
+ in newer versions of Knative, filtering is disabled by default.
type: boolean
filters:
- description: |-
- Sets filter attributes on the event stream (such as event type, source, subject and so on).
- A list of key-value pairs that represent filter attributes and its values.
- The syntax is KEY=VALUE, e.g., `source="my.source"`.
- Filter attributes get set on the Knative trigger that is being created as part of this integration.
+ description: Sets filter attributes on the event stream (such
+ as event type, source, subject and so on). A list of key-value
+ pairs that represent filter attributes and its values. The
+ syntax is KEY=VALUE, e.g., `source="my.source"`. Filter
+ attributes get set on the Knative trigger that is being
+ created as part of this integration.
items:
type: string
type: array
namespaceLabel:
- description: |-
- Enables the camel-k-operator to set the "bindings.knative.dev/include=true" label to the namespace
- As Knative requires this label to perform injection of K_SINK URL into the service.
- If this is false, the integration pod may start and fail, read the SinkBinding Knative documentation. (default: true)
+ description: 'Enables the camel-k-operator to set the "bindings.knative.dev/include=true"
+ label to the namespace As Knative requires this label to
+ perform injection of K_SINK URL into the service. If this
+ is false, the integration pod may start and fail, read the
+ SinkBinding Knative documentation. (default: true)'
type: boolean
sinkBinding:
- description: |-
- Allows binding the integration to a sink via a Knative SinkBinding resource.
- This can be used when the integration targets a single sink.
- It's enabled by default when the integration targets a single sink
- (except when the integration is owned by a Knative source).
+ description: Allows binding the integration to a sink via
+ a Knative SinkBinding resource. This can be used when the
+ integration targets a single sink. It's enabled by default
+ when the integration targets a single sink (except when
+ the integration is owned by a Knative source).
type: boolean
type: object
knative-service:
@@ -7374,47 +7579,39 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to route.
- This can be used to set knative service specific annotations
- CLI usage example: -t "knative-service.annotations.'haproxy.router.openshift.io/balance'=true"
+ description: 'The annotations added to route. This can be
+ used to set knative service specific annotations CLI usage
+ example: -t "knative-service.annotations.''haproxy.router.openshift.io/balance''=true"'
type: object
auto:
- description: |-
- Automatically deploy the integration as Knative service when all conditions hold:
-
-
- * Integration is using the Knative profile
- * All routes are either starting from an HTTP based consumer or a passive consumer (e.g. `direct` is a passive consumer)
+ description: "Automatically deploy the integration as Knative
+ service when all conditions hold: \n * Integration is using
+ the Knative profile * All routes are either starting from
+ an HTTP based consumer or a passive consumer (e.g. `direct`
+ is a passive consumer)"
type: boolean
autoscalingMetric:
- description: |-
- Configures the Knative autoscaling metric property (e.g. to set `concurrency` based or `cpu` based autoscaling).
-
-
- Refer to the Knative documentation for more information.
+ description: "Configures the Knative autoscaling metric property
+ (e.g. to set `concurrency` based or `cpu` based autoscaling).
+ \n Refer to the Knative documentation for more information."
type: string
autoscalingTarget:
- description: |-
- Sets the allowed concurrency level or CPU percentage (depending on the autoscaling metric) for each Pod.
-
-
- Refer to the Knative documentation for more information.
+ description: "Sets the allowed concurrency level or CPU percentage
+ (depending on the autoscaling metric) for each Pod. \n Refer
+ to the Knative documentation for more information."
type: integer
class:
- description: |-
- Configures the Knative autoscaling class property (e.g. to set `hpa.autoscaling.knative.dev` or `kpa.autoscaling.knative.dev` autoscaling).
-
-
- Refer to the Knative documentation for more information.
+ description: "Configures the Knative autoscaling class property
+ (e.g. to set `hpa.autoscaling.knative.dev` or `kpa.autoscaling.knative.dev`
+ autoscaling). \n Refer to the Knative documentation for
+ more information."
enum:
- kpa.autoscaling.knative.dev
- hpa.autoscaling.knative.dev
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7422,43 +7619,36 @@ spec:
traits share this common property.
type: boolean
maxScale:
- description: |-
- An upper bound for the number of Pods that can be running in parallel for the integration.
- Knative has its own cap value that depends on the installation.
-
-
- Refer to the Knative documentation for more information.
+ description: "An upper bound for the number of Pods that can
+ be running in parallel for the integration. Knative has
+ its own cap value that depends on the installation. \n Refer
+ to the Knative documentation for more information."
type: integer
minScale:
- description: |-
- The minimum number of Pods that should be running at any time for the integration. It's **zero** by default, meaning that
- the integration is scaled down to zero when not used for a configured amount of time.
-
-
- Refer to the Knative documentation for more information.
+ description: "The minimum number of Pods that should be running
+ at any time for the integration. It's **zero** by default,
+ meaning that the integration is scaled down to zero when
+ not used for a configured amount of time. \n Refer to the
+ Knative documentation for more information."
type: integer
rolloutDuration:
- description: |-
- Enables to gradually shift traffic to the latest Revision and sets the rollout duration.
- It's disabled by default and must be expressed as a Golang `time.Duration` string representation,
- rounded to a second precision.
+ description: Enables to gradually shift traffic to the latest
+ Revision and sets the rollout duration. It's disabled by
+ default and must be expressed as a Golang `time.Duration`
+ string representation, rounded to a second precision.
type: string
timeoutSeconds:
- description: |-
- The maximum duration in seconds that the request instance is allowed to respond to a request.
- This field propagates to the integration pod's terminationGracePeriodSeconds
-
-
- Refer to the Knative documentation for more information.
+ description: "The maximum duration in seconds that the request
+ instance is allowed to respond to a request. This field
+ propagates to the integration pod's terminationGracePeriodSeconds
+ \n Refer to the Knative documentation for more information."
format: int64
type: integer
visibility:
- description: |-
- Setting `cluster-local`, Knative service becomes a private service.
- Specifically, this option applies the `networking.knative.dev/visibility` label to Knative service.
-
-
- Refer to the Knative documentation for more information.
+ description: "Setting `cluster-local`, Knative service becomes
+ a private service. Specifically, this option applies the
+ `networking.knative.dev/visibility` label to Knative service.
+ \n Refer to the Knative documentation for more information."
enum:
- cluster-local
type: string
@@ -7470,9 +7660,8 @@ spec:
description: Colorize the log output
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7512,18 +7701,20 @@ spec:
description: The configuration of Mount trait
properties:
configs:
- description: |-
- A list of configuration pointing to configmap/secret.
- The configuration are expected to be UTF-8 resources as they are processed by runtime Camel Context and tried to be parsed as property files.
- They are also made available on the classpath in order to ease their usage directly from the Route.
- Syntax: [configmap|secret]:name[/key], where name represents the resource name and key optionally represents the resource key to be filtered
+ description: 'A list of configuration pointing to configmap/secret.
+ The configuration are expected to be UTF-8 resources as
+ they are processed by runtime Camel Context and tried to
+ be parsed as property files. They are also made available
+ on the classpath in order to ease their usage directly from
+ the Route. Syntax: [configmap|secret]:name[/key], where
+ name represents the resource name and key optionally represents
+ the resource key to be filtered'
items:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
emptyDirs:
@@ -7536,17 +7727,21 @@ spec:
description: 'Deprecated: no longer in use.'
type: boolean
hotReload:
- description: |-
- Enable "hot reload" when a secret/configmap mounted is edited (default `false`). The configmap/secret must be
- marked with `camel.apache.org/integration` label to be taken in account. The resource will be watched for any kind change, also for
- changes in metadata.
+ description: Enable "hot reload" when a secret/configmap mounted
+ is edited (default `false`). The configmap/secret must be
+ marked with `camel.apache.org/integration` label to be taken
+ in account. The resource will be watched for any kind change,
+ also for changes in metadata.
type: boolean
resources:
- description: |-
- A list of resources (text or binary content) pointing to configmap/secret.
- The resources are expected to be any resource type (text or binary content).
- The destination path can be either a default location or any path specified by the user.
- Syntax: [configmap|secret]:name[/key][@path], where name represents the resource name, key optionally represents the resource key to be filtered and path represents the destination path
+ description: 'A list of resources (text or binary content)
+ pointing to configmap/secret. The resources are expected
+ to be any resource type (text or binary content). The destination
+ path can be either a default location or any path specified
+ by the user. Syntax: [configmap|secret]:name[/key][@path],
+ where name represents the resource name, key optionally
+ represents the resource key to be filtered and path represents
+ the destination path'
items:
type: string
type: array
@@ -7571,9 +7766,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7584,9 +7778,8 @@ spec:
description: The configuration of Owner trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7608,9 +7801,8 @@ spec:
description: The configuration of PDB trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7618,53 +7810,56 @@ spec:
traits share this common property.
type: boolean
maxUnavailable:
- description: |-
- The number of pods for the Integration that can be unavailable after an eviction.
- It can be either an absolute number or a percentage (default `1` if `min-available` is also not set).
- Only one of `max-unavailable` and `min-available` can be specified.
+ description: The number of pods for the Integration that can
+ be unavailable after an eviction. It can be either an absolute
+ number or a percentage (default `1` if `min-available` is
+ also not set). Only one of `max-unavailable` and `min-available`
+ can be specified.
type: string
minAvailable:
- description: |-
- The number of pods for the Integration that must still be available after an eviction.
- It can be either an absolute number or a percentage.
- Only one of `min-available` and `max-unavailable` can be specified.
+ description: The number of pods for the Integration that must
+ still be available after an eviction. It can be either an
+ absolute number or a percentage. Only one of `min-available`
+ and `max-unavailable` can be specified.
type: string
type: object
platform:
description: The configuration of Platform trait
properties:
auto:
- description: |-
- To automatically detect from the environment if a default platform can be created (it will be created on OpenShift or when a registry address is set).
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'To automatically detect from the environment
+ if a default platform can be created (it will be created
+ on OpenShift or when a registry address is set). Deprecated:
+ Platform is auto generated by the operator install procedure
+ - maintained for backward compatibility'
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
createDefault:
- description: |-
- To create a default (empty) platform when the platform is missing.
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'To create a default (empty) platform when the
+ platform is missing. Deprecated: Platform is auto generated
+ by the operator install procedure - maintained for backward
+ compatibility'
type: boolean
enabled:
description: 'Deprecated: no longer in use.'
type: boolean
global:
- description: |-
- Indicates if the platform should be created globally in the case of global operator (default true).
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'Indicates if the platform should be created
+ globally in the case of global operator (default true).
+ Deprecated: Platform is auto generated by the operator install
+ procedure - maintained for backward compatibility'
type: boolean
type: object
pod:
description: The configuration of Pod trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7676,9 +7871,8 @@ spec:
description: The configuration of Prometheus trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7704,9 +7898,8 @@ spec:
secret on the pod if it is of type `kubernetes.io/dockerconfigjson`.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7729,10 +7922,10 @@ spec:
description: The configuration of Quarkus trait
properties:
buildMode:
- description: |-
- The Quarkus mode to run: either `jvm` or `native` (default `jvm`).
- In case both `jvm` and `native` are specified, two `IntegrationKit` resources are created,
- with the `native` kit having precedence over the `jvm` one once ready.
+ description: 'The Quarkus mode to run: either `jvm` or `native`
+ (default `jvm`). In case both `jvm` and `native` are specified,
+ two `IntegrationKit` resources are created, with the `native`
+ kit having precedence over the `jvm` one once ready.'
items:
description: QuarkusMode is the type of Quarkus build packaging.
enum:
@@ -7741,9 +7934,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7759,18 +7951,18 @@ spec:
in the runtime catalog)
type: string
packageTypes:
- description: |-
- The Quarkus package types, `fast-jar` or `native` (default `fast-jar`).
- In case both `fast-jar` and `native` are specified, two `IntegrationKit` resources are created,
- with the native kit having precedence over the `fast-jar` one once ready.
- The order influences the resolution of the current kit for the integration.
- The kit corresponding to the first package type will be assigned to the
- integration in case no existing kit that matches the integration exists.
- Deprecated: use `build-mode` instead.
+ description: 'The Quarkus package types, `fast-jar` or `native`
+ (default `fast-jar`). In case both `fast-jar` and `native`
+ are specified, two `IntegrationKit` resources are created,
+ with the native kit having precedence over the `fast-jar`
+ one once ready. The order influences the resolution of the
+ current kit for the integration. The kit corresponding to
+ the first package type will be assigned to the integration
+ in case no existing kit that matches the integration exists.
+ Deprecated: use `build-mode` instead.'
items:
- description: |-
- QuarkusPackageType is the type of Quarkus build packaging.
- Deprecated: use `QuarkusMode` instead.
+ description: 'QuarkusPackageType is the type of Quarkus
+ build packaging. Deprecated: use `QuarkusMode` instead.'
enum:
- fast-jar
- native
@@ -7778,14 +7970,12 @@ spec:
type: array
type: object
registry:
- description: |-
- The configuration of Registry trait (support removed since version 2.5.0).
- Deprecated: use jvm trait or read documentation.
+ description: 'The configuration of Registry trait (support removed
+ since version 2.5.0). Deprecated: use jvm trait or read documentation.'
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7799,16 +7989,14 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to route.
- This can be used to set route specific annotations
- For annotations options see https://docs.openshift.com/container-platform/3.11/architecture/networking/routes.html#route-specific-annotations
- CLI usage example: -t "route.annotations.'haproxy.router.openshift.io/balance'=true"
+ description: 'The annotations added to route. This can be
+ used to set route specific annotations For annotations options
+ see https://docs.openshift.com/container-platform/3.11/architecture/networking/routes.html#route-specific-annotations
+ CLI usage example: -t "route.annotations.''haproxy.router.openshift.io/balance''=true"'
type: object
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7819,82 +8007,74 @@ spec:
description: To configure the host exposed by the route.
type: string
tlsCACertificate:
- description: |-
- The TLS CA certificate contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS CA certificate contents. \n Refer to
+ the OpenShift route documentation for additional information."
type: string
tlsCACertificateSecret:
- description: |-
- The secret name and key reference to the TLS CA certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the TLS
+ CA certificate. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only one
+ key in the secret it will be read, otherwise you can set
+ a key name separated with a \"/\". \n Refer to the OpenShift
+ route documentation for additional information."
type: string
tlsCertificate:
- description: |-
- The TLS certificate contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS certificate contents. \n Refer to the
+ OpenShift route documentation for additional information."
type: string
tlsCertificateSecret:
- description: |-
- The secret name and key reference to the TLS certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the TLS
+ certificate. The format is \"secret-name[/key-name]\", the
+ value represents the secret name, if there is only one key
+ in the secret it will be read, otherwise you can set a key
+ name separated with a \"/\". \n Refer to the OpenShift route
+ documentation for additional information."
type: string
tlsDestinationCACertificate:
- description: |-
- The destination CA certificate provides the contents of the ca certificate of the final destination. When using reencrypt
- termination this file should be provided in order to have routers use it for health checks on the secure connection.
- If this field is not specified, the router may provide its own destination CA and perform hostname validation using
- the short service name (service.namespace.svc), which allows infrastructure generated certificates to automatically
- verify.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The destination CA certificate provides the
+ contents of the ca certificate of the final destination.
+ \ When using reencrypt termination this file should be provided
+ in order to have routers use it for health checks on the
+ secure connection. If this field is not specified, the router
+ may provide its own destination CA and perform hostname
+ validation using the short service name (service.namespace.svc),
+ which allows infrastructure generated certificates to automatically
+ verify. \n Refer to the OpenShift route documentation for
+ additional information."
type: string
tlsDestinationCACertificateSecret:
- description: |-
- The secret name and key reference to the destination CA certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the destination
+ CA certificate. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only one
+ key in the secret it will be read, otherwise you can set
+ a key name separated with a \"/\". \n Refer to the OpenShift
+ route documentation for additional information."
type: string
tlsInsecureEdgeTerminationPolicy:
- description: |-
- To configure how to deal with insecure traffic, e.g. `Allow`, `Disable` or `Redirect` traffic.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "To configure how to deal with insecure traffic,
+ e.g. `Allow`, `Disable` or `Redirect` traffic. \n Refer
+ to the OpenShift route documentation for additional information."
enum:
- None
- Allow
- Redirect
type: string
tlsKey:
- description: |-
- The TLS certificate key contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS certificate key contents. \n Refer to
+ the OpenShift route documentation for additional information."
type: string
tlsKeySecret:
- description: |-
- The secret name and key reference to the TLS certificate key. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the TLS
+ certificate key. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only one
+ key in the secret it will be read, otherwise you can set
+ a key name separated with a \"/\". \n Refer to the OpenShift
+ route documentation for additional information."
type: string
tlsTermination:
- description: |-
- The TLS termination type, like `edge`, `passthrough` or `reencrypt`.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS termination type, like `edge`, `passthrough`
+ or `reencrypt`. \n Refer to the OpenShift route documentation
+ for additional information."
enum:
- edge
- reencrypt
@@ -7905,9 +8085,8 @@ spec:
description: The configuration of Security Context trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7939,9 +8118,8 @@ spec:
needs to be created.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7949,9 +8127,8 @@ spec:
traits share this common property.
type: boolean
nodePort:
- description: |-
- Enable Service to be exposed as NodePort (default `false`).
- Deprecated: Use service type instead.
+ description: 'Enable Service to be exposed as NodePort (default
+ `false`). Deprecated: Use service type instead.'
type: boolean
type:
description: The type of service to be used, either 'ClusterIP',
@@ -7966,9 +8143,8 @@ spec:
description: The configuration of Service Binding trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7995,9 +8171,8 @@ spec:
description: The configuration of Toleration trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -8081,15 +8256,12 @@ spec:
the condition's last transition.
type: string
status:
- description: |-
- Status is the status of the condition.
- Can be True, False, Unknown.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
+ description: 'Status is the status of the condition.
+ Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions'
type: string
type:
- description: |-
- Type is the type of the condition.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
+ description: 'Type is the type of the condition. More
+ info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions'
type: string
required:
- status
@@ -8099,10 +8271,10 @@ spec:
items:
properties:
data:
- description: |-
- RawMessage is a raw encoded JSON value.
+ description: RawMessage is a raw encoded JSON value.
It implements Marshaler and Unmarshaler and can
- be used to delay JSON decoding or precompute a JSON encoding.
+ be used to delay JSON decoding or precompute a
+ JSON encoding.
x-kubernetes-preserve-unknown-fields: true
name:
type: string
@@ -8131,9 +8303,7 @@ spec:
type: object
type: array
configuration:
- description: |-
- Deprecated:
- a list of configuration specification
+ description: 'Deprecated: a list of configuration specification'
items:
description: ConfigurationSpec represents a generic configuration
specification.
@@ -8184,8 +8354,7 @@ spec:
description: True if the spec is generated from a Kamelet
type: boolean
interceptors:
- description: |-
- Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
+ description: Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
uses to pre/post process sources
items:
type: string
@@ -8195,9 +8364,8 @@ spec:
to interpret this source code
type: string
loader:
- description: |-
- Loader is an optional id of the org.apache.camel.k.RoutesLoader that will
- interpret this source at runtime
+ description: Loader is an optional id of the org.apache.camel.k.RoutesLoader
+ that will interpret this source at runtime
type: string
name:
description: the name of the specification
@@ -8232,43 +8400,35 @@ spec:
description: API version of the referent.
type: string
fieldPath:
- description: |-
- If referring to a piece of an object instead of an entire object, this string
- should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
- For example, if the object reference is to a container within a pod, this would take on a value like:
- "spec.containers{name}" (where "name" refers to the name of the container that triggered
- the event) or if no container name is specified "spec.containers[2]" (container with
- index 2 in this pod). This syntax is chosen only to have some well-defined way of
- referencing a part of an object.
- TODO: this design is not final and this field is subject to change in the future.
+ description: 'If referring to a piece of an object instead of
+ an entire object, this string should contain a valid JSON/Go
+ field access statement, such as desiredState.manifest.containers[2].
+ For example, if the object reference is to a container within
+ a pod, this would take on a value like: "spec.containers{name}"
+ (where "name" refers to the name of the container that triggered
+ the event) or if no container name is specified "spec.containers[2]"
+ (container with index 2 in this pod). This syntax is chosen
+ only to have some well-defined way of referencing a part of
+ an object. TODO: this design is not final and this field is
+ subject to change in the future.'
type: string
kind:
- description: |-
- Kind of the referent.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ 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: 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'
type: string
namespace:
- description: |-
- Namespace of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
+ description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type: string
resourceVersion:
- description: |-
- Specific resourceVersion to which this reference is made, if any.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
+ description: 'Specific resourceVersion to which this reference
+ is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
type: string
uid:
- description: |-
- UID of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
+ description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
type: string
type: object
- x-kubernetes-map-type: atomic
lastInitTimestamp:
description: the timestamp representing the last time when this integration
was initialized.
@@ -8314,3 +8474,9 @@ spec:
specReplicasPath: .spec.replicas
statusReplicasPath: .status.replicas
status: {}
+status:
+ acceptedNames:
+ kind: ""
+ plural: ""
+ conditions: []
+ storedVersions: []
diff --git a/pkg/resources/config/crd/bases/camel.apache.org_kameletbindings.yaml b/pkg/resources/config/crd/bases/camel.apache.org_kameletbindings.yaml
index 236d804021..f23ff32d53 100644
--- a/pkg/resources/config/crd/bases/camel.apache.org_kameletbindings.yaml
+++ b/pkg/resources/config/crd/bases/camel.apache.org_kameletbindings.yaml
@@ -15,12 +15,14 @@
# limitations under the License.
# ---------------------------------------------------------------------------
+
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
- controller-gen.kubebuilder.io/version: v0.15.0
+ controller-gen.kubebuilder.io/version: v0.6.1
+ creationTimestamp: null
name: kameletbindings.camel.apache.org
spec:
group: camel.apache.org
@@ -54,19 +56,14 @@ spec:
description: KameletBinding is the Schema for the kamelets binding API.
properties:
apiVersion:
- description: |-
- APIVersion defines the versioned schema of this representation of an object.
- Servers should convert recognized schemas to the latest internal value, and
- may reject unrecognized values.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+ description: 'APIVersion defines the versioned schema of this representation
+ of an object. Servers should convert recognized schemas to the latest
+ internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: |-
- Kind is a string value representing the REST resource this object represents.
- Servers may infer this from the endpoint the client submits requests to.
- Cannot be updated.
- In CamelCase.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ description: 'Kind is a string value representing the REST resource this
+ object represents. Servers may infer this from the endpoint the client
+ submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
@@ -83,12 +80,10 @@ spec:
custom parameters
properties:
configuration:
- description: |-
- Deprecated:
- Use camel trait (camel.properties) to manage properties
- Use mount trait (mount.configs) to manage configs
- Use mount trait (mount.resources) to manage resources
- Use mount trait (mount.volumes) to manage volumes
+ description: 'Deprecated: Use camel trait (camel.properties) to
+ manage properties Use mount trait (mount.configs) to manage
+ configs Use mount trait (mount.resources) to manage resources
+ Use mount trait (mount.volumes) to manage volumes'
items:
description: ConfigurationSpec represents a generic configuration
specification.
@@ -129,43 +124,35 @@ spec:
description: API version of the referent.
type: string
fieldPath:
- description: |-
- If referring to a piece of an object instead of an entire object, this string
- should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
- For example, if the object reference is to a container within a pod, this would take on a value like:
- "spec.containers{name}" (where "name" refers to the name of the container that triggered
- the event) or if no container name is specified "spec.containers[2]" (container with
- index 2 in this pod). This syntax is chosen only to have some well-defined way of
- referencing a part of an object.
- TODO: this design is not final and this field is subject to change in the future.
+ description: 'If referring to a piece of an object instead
+ of an entire object, this string should contain a valid
+ JSON/Go field access statement, such as desiredState.manifest.containers[2].
+ For example, if the object reference is to a container within
+ a pod, this would take on a value like: "spec.containers{name}"
+ (where "name" refers to the name of the container that triggered
+ the event) or if no container name is specified "spec.containers[2]"
+ (container with index 2 in this pod). This syntax is chosen
+ only to have some well-defined way of referencing a part
+ of an object. TODO: this design is not final and this field
+ is subject to change in the future.'
type: string
kind:
- description: |-
- Kind of the referent.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ 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: 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'
type: string
namespace:
- description: |-
- Namespace of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
+ description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type: string
resourceVersion:
- description: |-
- Specific resourceVersion to which this reference is made, if any.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
+ description: 'Specific resourceVersion to which this reference
+ is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
type: string
uid:
- description: |-
- UID of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
+ description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
type: string
type: object
- x-kubernetes-map-type: atomic
profile:
description: the profile needed to run this Integration
type: string
@@ -206,8 +193,7 @@ spec:
description: True if the spec is generated from a Kamelet
type: boolean
interceptors:
- description: |-
- Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
+ description: Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
uses to pre/post process sources
items:
type: string
@@ -217,9 +203,8 @@ spec:
to interpret this source code
type: string
loader:
- description: |-
- Loader is an optional id of the org.apache.camel.k.RoutesLoader that will
- interpret this source at runtime
+ description: Loader is an optional id of the org.apache.camel.k.RoutesLoader
+ that will interpret this source at runtime
type: string
name:
description: the name of the specification
@@ -263,35 +248,39 @@ spec:
want to run within a pod.
properties:
args:
- description: |-
- Arguments to the entrypoint.
- The container image's CMD is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Arguments to the entrypoint. The container
+ image''s CMD is used if this is not provided.
+ Variable references $(VAR_NAME) are expanded using
+ the container''s environment. If a variable cannot
+ be resolved, the reference in the input string
+ will be unchanged. Double $$ are reduced to a
+ single $, which allows for escaping the $(VAR_NAME)
+ syntax: i.e. "$$(VAR_NAME)" will produce the string
+ literal "$(VAR_NAME)". Escaped references will
+ never be expanded, regardless of whether the variable
+ exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
command:
- description: |-
- Entrypoint array. Not executed within a shell.
- The container image's ENTRYPOINT is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Entrypoint array. Not executed within
+ a shell. The container image''s ENTRYPOINT is
+ used if this is not provided. Variable references
+ $(VAR_NAME) are expanded using the container''s
+ environment. If a variable cannot be resolved,
+ the reference in the input string will be unchanged.
+ Double $$ are reduced to a single $, which allows
+ for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)"
+ will produce the string literal "$(VAR_NAME)".
+ Escaped references will never be expanded, regardless
+ of whether the variable exists or not. Cannot
+ be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
env:
- description: |-
- List of environment variables to set in the container.
- Cannot be updated.
+ description: List of environment variables to set
+ in the container. Cannot be updated.
items:
description: EnvVar represents an environment
variable present in a Container.
@@ -301,16 +290,18 @@ spec:
Must be a C_IDENTIFIER.
type: string
value:
- description: |-
- Variable references $(VAR_NAME) are expanded
- using the previously defined environment variables in the container and
- any service environment variables. If a variable cannot be resolved,
- the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
- "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
- Escaped references will never be expanded, regardless of whether the variable
- exists or not.
- Defaults to "".
+ description: 'Variable references $(VAR_NAME)
+ are expanded using the previously defined
+ environment variables in the container and
+ any service environment variables. If a
+ variable cannot be resolved, the reference
+ in the input string will be unchanged. Double
+ $$ are reduced to a single $, which allows
+ for escaping the $(VAR_NAME) syntax: i.e.
+ "$$(VAR_NAME)" will produce the string literal
+ "$(VAR_NAME)". Escaped references will never
+ be expanded, regardless of whether the variable
+ exists or not. Defaults to "".'
type: string
valueFrom:
description: Source for the environment variable's
@@ -323,10 +314,10 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
+ description: 'Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
@@ -335,11 +326,12 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
fieldRef:
- description: |-
- Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`,
- spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ description: 'Selects a field of the pod:
+ supports metadata.name, metadata.namespace,
+ `metadata.labels['''']`, `metadata.annotations['''']`,
+ spec.nodeName, spec.serviceAccountName,
+ status.hostIP, status.podIP, status.podIPs.'
properties:
apiVersion:
description: Version of the schema
@@ -353,11 +345,13 @@ spec:
required:
- fieldPath
type: object
- x-kubernetes-map-type: atomic
resourceFieldRef:
- description: |-
- Selects a resource of the container: only resources limits and requests
- (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
+ description: 'Selects a resource of the
+ container: only resources limits and
+ requests (limits.cpu, limits.memory,
+ limits.ephemeral-storage, requests.cpu,
+ requests.memory and requests.ephemeral-storage)
+ are currently supported.'
properties:
containerName:
description: 'Container name: required
@@ -379,7 +373,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret
in the pod's namespace
@@ -390,10 +383,10 @@ spec:
secret key.
type: string
name:
- description: |-
- Name of the referent.
+ description: 'Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret
@@ -402,20 +395,21 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
required:
- name
type: object
type: array
envFrom:
- description: |-
- List of sources to populate environment variables in the container.
- The keys defined within a source must be a C_IDENTIFIER. All invalid keys
- will be reported as an event when the container is starting. When a key exists in multiple
- sources, the value associated with the last source will take precedence.
- Values defined by an Env with a duplicate key will take precedence.
- Cannot be updated.
+ description: List of sources to populate environment
+ variables in the container. The keys defined within
+ a source must be a C_IDENTIFIER. All invalid keys
+ will be reported as an event when the container
+ is starting. When a key exists in multiple sources,
+ the value associated with the last source will
+ take precedence. Values defined by an Env with
+ a duplicate key will take precedence. Cannot be
+ updated.
items:
description: EnvFromSource represents the source
of a set of ConfigMaps
@@ -424,17 +418,16 @@ spec:
description: The ConfigMap to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
prefix:
description: An optional identifier to prepend
to each key in the ConfigMap. Must be a
@@ -444,57 +437,59 @@ spec:
description: The Secret to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret
must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
image:
- description: |-
- Container image name.
- More info: https://kubernetes.io/docs/concepts/containers/images
- This field is optional to allow higher level config management to default or override
- container images in workload controllers like Deployments and StatefulSets.
+ description: 'Container image name. More info: https://kubernetes.io/docs/concepts/containers/images
+ This field is optional to allow higher level config
+ management to default or override container images
+ in workload controllers like Deployments and StatefulSets.'
type: string
imagePullPolicy:
- description: |-
- Image pull policy.
- One of Always, Never, IfNotPresent.
- Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
+ description: 'Image pull policy. One of Always,
+ Never, IfNotPresent. Defaults to Always if :latest
+ tag is specified, or IfNotPresent otherwise. Cannot
+ be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
- description: |-
- Actions that the management system should take in response to container lifecycle events.
- Cannot be updated.
+ description: Actions that the management system
+ should take in response to container lifecycle
+ events. Cannot be updated.
properties:
postStart:
- description: |-
- PostStart is called immediately after a container is created. If the handler fails,
- the container is terminated and restarted according to its restart policy.
- Other management of the container blocks until the hook completes.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PostStart is called immediately
+ after a container is created. If the handler
+ fails, the container is terminated and restarted
+ according to its restart policy. Other management
+ of the container blocks until the hook completes.
+ More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to
take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command
+ line to execute inside the container,
+ the working directory for the command is
+ root ('/') in the container's filesystem.
+ The command is simply exec'd, it is
+ not run inside a shell, so traditional
+ shell instructions ('|', etc) won't
+ work. To use a shell, you need to
+ explicitly call out to that shell.
+ Exit status of 0 is treated as live/healthy
+ and non-zero is unhealthy.
items:
type: string
type: array
@@ -504,9 +499,10 @@ spec:
request to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to,
+ defaults to the pod IP. You probably
+ want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
description: Custom headers to set in
@@ -518,9 +514,11 @@ spec:
probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field
+ name. This will be canonicalized
+ upon output, so case-variant
+ names will be understood as
+ the same header.
type: string
value:
description: The header field
@@ -539,15 +537,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -566,10 +563,12 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT
+ supported as a LifecycleHandler and kept
+ for the backward compatibility. There
+ are no validation of this field and lifecycle
+ hooks will fail in runtime when tcp handler
+ is specified.
properties:
host:
description: 'Optional: Host name to
@@ -579,38 +578,47 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
preStop:
- description: |-
- PreStop is called immediately before a container is terminated due to an
- API request or management event such as liveness/startup probe failure,
- preemption, resource contention, etc. The handler is not called if the
- container crashes or exits. The Pod's termination grace period countdown begins before the
- PreStop hook is executed. Regardless of the outcome of the handler, the
- container will eventually terminate within the Pod's termination grace
- period (unless delayed by finalizers). Other management of the container blocks until the hook completes
- or until the termination grace period is reached.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PreStop is called immediately
+ before a container is terminated due to an
+ API request or management event such as liveness/startup
+ probe failure, preemption, resource contention,
+ etc. The handler is not called if the container
+ crashes or exits. The Pod''s termination grace
+ period countdown begins before the PreStop
+ hook is executed. Regardless of the outcome
+ of the handler, the container will eventually
+ terminate within the Pod''s termination grace
+ period (unless delayed by finalizers). Other
+ management of the container blocks until the
+ hook completes or until the termination grace
+ period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to
take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command
+ line to execute inside the container,
+ the working directory for the command is
+ root ('/') in the container's filesystem.
+ The command is simply exec'd, it is
+ not run inside a shell, so traditional
+ shell instructions ('|', etc) won't
+ work. To use a shell, you need to
+ explicitly call out to that shell.
+ Exit status of 0 is treated as live/healthy
+ and non-zero is unhealthy.
items:
type: string
type: array
@@ -620,9 +628,10 @@ spec:
request to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to,
+ defaults to the pod IP. You probably
+ want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
description: Custom headers to set in
@@ -634,9 +643,11 @@ spec:
probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field
+ name. This will be canonicalized
+ upon output, so case-variant
+ names will be understood as
+ the same header.
type: string
value:
description: The header field
@@ -655,15 +666,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -682,10 +692,12 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT
+ supported as a LifecycleHandler and kept
+ for the backward compatibility. There
+ are no validation of this field and lifecycle
+ hooks will fail in runtime when tcp handler
+ is specified.
properties:
host:
description: 'Optional: Host name to
@@ -695,10 +707,10 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
@@ -706,30 +718,33 @@ spec:
type: object
type: object
livenessProbe:
- description: |-
- Periodic probe of container liveness.
+ 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
+ Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -742,12 +757,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -757,8 +771,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -769,9 +783,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -789,35 +804,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -832,59 +847,63 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
name:
- description: |-
- Name of the container specified as a DNS_LABEL.
- Each container in a pod must have a unique name (DNS_LABEL).
- Cannot be updated.
+ description: Name of the container specified as
+ a DNS_LABEL. Each container in a pod must have
+ a unique name (DNS_LABEL). Cannot be updated.
type: string
ports:
- description: |-
- List of ports to expose from the container. Not specifying a port here
- DOES NOT prevent that port from being exposed. Any port which is
- listening on the default "0.0.0.0" address inside a container will be
- accessible from the network.
- Modifying this array with strategic merge patch may corrupt the data.
- For more information See https://github.com/kubernetes/kubernetes/issues/108255.
+ description: List of ports to expose from the container.
+ Not specifying a port here DOES NOT prevent that
+ port from being exposed. Any port which is listening
+ on the default "0.0.0.0" address inside a container
+ will be accessible from the network. Modifying
+ this array with strategic merge patch may corrupt
+ the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255.
Cannot be updated.
items:
description: ContainerPort represents a network
port in a single container.
properties:
containerPort:
- description: |-
- Number of port to expose on the pod's IP address.
- This must be a valid port number, 0 < x < 65536.
+ description: Number of port to expose on the
+ pod's IP address. This must be a valid port
+ number, 0 < x < 65536.
format: int32
type: integer
hostIP:
@@ -892,24 +911,24 @@ spec:
port to.
type: string
hostPort:
- description: |-
- Number of port to expose on the host.
- If specified, this must be a valid port number, 0 < x < 65536.
- If HostNetwork is specified, this must match ContainerPort.
+ description: Number of port to expose on the
+ host. If specified, this must be a valid
+ port number, 0 < x < 65536. If HostNetwork
+ is specified, this must match ContainerPort.
Most containers do not need this.
format: int32
type: integer
name:
- description: |-
- If specified, this must be an IANA_SVC_NAME and unique within the pod. Each
- named port in a pod must have a unique name. Name for the port that can be
- referred to by services.
+ description: If specified, this must be an
+ IANA_SVC_NAME and unique within the pod.
+ Each named port in a pod must have a unique
+ name. Name for the port that can be referred
+ to by services.
type: string
protocol:
default: TCP
- description: |-
- Protocol for port. Must be UDP, TCP, or SCTP.
- Defaults to "TCP".
+ description: Protocol for port. Must be UDP,
+ TCP, or SCTP. Defaults to "TCP".
type: string
required:
- containerPort
@@ -920,30 +939,34 @@ spec:
- protocol
x-kubernetes-list-type: map
readinessProbe:
- description: |-
- Periodic probe of container service readiness.
- Container will be removed from service endpoints if the probe fails.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Periodic probe of container service
+ readiness. Container will be removed from service
+ endpoints if the probe fails. Cannot be updated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -956,12 +979,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -971,8 +993,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -983,9 +1005,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -1003,35 +1026,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -1046,33 +1069,38 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
@@ -1083,14 +1111,14 @@ spec:
resource resize policy for the container.
properties:
resourceName:
- description: |-
- Name of the resource to which this resource resize policy applies.
- Supported values: cpu, memory.
+ description: 'Name of the resource to which
+ this resource resize policy applies. Supported
+ values: cpu, memory.'
type: string
restartPolicy:
- description: |-
- Restart policy to apply when specified resource is resized.
- If not specified, it defaults to NotRequired.
+ description: Restart policy to apply when
+ specified resource is resized. If not specified,
+ it defaults to NotRequired.
type: string
required:
- resourceName
@@ -1099,31 +1127,26 @@ spec:
type: array
x-kubernetes-list-type: atomic
resources:
- description: |-
- Compute Resources required by this container.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Compute Resources required by this
+ container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
properties:
claims:
- description: |-
- Claims lists the names of resources, defined in spec.resourceClaims,
- that are used by this container.
-
-
- This is an alpha field and requires enabling the
- DynamicResourceAllocation feature gate.
-
-
- This field is immutable. It can only be set for containers.
+ description: "Claims lists the names of resources,
+ defined in spec.resourceClaims, that are used
+ by this container. \n This is an alpha field
+ and requires enabling the DynamicResourceAllocation
+ feature gate. \n This field is immutable.
+ It can only be set for containers."
items:
description: ResourceClaim references one
entry in PodSpec.ResourceClaims.
properties:
name:
- description: |-
- Name must match the name of one entry in pod.spec.resourceClaims of
- the Pod where this field is used. It makes that resource available
- inside a container.
+ description: Name must match the name
+ of one entry in pod.spec.resourceClaims
+ of the Pod where this field is used.
+ It makes that resource available inside
+ a container.
type: string
required:
- name
@@ -1139,9 +1162,8 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Limits describes the maximum amount of compute resources allowed.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Limits describes the maximum amount
+ of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -1150,52 +1172,61 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Requests describes the minimum amount of compute resources required.
- If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
- otherwise to an implementation-defined value. Requests cannot exceed Limits.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Requests describes the minimum
+ amount of compute resources required. If Requests
+ is omitted for a container, it defaults to
+ Limits if that is explicitly specified, otherwise
+ to an implementation-defined value. Requests
+ cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
restartPolicy:
- description: |-
- RestartPolicy defines the restart behavior of individual containers in a pod.
- This field may only be set for init containers, and the only allowed value is "Always".
- For non-init containers or when this field is not specified,
- the restart behavior is defined by the Pod's restart policy and the container type.
- Setting the RestartPolicy as "Always" for the init container will have the following effect:
- this init container will be continually restarted on
- exit until all regular containers have terminated. Once all regular
- containers have completed, all init containers with restartPolicy "Always"
- will be shut down. This lifecycle differs from normal init containers and
- is often referred to as a "sidecar" container. Although this init
- container still starts in the init container sequence, it does not wait
- for the container to complete before proceeding to the next init
- container. Instead, the next init container starts immediately after this
- init container is started, or after any startupProbe has successfully
- completed.
+ description: 'RestartPolicy defines the restart
+ behavior of individual containers in a pod. This
+ field may only be set for init containers, and
+ the only allowed value is "Always". For non-init
+ containers or when this field is not specified,
+ the restart behavior is defined by the Pod''s
+ restart policy and the container type. Setting
+ the RestartPolicy as "Always" for the init container
+ will have the following effect: this init container
+ will be continually restarted on exit until all
+ regular containers have terminated. Once all regular
+ containers have completed, all init containers
+ with restartPolicy "Always" will be shut down.
+ This lifecycle differs from normal init containers
+ and is often referred to as a "sidecar" container.
+ Although this init container still starts in the
+ init container sequence, it does not wait for
+ the container to complete before proceeding to
+ the next init container. Instead, the next init
+ container starts immediately after this init container
+ is started, or after any startupProbe has successfully
+ completed.'
type: string
securityContext:
- description: |-
- SecurityContext defines the security options the container should be run with.
- If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
- More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
+ description: 'SecurityContext defines the security
+ options the container should be run with. If set,
+ the fields of SecurityContext override the equivalent
+ fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
properties:
allowPrivilegeEscalation:
- description: |-
- AllowPrivilegeEscalation controls whether a process can gain more
- privileges than its parent process. This bool directly controls if
- the no_new_privs flag will be set on the container process.
- AllowPrivilegeEscalation is true always when the container is:
- 1) run as Privileged
- 2) has CAP_SYS_ADMIN
- Note that this field cannot be set when spec.os.name is windows.
+ description: 'AllowPrivilegeEscalation controls
+ whether a process can gain more privileges
+ than its parent process. This bool directly
+ controls if the no_new_privs flag will be
+ set on the container process. AllowPrivilegeEscalation
+ is true always when the container is: 1) run
+ as Privileged 2) has CAP_SYS_ADMIN Note that
+ this field cannot be set when spec.os.name
+ is windows.'
type: boolean
capabilities:
- description: |-
- The capabilities to add/drop when running containers.
- Defaults to the default set of capabilities granted by the container runtime.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The capabilities to add/drop when
+ running containers. Defaults to the default
+ set of capabilities granted by the container
+ runtime. Note that this field cannot be set
+ when spec.os.name is windows.
properties:
add:
description: Added capabilities
@@ -1213,60 +1244,69 @@ spec:
type: array
type: object
privileged:
- description: |-
- Run container in privileged mode.
- Processes in privileged containers are essentially equivalent to root on the host.
- Defaults to false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Run container in privileged mode.
+ Processes in privileged containers are essentially
+ equivalent to root on the host. Defaults to
+ false. Note that this field cannot be set
+ when spec.os.name is windows.
type: boolean
procMount:
- description: |-
- procMount denotes the type of proc mount to use for the containers.
- The default is DefaultProcMount which uses the container runtime defaults for
- readonly paths and masked paths.
- This requires the ProcMountType feature flag to be enabled.
- Note that this field cannot be set when spec.os.name is windows.
+ description: procMount denotes the type of proc
+ mount to use for the containers. The default
+ is DefaultProcMount which uses the container
+ runtime defaults for readonly paths and masked
+ paths. This requires the ProcMountType feature
+ flag to be enabled. Note that this field cannot
+ be set when spec.os.name is windows.
type: string
readOnlyRootFilesystem:
- description: |-
- Whether this container has a read-only root filesystem.
- Default is false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Whether this container has a read-only
+ root filesystem. Default is false. Note that
+ this field cannot be set when spec.os.name
+ is windows.
type: boolean
runAsGroup:
- description: |-
- The GID to run the entrypoint of the container process.
- Uses runtime default if unset.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The GID to run the entrypoint of
+ the container process. Uses runtime default
+ if unset. May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is windows.
format: int64
type: integer
runAsNonRoot:
- description: |-
- Indicates that the container must run as a non-root user.
- If true, the Kubelet will validate the image at runtime to ensure that it
- does not run as UID 0 (root) and fail to start the container if it does.
- If unset or false, no such validation will be performed.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: Indicates that the container must
+ run as a non-root user. If true, the Kubelet
+ will validate the image at runtime to ensure
+ that it does not run as UID 0 (root) and fail
+ to start the container if it does. If unset
+ or false, no such validation will be performed.
+ May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence.
type: boolean
runAsUser:
- description: |-
- The UID to run the entrypoint of the container process.
- Defaults to user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The UID to run the entrypoint of
+ the container process. Defaults to user specified
+ in image metadata if unspecified. May also
+ be set in PodSecurityContext. If set in both
+ SecurityContext and PodSecurityContext, the
+ value specified in SecurityContext takes precedence.
+ Note that this field cannot be set when spec.os.name
+ is windows.
format: int64
type: integer
seLinuxOptions:
- description: |-
- The SELinux context to be applied to the container.
- If unspecified, the container runtime will allocate a random SELinux context for each
- container. May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The SELinux context to be applied
+ to the container. If unspecified, the container
+ runtime will allocate a random SELinux context
+ for each container. May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is windows.
properties:
level:
description: Level is SELinux level label
@@ -1286,93 +1326,112 @@ spec:
type: string
type: object
seccompProfile:
- description: |-
- The seccomp options to use by this container. If seccomp options are
- provided at both the pod & container level, the container options
- override the pod options.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The seccomp options to use by this
+ container. If seccomp options are provided
+ at both the pod & container level, the container
+ options override the pod options. Note that
+ this field cannot be set when spec.os.name
+ is windows.
properties:
localhostProfile:
- description: |-
- localhostProfile indicates a profile defined in a file on the node should be used.
- The profile must be preconfigured on the node to work.
- Must be a descending path, relative to the kubelet's configured seccomp profile location.
- Must be set if type is "Localhost". Must NOT be set for any other type.
+ description: localhostProfile indicates
+ a profile defined in a file on the node
+ should be used. The profile must be preconfigured
+ on the node to work. Must be a descending
+ path, relative to the kubelet's configured
+ seccomp profile location. Must be set
+ if type is "Localhost". Must NOT be set
+ for any other type.
type: string
type:
- description: |-
- type indicates which kind of seccomp profile will be applied.
- Valid options are:
-
-
- Localhost - a profile defined in a file on the node should be used.
- RuntimeDefault - the container runtime default profile should be used.
- Unconfined - no profile should be applied.
+ description: "type indicates which kind
+ of seccomp profile will be applied. Valid
+ options are: \n Localhost - a profile
+ defined in a file on the node should be
+ used. RuntimeDefault - the container runtime
+ default profile should be used. Unconfined
+ - no profile should be applied."
type: string
required:
- type
type: object
windowsOptions:
- description: |-
- The Windows specific settings applied to all containers.
- If unspecified, the options from the PodSecurityContext will be used.
- If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is linux.
+ description: The Windows specific settings applied
+ to all containers. If unspecified, the options
+ from the PodSecurityContext will be used.
+ If set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is linux.
properties:
gmsaCredentialSpec:
- description: |-
- GMSACredentialSpec is where the GMSA admission webhook
- (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
- GMSA credential spec named by the GMSACredentialSpecName field.
+ description: GMSACredentialSpec is where
+ the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa)
+ inlines the contents of the GMSA credential
+ spec named by the GMSACredentialSpecName
+ field.
type: string
gmsaCredentialSpecName:
description: GMSACredentialSpecName is the
name of the GMSA credential spec to use.
type: string
hostProcess:
- description: |-
- HostProcess determines if a container should be run as a 'Host Process' container.
- All of a Pod's containers must have the same effective HostProcess value
- (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
- In addition, if HostProcess is true then HostNetwork must also be set to true.
+ description: HostProcess determines if a
+ container should be run as a 'Host Process'
+ container. All of a Pod's containers must
+ have the same effective HostProcess value
+ (it is not allowed to have a mix of HostProcess
+ containers and non-HostProcess containers).
+ In addition, if HostProcess is true then
+ HostNetwork must also be set to true.
type: boolean
runAsUserName:
- description: |-
- The UserName in Windows to run the entrypoint of the container process.
- Defaults to the user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: The UserName in Windows to
+ run the entrypoint of the container process.
+ Defaults to the user specified in image
+ metadata if unspecified. May also be set
+ in PodSecurityContext. If set in both
+ SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext
+ takes precedence.
type: string
type: object
type: object
startupProbe:
- description: |-
- StartupProbe indicates that the Pod has successfully initialized.
- If specified, no other probes are executed until this completes successfully.
- If this probe fails, the Pod will be restarted, just as if the livenessProbe failed.
- This can be used to provide different probe parameters at the beginning of a Pod's lifecycle,
- when it might take a long time to load data or warm a cache, than during steady-state operation.
- This cannot be updated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'StartupProbe indicates that the Pod
+ has successfully initialized. If specified, no
+ other probes are executed until this completes
+ successfully. If this probe fails, the Pod will
+ be restarted, just as if the livenessProbe failed.
+ This can be used to provide different probe parameters
+ at the beginning of a Pod''s lifecycle, when it
+ might take a long time to load data or warm a
+ cache, than during steady-state operation. This
+ cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -1385,12 +1444,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -1400,8 +1458,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -1412,9 +1470,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -1432,35 +1491,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -1475,76 +1534,87 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
stdin:
- description: |-
- Whether this container should allocate a buffer for stdin in the container runtime. If this
- is not set, reads from stdin in the container will always result in EOF.
- Default is false.
+ description: Whether this container should allocate
+ a buffer for stdin in the container runtime. If
+ this is not set, reads from stdin in the container
+ will always result in EOF. Default is false.
type: boolean
stdinOnce:
- description: |-
- Whether the container runtime should close the stdin channel after it has been opened by
- a single attach. When stdin is true the stdin stream will remain open across multiple attach
- sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
- first client attaches to stdin, and then remains open and accepts data until the client disconnects,
- at which time stdin is closed and remains closed until the container is restarted. If this
- flag is false, a container processes that reads from stdin will never receive an EOF.
- Default is false
+ description: Whether the container runtime should
+ close the stdin channel after it has been opened
+ by a single attach. When stdin is true the stdin
+ stream will remain open across multiple attach
+ sessions. If stdinOnce is set to true, stdin is
+ opened on container start, is empty until the
+ first client attaches to stdin, and then remains
+ open and accepts data until the client disconnects,
+ at which time stdin is closed and remains closed
+ until the container is restarted. If this flag
+ is false, a container processes that reads from
+ stdin will never receive an EOF. Default is false
type: boolean
terminationMessagePath:
- description: |-
- Optional: Path at which the file to which the container's termination message
- will be written is mounted into the container's filesystem.
- Message written is intended to be brief final status, such as an assertion failure message.
- Will be truncated by the node if greater than 4096 bytes. The total message length across
- all containers will be limited to 12kb.
- Defaults to /dev/termination-log.
- Cannot be updated.
+ description: 'Optional: Path at which the file to
+ which the container''s termination message will
+ be written is mounted into the container''s filesystem.
+ Message written is intended to be brief final
+ status, such as an assertion failure message.
+ Will be truncated by the node if greater than
+ 4096 bytes. The total message length across all
+ containers will be limited to 12kb. Defaults to
+ /dev/termination-log. Cannot be updated.'
type: string
terminationMessagePolicy:
- description: |-
- Indicate how the termination message should be populated. File will use the contents of
- terminationMessagePath to populate the container status message on both success and failure.
- FallbackToLogsOnError will use the last chunk of container log output if the termination
- message file is empty and the container exited with an error.
- The log output is limited to 2048 bytes or 80 lines, whichever is smaller.
- Defaults to File.
- Cannot be updated.
+ description: Indicate how the termination message
+ should be populated. File will use the contents
+ of terminationMessagePath to populate the container
+ status message on both success and failure. FallbackToLogsOnError
+ will use the last chunk of container log output
+ if the termination message file is empty and the
+ container exited with an error. The log output
+ is limited to 2048 bytes or 80 lines, whichever
+ is smaller. Defaults to File. Cannot be updated.
type: string
tty:
- description: |-
- Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
- Default is false.
+ description: Whether this container should allocate
+ a TTY for itself, also requires 'stdin' to be
+ true. Default is false.
type: boolean
volumeDevices:
description: volumeDevices is the list of block
@@ -1568,45 +1638,46 @@ spec:
type: object
type: array
volumeMounts:
- description: |-
- Pod volumes to mount into the container's filesystem.
- Cannot be updated.
+ description: Pod volumes to mount into the container's
+ filesystem. Cannot be updated.
items:
description: VolumeMount describes a mounting
of a Volume within a container.
properties:
mountPath:
- description: |-
- Path within the container at which the volume should be mounted. Must
+ description: Path within the container at
+ which the volume should be mounted. Must
not contain ':'.
type: string
mountPropagation:
- description: |-
- mountPropagation determines how mounts are propagated from the host
- to container and the other way around.
- When not set, MountPropagationNone is used.
- This field is beta in 1.10.
+ description: mountPropagation determines how
+ mounts are propagated from the host to container
+ and the other way around. When not set,
+ MountPropagationNone is used. This field
+ is beta in 1.10.
type: string
name:
description: This must match the Name of a
Volume.
type: string
readOnly:
- description: |-
- Mounted read-only if true, read-write otherwise (false or unspecified).
- Defaults to false.
+ description: Mounted read-only if true, read-write
+ otherwise (false or unspecified). Defaults
+ to false.
type: boolean
subPath:
- description: |-
- Path within the volume from which the container's volume should be mounted.
+ description: Path within the volume from which
+ the container's volume should be mounted.
Defaults to "" (volume's root).
type: string
subPathExpr:
- description: |-
- Expanded path within the volume from which the container's volume should be mounted.
- Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.
- Defaults to "" (volume's root).
- SubPathExpr and SubPath are mutually exclusive.
+ description: Expanded path within the volume
+ from which the container's volume should
+ be mounted. Behaves similarly to SubPath
+ but environment variable references $(VAR_NAME)
+ are expanded using the container's environment.
+ Defaults to "" (volume's root). SubPathExpr
+ and SubPath are mutually exclusive.
type: string
required:
- mountPath
@@ -1614,11 +1685,10 @@ spec:
type: object
type: array
workingDir:
- description: |-
- Container's working directory.
- If not specified, the container runtime's default will be used, which
- might be configured in the container image.
- Cannot be updated.
+ description: Container's working directory. If not
+ specified, the container runtime's default will
+ be used, which might be configured in the container
+ image. Cannot be updated.
type: string
required:
- name
@@ -1630,47 +1700,51 @@ spec:
ephemeralContainers:
description: EphemeralContainers
items:
- description: |-
- An EphemeralContainer is a temporary container that you may add to an existing Pod for
- user-initiated activities such as debugging. Ephemeral containers have no resource or
- scheduling guarantees, and they will not be restarted when they exit or when a Pod is
- removed or restarted. The kubelet may evict a Pod if an ephemeral container causes the
- Pod to exceed its resource allocation.
-
-
- To add an ephemeral container, use the ephemeralcontainers subresource of an existing
- Pod. Ephemeral containers may not be removed or restarted.
+ description: "An EphemeralContainer is a temporary container
+ that you may add to an existing Pod for user-initiated
+ activities such as debugging. Ephemeral containers
+ have no resource or scheduling guarantees, and they
+ will not be restarted when they exit or when a Pod
+ is removed or restarted. The kubelet may evict a Pod
+ if an ephemeral container causes the Pod to exceed
+ its resource allocation. \n To add an ephemeral container,
+ use the ephemeralcontainers subresource of an existing
+ Pod. Ephemeral containers may not be removed or restarted."
properties:
args:
- description: |-
- Arguments to the entrypoint.
- The image's CMD is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Arguments to the entrypoint. The image''s
+ CMD is used if this is not provided. Variable
+ references $(VAR_NAME) are expanded using the
+ container''s environment. If a variable cannot
+ be resolved, the reference in the input string
+ will be unchanged. Double $$ are reduced to a
+ single $, which allows for escaping the $(VAR_NAME)
+ syntax: i.e. "$$(VAR_NAME)" will produce the string
+ literal "$(VAR_NAME)". Escaped references will
+ never be expanded, regardless of whether the variable
+ exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
command:
- description: |-
- Entrypoint array. Not executed within a shell.
- The image's ENTRYPOINT is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Entrypoint array. Not executed within
+ a shell. The image''s ENTRYPOINT is used if this
+ is not provided. Variable references $(VAR_NAME)
+ are expanded using the container''s environment.
+ If a variable cannot be resolved, the reference
+ in the input string will be unchanged. Double
+ $$ are reduced to a single $, which allows for
+ escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)"
+ will produce the string literal "$(VAR_NAME)".
+ Escaped references will never be expanded, regardless
+ of whether the variable exists or not. Cannot
+ be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
env:
- description: |-
- List of environment variables to set in the container.
- Cannot be updated.
+ description: List of environment variables to set
+ in the container. Cannot be updated.
items:
description: EnvVar represents an environment
variable present in a Container.
@@ -1680,16 +1754,18 @@ spec:
Must be a C_IDENTIFIER.
type: string
value:
- description: |-
- Variable references $(VAR_NAME) are expanded
- using the previously defined environment variables in the container and
- any service environment variables. If a variable cannot be resolved,
- the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
- "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
- Escaped references will never be expanded, regardless of whether the variable
- exists or not.
- Defaults to "".
+ description: 'Variable references $(VAR_NAME)
+ are expanded using the previously defined
+ environment variables in the container and
+ any service environment variables. If a
+ variable cannot be resolved, the reference
+ in the input string will be unchanged. Double
+ $$ are reduced to a single $, which allows
+ for escaping the $(VAR_NAME) syntax: i.e.
+ "$$(VAR_NAME)" will produce the string literal
+ "$(VAR_NAME)". Escaped references will never
+ be expanded, regardless of whether the variable
+ exists or not. Defaults to "".'
type: string
valueFrom:
description: Source for the environment variable's
@@ -1702,10 +1778,10 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
+ description: 'Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
@@ -1714,11 +1790,12 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
fieldRef:
- description: |-
- Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`,
- spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ description: 'Selects a field of the pod:
+ supports metadata.name, metadata.namespace,
+ `metadata.labels['''']`, `metadata.annotations['''']`,
+ spec.nodeName, spec.serviceAccountName,
+ status.hostIP, status.podIP, status.podIPs.'
properties:
apiVersion:
description: Version of the schema
@@ -1732,11 +1809,13 @@ spec:
required:
- fieldPath
type: object
- x-kubernetes-map-type: atomic
resourceFieldRef:
- description: |-
- Selects a resource of the container: only resources limits and requests
- (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
+ description: 'Selects a resource of the
+ container: only resources limits and
+ requests (limits.cpu, limits.memory,
+ limits.ephemeral-storage, requests.cpu,
+ requests.memory and requests.ephemeral-storage)
+ are currently supported.'
properties:
containerName:
description: 'Container name: required
@@ -1758,7 +1837,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret
in the pod's namespace
@@ -1769,10 +1847,10 @@ spec:
secret key.
type: string
name:
- description: |-
- Name of the referent.
+ description: 'Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret
@@ -1781,20 +1859,21 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
required:
- name
type: object
type: array
envFrom:
- description: |-
- List of sources to populate environment variables in the container.
- The keys defined within a source must be a C_IDENTIFIER. All invalid keys
- will be reported as an event when the container is starting. When a key exists in multiple
- sources, the value associated with the last source will take precedence.
- Values defined by an Env with a duplicate key will take precedence.
- Cannot be updated.
+ description: List of sources to populate environment
+ variables in the container. The keys defined within
+ a source must be a C_IDENTIFIER. All invalid keys
+ will be reported as an event when the container
+ is starting. When a key exists in multiple sources,
+ the value associated with the last source will
+ take precedence. Values defined by an Env with
+ a duplicate key will take precedence. Cannot be
+ updated.
items:
description: EnvFromSource represents the source
of a set of ConfigMaps
@@ -1803,17 +1882,16 @@ spec:
description: The ConfigMap to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
prefix:
description: An optional identifier to prepend
to each key in the ConfigMap. Must be a
@@ -1823,54 +1901,55 @@ spec:
description: The Secret to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret
must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
image:
- description: |-
- Container image name.
- More info: https://kubernetes.io/docs/concepts/containers/images
+ description: 'Container image name. More info: https://kubernetes.io/docs/concepts/containers/images'
type: string
imagePullPolicy:
- description: |-
- Image pull policy.
- One of Always, Never, IfNotPresent.
- Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
+ description: 'Image pull policy. One of Always,
+ Never, IfNotPresent. Defaults to Always if :latest
+ tag is specified, or IfNotPresent otherwise. Cannot
+ be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
description: Lifecycle is not allowed for ephemeral
containers.
properties:
postStart:
- description: |-
- PostStart is called immediately after a container is created. If the handler fails,
- the container is terminated and restarted according to its restart policy.
- Other management of the container blocks until the hook completes.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PostStart is called immediately
+ after a container is created. If the handler
+ fails, the container is terminated and restarted
+ according to its restart policy. Other management
+ of the container blocks until the hook completes.
+ More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to
take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command
+ line to execute inside the container,
+ the working directory for the command is
+ root ('/') in the container's filesystem.
+ The command is simply exec'd, it is
+ not run inside a shell, so traditional
+ shell instructions ('|', etc) won't
+ work. To use a shell, you need to
+ explicitly call out to that shell.
+ Exit status of 0 is treated as live/healthy
+ and non-zero is unhealthy.
items:
type: string
type: array
@@ -1880,9 +1959,10 @@ spec:
request to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to,
+ defaults to the pod IP. You probably
+ want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
description: Custom headers to set in
@@ -1894,9 +1974,11 @@ spec:
probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field
+ name. This will be canonicalized
+ upon output, so case-variant
+ names will be understood as
+ the same header.
type: string
value:
description: The header field
@@ -1915,15 +1997,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -1942,10 +2023,12 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT
+ supported as a LifecycleHandler and kept
+ for the backward compatibility. There
+ are no validation of this field and lifecycle
+ hooks will fail in runtime when tcp handler
+ is specified.
properties:
host:
description: 'Optional: Host name to
@@ -1955,38 +2038,47 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
preStop:
- description: |-
- PreStop is called immediately before a container is terminated due to an
- API request or management event such as liveness/startup probe failure,
- preemption, resource contention, etc. The handler is not called if the
- container crashes or exits. The Pod's termination grace period countdown begins before the
- PreStop hook is executed. Regardless of the outcome of the handler, the
- container will eventually terminate within the Pod's termination grace
- period (unless delayed by finalizers). Other management of the container blocks until the hook completes
- or until the termination grace period is reached.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PreStop is called immediately
+ before a container is terminated due to an
+ API request or management event such as liveness/startup
+ probe failure, preemption, resource contention,
+ etc. The handler is not called if the container
+ crashes or exits. The Pod''s termination grace
+ period countdown begins before the PreStop
+ hook is executed. Regardless of the outcome
+ of the handler, the container will eventually
+ terminate within the Pod''s termination grace
+ period (unless delayed by finalizers). Other
+ management of the container blocks until the
+ hook completes or until the termination grace
+ period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to
take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command
+ line to execute inside the container,
+ the working directory for the command is
+ root ('/') in the container's filesystem.
+ The command is simply exec'd, it is
+ not run inside a shell, so traditional
+ shell instructions ('|', etc) won't
+ work. To use a shell, you need to
+ explicitly call out to that shell.
+ Exit status of 0 is treated as live/healthy
+ and non-zero is unhealthy.
items:
type: string
type: array
@@ -1996,9 +2088,10 @@ spec:
request to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to,
+ defaults to the pod IP. You probably
+ want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
description: Custom headers to set in
@@ -2010,9 +2103,11 @@ spec:
probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field
+ name. This will be canonicalized
+ upon output, so case-variant
+ names will be understood as
+ the same header.
type: string
value:
description: The header field
@@ -2031,15 +2126,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -2058,10 +2152,12 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT
+ supported as a LifecycleHandler and kept
+ for the backward compatibility. There
+ are no validation of this field and lifecycle
+ hooks will fail in runtime when tcp handler
+ is specified.
properties:
host:
description: 'Optional: Host name to
@@ -2071,10 +2167,10 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
@@ -2089,20 +2185,25 @@ spec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -2115,12 +2216,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -2130,8 +2230,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -2142,9 +2242,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -2162,35 +2263,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -2205,40 +2306,46 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
name:
- description: |-
- Name of the ephemeral container specified as a DNS_LABEL.
- This name must be unique among all containers, init containers and ephemeral containers.
+ description: Name of the ephemeral container specified
+ as a DNS_LABEL. This name must be unique among
+ all containers, init containers and ephemeral
+ containers.
type: string
ports:
description: Ports are not allowed for ephemeral
@@ -2248,9 +2355,9 @@ spec:
port in a single container.
properties:
containerPort:
- description: |-
- Number of port to expose on the pod's IP address.
- This must be a valid port number, 0 < x < 65536.
+ description: Number of port to expose on the
+ pod's IP address. This must be a valid port
+ number, 0 < x < 65536.
format: int32
type: integer
hostIP:
@@ -2258,24 +2365,24 @@ spec:
port to.
type: string
hostPort:
- description: |-
- Number of port to expose on the host.
- If specified, this must be a valid port number, 0 < x < 65536.
- If HostNetwork is specified, this must match ContainerPort.
+ description: Number of port to expose on the
+ host. If specified, this must be a valid
+ port number, 0 < x < 65536. If HostNetwork
+ is specified, this must match ContainerPort.
Most containers do not need this.
format: int32
type: integer
name:
- description: |-
- If specified, this must be an IANA_SVC_NAME and unique within the pod. Each
- named port in a pod must have a unique name. Name for the port that can be
- referred to by services.
+ description: If specified, this must be an
+ IANA_SVC_NAME and unique within the pod.
+ Each named port in a pod must have a unique
+ name. Name for the port that can be referred
+ to by services.
type: string
protocol:
default: TCP
- description: |-
- Protocol for port. Must be UDP, TCP, or SCTP.
- Defaults to "TCP".
+ description: Protocol for port. Must be UDP,
+ TCP, or SCTP. Defaults to "TCP".
type: string
required:
- containerPort
@@ -2293,20 +2400,25 @@ spec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -2319,12 +2431,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -2334,8 +2445,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -2346,9 +2457,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -2366,35 +2478,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -2409,33 +2521,38 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
@@ -2446,14 +2563,14 @@ spec:
resource resize policy for the container.
properties:
resourceName:
- description: |-
- Name of the resource to which this resource resize policy applies.
- Supported values: cpu, memory.
+ description: 'Name of the resource to which
+ this resource resize policy applies. Supported
+ values: cpu, memory.'
type: string
restartPolicy:
- description: |-
- Restart policy to apply when specified resource is resized.
- If not specified, it defaults to NotRequired.
+ description: Restart policy to apply when
+ specified resource is resized. If not specified,
+ it defaults to NotRequired.
type: string
required:
- resourceName
@@ -2462,30 +2579,27 @@ spec:
type: array
x-kubernetes-list-type: atomic
resources:
- description: |-
- Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources
+ description: Resources are not allowed for ephemeral
+ containers. Ephemeral containers use spare resources
already allocated to the pod.
properties:
claims:
- description: |-
- Claims lists the names of resources, defined in spec.resourceClaims,
- that are used by this container.
-
-
- This is an alpha field and requires enabling the
- DynamicResourceAllocation feature gate.
-
-
- This field is immutable. It can only be set for containers.
+ description: "Claims lists the names of resources,
+ defined in spec.resourceClaims, that are used
+ by this container. \n This is an alpha field
+ and requires enabling the DynamicResourceAllocation
+ feature gate. \n This field is immutable.
+ It can only be set for containers."
items:
description: ResourceClaim references one
entry in PodSpec.ResourceClaims.
properties:
name:
- description: |-
- Name must match the name of one entry in pod.spec.resourceClaims of
- the Pod where this field is used. It makes that resource available
- inside a container.
+ description: Name must match the name
+ of one entry in pod.spec.resourceClaims
+ of the Pod where this field is used.
+ It makes that resource available inside
+ a container.
type: string
required:
- name
@@ -2501,9 +2615,8 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Limits describes the maximum amount of compute resources allowed.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Limits describes the maximum amount
+ of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -2512,40 +2625,43 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Requests describes the minimum amount of compute resources required.
- If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
- otherwise to an implementation-defined value. Requests cannot exceed Limits.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Requests describes the minimum
+ amount of compute resources required. If Requests
+ is omitted for a container, it defaults to
+ Limits if that is explicitly specified, otherwise
+ to an implementation-defined value. Requests
+ cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
restartPolicy:
- description: |-
- Restart policy for the container to manage the restart behavior of each
- container within a pod.
- This may only be set for init containers. You cannot set this field on
- ephemeral containers.
+ description: Restart policy for the container to
+ manage the restart behavior of each container
+ within a pod. This may only be set for init containers.
+ You cannot set this field on ephemeral containers.
type: string
securityContext:
- description: |-
- Optional: SecurityContext defines the security options the ephemeral container should be run with.
- If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
+ description: 'Optional: SecurityContext defines
+ the security options the ephemeral container should
+ be run with. If set, the fields of SecurityContext
+ override the equivalent fields of PodSecurityContext.'
properties:
allowPrivilegeEscalation:
- description: |-
- AllowPrivilegeEscalation controls whether a process can gain more
- privileges than its parent process. This bool directly controls if
- the no_new_privs flag will be set on the container process.
- AllowPrivilegeEscalation is true always when the container is:
- 1) run as Privileged
- 2) has CAP_SYS_ADMIN
- Note that this field cannot be set when spec.os.name is windows.
+ description: 'AllowPrivilegeEscalation controls
+ whether a process can gain more privileges
+ than its parent process. This bool directly
+ controls if the no_new_privs flag will be
+ set on the container process. AllowPrivilegeEscalation
+ is true always when the container is: 1) run
+ as Privileged 2) has CAP_SYS_ADMIN Note that
+ this field cannot be set when spec.os.name
+ is windows.'
type: boolean
capabilities:
- description: |-
- The capabilities to add/drop when running containers.
- Defaults to the default set of capabilities granted by the container runtime.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The capabilities to add/drop when
+ running containers. Defaults to the default
+ set of capabilities granted by the container
+ runtime. Note that this field cannot be set
+ when spec.os.name is windows.
properties:
add:
description: Added capabilities
@@ -2563,60 +2679,69 @@ spec:
type: array
type: object
privileged:
- description: |-
- Run container in privileged mode.
- Processes in privileged containers are essentially equivalent to root on the host.
- Defaults to false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Run container in privileged mode.
+ Processes in privileged containers are essentially
+ equivalent to root on the host. Defaults to
+ false. Note that this field cannot be set
+ when spec.os.name is windows.
type: boolean
procMount:
- description: |-
- procMount denotes the type of proc mount to use for the containers.
- The default is DefaultProcMount which uses the container runtime defaults for
- readonly paths and masked paths.
- This requires the ProcMountType feature flag to be enabled.
- Note that this field cannot be set when spec.os.name is windows.
+ description: procMount denotes the type of proc
+ mount to use for the containers. The default
+ is DefaultProcMount which uses the container
+ runtime defaults for readonly paths and masked
+ paths. This requires the ProcMountType feature
+ flag to be enabled. Note that this field cannot
+ be set when spec.os.name is windows.
type: string
readOnlyRootFilesystem:
- description: |-
- Whether this container has a read-only root filesystem.
- Default is false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Whether this container has a read-only
+ root filesystem. Default is false. Note that
+ this field cannot be set when spec.os.name
+ is windows.
type: boolean
runAsGroup:
- description: |-
- The GID to run the entrypoint of the container process.
- Uses runtime default if unset.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The GID to run the entrypoint of
+ the container process. Uses runtime default
+ if unset. May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is windows.
format: int64
type: integer
runAsNonRoot:
- description: |-
- Indicates that the container must run as a non-root user.
- If true, the Kubelet will validate the image at runtime to ensure that it
- does not run as UID 0 (root) and fail to start the container if it does.
- If unset or false, no such validation will be performed.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: Indicates that the container must
+ run as a non-root user. If true, the Kubelet
+ will validate the image at runtime to ensure
+ that it does not run as UID 0 (root) and fail
+ to start the container if it does. If unset
+ or false, no such validation will be performed.
+ May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence.
type: boolean
runAsUser:
- description: |-
- The UID to run the entrypoint of the container process.
- Defaults to user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The UID to run the entrypoint of
+ the container process. Defaults to user specified
+ in image metadata if unspecified. May also
+ be set in PodSecurityContext. If set in both
+ SecurityContext and PodSecurityContext, the
+ value specified in SecurityContext takes precedence.
+ Note that this field cannot be set when spec.os.name
+ is windows.
format: int64
type: integer
seLinuxOptions:
- description: |-
- The SELinux context to be applied to the container.
- If unspecified, the container runtime will allocate a random SELinux context for each
- container. May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The SELinux context to be applied
+ to the container. If unspecified, the container
+ runtime will allocate a random SELinux context
+ for each container. May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is windows.
properties:
level:
description: Level is SELinux level label
@@ -2636,62 +2761,74 @@ spec:
type: string
type: object
seccompProfile:
- description: |-
- The seccomp options to use by this container. If seccomp options are
- provided at both the pod & container level, the container options
- override the pod options.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The seccomp options to use by this
+ container. If seccomp options are provided
+ at both the pod & container level, the container
+ options override the pod options. Note that
+ this field cannot be set when spec.os.name
+ is windows.
properties:
localhostProfile:
- description: |-
- localhostProfile indicates a profile defined in a file on the node should be used.
- The profile must be preconfigured on the node to work.
- Must be a descending path, relative to the kubelet's configured seccomp profile location.
- Must be set if type is "Localhost". Must NOT be set for any other type.
+ description: localhostProfile indicates
+ a profile defined in a file on the node
+ should be used. The profile must be preconfigured
+ on the node to work. Must be a descending
+ path, relative to the kubelet's configured
+ seccomp profile location. Must be set
+ if type is "Localhost". Must NOT be set
+ for any other type.
type: string
type:
- description: |-
- type indicates which kind of seccomp profile will be applied.
- Valid options are:
-
-
- Localhost - a profile defined in a file on the node should be used.
- RuntimeDefault - the container runtime default profile should be used.
- Unconfined - no profile should be applied.
+ description: "type indicates which kind
+ of seccomp profile will be applied. Valid
+ options are: \n Localhost - a profile
+ defined in a file on the node should be
+ used. RuntimeDefault - the container runtime
+ default profile should be used. Unconfined
+ - no profile should be applied."
type: string
required:
- type
type: object
windowsOptions:
- description: |-
- The Windows specific settings applied to all containers.
- If unspecified, the options from the PodSecurityContext will be used.
- If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is linux.
+ description: The Windows specific settings applied
+ to all containers. If unspecified, the options
+ from the PodSecurityContext will be used.
+ If set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is linux.
properties:
gmsaCredentialSpec:
- description: |-
- GMSACredentialSpec is where the GMSA admission webhook
- (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
- GMSA credential spec named by the GMSACredentialSpecName field.
+ description: GMSACredentialSpec is where
+ the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa)
+ inlines the contents of the GMSA credential
+ spec named by the GMSACredentialSpecName
+ field.
type: string
gmsaCredentialSpecName:
description: GMSACredentialSpecName is the
name of the GMSA credential spec to use.
type: string
hostProcess:
- description: |-
- HostProcess determines if a container should be run as a 'Host Process' container.
- All of a Pod's containers must have the same effective HostProcess value
- (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
- In addition, if HostProcess is true then HostNetwork must also be set to true.
+ description: HostProcess determines if a
+ container should be run as a 'Host Process'
+ container. All of a Pod's containers must
+ have the same effective HostProcess value
+ (it is not allowed to have a mix of HostProcess
+ containers and non-HostProcess containers).
+ In addition, if HostProcess is true then
+ HostNetwork must also be set to true.
type: boolean
runAsUserName:
- description: |-
- The UserName in Windows to run the entrypoint of the container process.
- Defaults to the user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: The UserName in Windows to
+ run the entrypoint of the container process.
+ Defaults to the user specified in image
+ metadata if unspecified. May also be set
+ in PodSecurityContext. If set in both
+ SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext
+ takes precedence.
type: string
type: object
type: object
@@ -2703,20 +2840,25 @@ spec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -2729,12 +2871,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -2744,8 +2885,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -2756,9 +2897,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -2776,35 +2918,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -2819,86 +2961,98 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
stdin:
- description: |-
- Whether this container should allocate a buffer for stdin in the container runtime. If this
- is not set, reads from stdin in the container will always result in EOF.
- Default is false.
+ description: Whether this container should allocate
+ a buffer for stdin in the container runtime. If
+ this is not set, reads from stdin in the container
+ will always result in EOF. Default is false.
type: boolean
stdinOnce:
- description: |-
- Whether the container runtime should close the stdin channel after it has been opened by
- a single attach. When stdin is true the stdin stream will remain open across multiple attach
- sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
- first client attaches to stdin, and then remains open and accepts data until the client disconnects,
- at which time stdin is closed and remains closed until the container is restarted. If this
- flag is false, a container processes that reads from stdin will never receive an EOF.
- Default is false
+ description: Whether the container runtime should
+ close the stdin channel after it has been opened
+ by a single attach. When stdin is true the stdin
+ stream will remain open across multiple attach
+ sessions. If stdinOnce is set to true, stdin is
+ opened on container start, is empty until the
+ first client attaches to stdin, and then remains
+ open and accepts data until the client disconnects,
+ at which time stdin is closed and remains closed
+ until the container is restarted. If this flag
+ is false, a container processes that reads from
+ stdin will never receive an EOF. Default is false
type: boolean
targetContainerName:
- description: |-
- If set, the name of the container from PodSpec that this ephemeral container targets.
- The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container.
- If not set then the ephemeral container uses the namespaces configured in the Pod spec.
-
-
- The container runtime must implement support for this feature. If the runtime does not
- support namespace targeting then the result of setting this field is undefined.
+ description: "If set, the name of the container
+ from PodSpec that this ephemeral container targets.
+ The ephemeral container will be run in the namespaces
+ (IPC, PID, etc) of this container. If not set
+ then the ephemeral container uses the namespaces
+ configured in the Pod spec. \n The container runtime
+ must implement support for this feature. If the
+ runtime does not support namespace targeting then
+ the result of setting this field is undefined."
type: string
terminationMessagePath:
- description: |-
- Optional: Path at which the file to which the container's termination message
- will be written is mounted into the container's filesystem.
- Message written is intended to be brief final status, such as an assertion failure message.
- Will be truncated by the node if greater than 4096 bytes. The total message length across
- all containers will be limited to 12kb.
- Defaults to /dev/termination-log.
- Cannot be updated.
+ description: 'Optional: Path at which the file to
+ which the container''s termination message will
+ be written is mounted into the container''s filesystem.
+ Message written is intended to be brief final
+ status, such as an assertion failure message.
+ Will be truncated by the node if greater than
+ 4096 bytes. The total message length across all
+ containers will be limited to 12kb. Defaults to
+ /dev/termination-log. Cannot be updated.'
type: string
terminationMessagePolicy:
- description: |-
- Indicate how the termination message should be populated. File will use the contents of
- terminationMessagePath to populate the container status message on both success and failure.
- FallbackToLogsOnError will use the last chunk of container log output if the termination
- message file is empty and the container exited with an error.
- The log output is limited to 2048 bytes or 80 lines, whichever is smaller.
- Defaults to File.
- Cannot be updated.
+ description: Indicate how the termination message
+ should be populated. File will use the contents
+ of terminationMessagePath to populate the container
+ status message on both success and failure. FallbackToLogsOnError
+ will use the last chunk of container log output
+ if the termination message file is empty and the
+ container exited with an error. The log output
+ is limited to 2048 bytes or 80 lines, whichever
+ is smaller. Defaults to File. Cannot be updated.
type: string
tty:
- description: |-
- Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
- Default is false.
+ description: Whether this container should allocate
+ a TTY for itself, also requires 'stdin' to be
+ true. Default is false.
type: boolean
volumeDevices:
description: volumeDevices is the list of block
@@ -2922,45 +3076,47 @@ spec:
type: object
type: array
volumeMounts:
- description: |-
- Pod volumes to mount into the container's filesystem. Subpath mounts are not allowed for ephemeral containers.
- Cannot be updated.
+ description: Pod volumes to mount into the container's
+ filesystem. Subpath mounts are not allowed for
+ ephemeral containers. Cannot be updated.
items:
description: VolumeMount describes a mounting
of a Volume within a container.
properties:
mountPath:
- description: |-
- Path within the container at which the volume should be mounted. Must
+ description: Path within the container at
+ which the volume should be mounted. Must
not contain ':'.
type: string
mountPropagation:
- description: |-
- mountPropagation determines how mounts are propagated from the host
- to container and the other way around.
- When not set, MountPropagationNone is used.
- This field is beta in 1.10.
+ description: mountPropagation determines how
+ mounts are propagated from the host to container
+ and the other way around. When not set,
+ MountPropagationNone is used. This field
+ is beta in 1.10.
type: string
name:
description: This must match the Name of a
Volume.
type: string
readOnly:
- description: |-
- Mounted read-only if true, read-write otherwise (false or unspecified).
- Defaults to false.
+ description: Mounted read-only if true, read-write
+ otherwise (false or unspecified). Defaults
+ to false.
type: boolean
subPath:
- description: |-
- Path within the volume from which the container's volume should be mounted.
+ description: Path within the volume from which
+ the container's volume should be mounted.
Defaults to "" (volume's root).
type: string
subPathExpr:
- description: |-
- Expanded path within the volume from which the container's volume should be mounted.
- Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.
- Defaults to "" (volume's root).
- SubPathExpr and SubPath are mutually exclusive.
+ description: Expanded path within the volume
+ from which the container's volume should
+ be mounted. Behaves similarly to SubPath
+ but environment variable references $(VAR_NAME)
+ are expanded using the container's environment.
+ Defaults to "" (volume's root). SubPathExpr
+ and SubPath are mutually exclusive.
type: string
required:
- mountPath
@@ -2968,11 +3124,10 @@ spec:
type: object
type: array
workingDir:
- description: |-
- Container's working directory.
- If not specified, the container runtime's default will be used, which
- might be configured in the container image.
- Cannot be updated.
+ description: Container's working directory. If not
+ specified, the container runtime's default will
+ be used, which might be configured in the container
+ image. Cannot be updated.
type: string
required:
- name
@@ -2985,35 +3140,39 @@ spec:
want to run within a pod.
properties:
args:
- description: |-
- Arguments to the entrypoint.
- The container image's CMD is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Arguments to the entrypoint. The container
+ image''s CMD is used if this is not provided.
+ Variable references $(VAR_NAME) are expanded using
+ the container''s environment. If a variable cannot
+ be resolved, the reference in the input string
+ will be unchanged. Double $$ are reduced to a
+ single $, which allows for escaping the $(VAR_NAME)
+ syntax: i.e. "$$(VAR_NAME)" will produce the string
+ literal "$(VAR_NAME)". Escaped references will
+ never be expanded, regardless of whether the variable
+ exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
command:
- description: |-
- Entrypoint array. Not executed within a shell.
- The container image's ENTRYPOINT is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Entrypoint array. Not executed within
+ a shell. The container image''s ENTRYPOINT is
+ used if this is not provided. Variable references
+ $(VAR_NAME) are expanded using the container''s
+ environment. If a variable cannot be resolved,
+ the reference in the input string will be unchanged.
+ Double $$ are reduced to a single $, which allows
+ for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)"
+ will produce the string literal "$(VAR_NAME)".
+ Escaped references will never be expanded, regardless
+ of whether the variable exists or not. Cannot
+ be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
env:
- description: |-
- List of environment variables to set in the container.
- Cannot be updated.
+ description: List of environment variables to set
+ in the container. Cannot be updated.
items:
description: EnvVar represents an environment
variable present in a Container.
@@ -3023,16 +3182,18 @@ spec:
Must be a C_IDENTIFIER.
type: string
value:
- description: |-
- Variable references $(VAR_NAME) are expanded
- using the previously defined environment variables in the container and
- any service environment variables. If a variable cannot be resolved,
- the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
- "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
- Escaped references will never be expanded, regardless of whether the variable
- exists or not.
- Defaults to "".
+ description: 'Variable references $(VAR_NAME)
+ are expanded using the previously defined
+ environment variables in the container and
+ any service environment variables. If a
+ variable cannot be resolved, the reference
+ in the input string will be unchanged. Double
+ $$ are reduced to a single $, which allows
+ for escaping the $(VAR_NAME) syntax: i.e.
+ "$$(VAR_NAME)" will produce the string literal
+ "$(VAR_NAME)". Escaped references will never
+ be expanded, regardless of whether the variable
+ exists or not. Defaults to "".'
type: string
valueFrom:
description: Source for the environment variable's
@@ -3045,10 +3206,10 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
+ description: 'Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
@@ -3057,11 +3218,12 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
fieldRef:
- description: |-
- Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`,
- spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ description: 'Selects a field of the pod:
+ supports metadata.name, metadata.namespace,
+ `metadata.labels['''']`, `metadata.annotations['''']`,
+ spec.nodeName, spec.serviceAccountName,
+ status.hostIP, status.podIP, status.podIPs.'
properties:
apiVersion:
description: Version of the schema
@@ -3075,11 +3237,13 @@ spec:
required:
- fieldPath
type: object
- x-kubernetes-map-type: atomic
resourceFieldRef:
- description: |-
- Selects a resource of the container: only resources limits and requests
- (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
+ description: 'Selects a resource of the
+ container: only resources limits and
+ requests (limits.cpu, limits.memory,
+ limits.ephemeral-storage, requests.cpu,
+ requests.memory and requests.ephemeral-storage)
+ are currently supported.'
properties:
containerName:
description: 'Container name: required
@@ -3101,7 +3265,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret
in the pod's namespace
@@ -3112,10 +3275,10 @@ spec:
secret key.
type: string
name:
- description: |-
- Name of the referent.
+ description: 'Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret
@@ -3124,20 +3287,21 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
required:
- name
type: object
type: array
envFrom:
- description: |-
- List of sources to populate environment variables in the container.
- The keys defined within a source must be a C_IDENTIFIER. All invalid keys
- will be reported as an event when the container is starting. When a key exists in multiple
- sources, the value associated with the last source will take precedence.
- Values defined by an Env with a duplicate key will take precedence.
- Cannot be updated.
+ description: List of sources to populate environment
+ variables in the container. The keys defined within
+ a source must be a C_IDENTIFIER. All invalid keys
+ will be reported as an event when the container
+ is starting. When a key exists in multiple sources,
+ the value associated with the last source will
+ take precedence. Values defined by an Env with
+ a duplicate key will take precedence. Cannot be
+ updated.
items:
description: EnvFromSource represents the source
of a set of ConfigMaps
@@ -3146,17 +3310,16 @@ spec:
description: The ConfigMap to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
prefix:
description: An optional identifier to prepend
to each key in the ConfigMap. Must be a
@@ -3166,57 +3329,59 @@ spec:
description: The Secret to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret
must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
image:
- description: |-
- Container image name.
- More info: https://kubernetes.io/docs/concepts/containers/images
- This field is optional to allow higher level config management to default or override
- container images in workload controllers like Deployments and StatefulSets.
+ description: 'Container image name. More info: https://kubernetes.io/docs/concepts/containers/images
+ This field is optional to allow higher level config
+ management to default or override container images
+ in workload controllers like Deployments and StatefulSets.'
type: string
imagePullPolicy:
- description: |-
- Image pull policy.
- One of Always, Never, IfNotPresent.
- Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
+ description: 'Image pull policy. One of Always,
+ Never, IfNotPresent. Defaults to Always if :latest
+ tag is specified, or IfNotPresent otherwise. Cannot
+ be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
- description: |-
- Actions that the management system should take in response to container lifecycle events.
- Cannot be updated.
+ description: Actions that the management system
+ should take in response to container lifecycle
+ events. Cannot be updated.
properties:
postStart:
- description: |-
- PostStart is called immediately after a container is created. If the handler fails,
- the container is terminated and restarted according to its restart policy.
- Other management of the container blocks until the hook completes.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PostStart is called immediately
+ after a container is created. If the handler
+ fails, the container is terminated and restarted
+ according to its restart policy. Other management
+ of the container blocks until the hook completes.
+ More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to
take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command
+ line to execute inside the container,
+ the working directory for the command is
+ root ('/') in the container's filesystem.
+ The command is simply exec'd, it is
+ not run inside a shell, so traditional
+ shell instructions ('|', etc) won't
+ work. To use a shell, you need to
+ explicitly call out to that shell.
+ Exit status of 0 is treated as live/healthy
+ and non-zero is unhealthy.
items:
type: string
type: array
@@ -3226,9 +3391,10 @@ spec:
request to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to,
+ defaults to the pod IP. You probably
+ want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
description: Custom headers to set in
@@ -3240,9 +3406,11 @@ spec:
probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field
+ name. This will be canonicalized
+ upon output, so case-variant
+ names will be understood as
+ the same header.
type: string
value:
description: The header field
@@ -3261,15 +3429,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -3288,10 +3455,12 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT
+ supported as a LifecycleHandler and kept
+ for the backward compatibility. There
+ are no validation of this field and lifecycle
+ hooks will fail in runtime when tcp handler
+ is specified.
properties:
host:
description: 'Optional: Host name to
@@ -3301,38 +3470,47 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
preStop:
- description: |-
- PreStop is called immediately before a container is terminated due to an
- API request or management event such as liveness/startup probe failure,
- preemption, resource contention, etc. The handler is not called if the
- container crashes or exits. The Pod's termination grace period countdown begins before the
- PreStop hook is executed. Regardless of the outcome of the handler, the
- container will eventually terminate within the Pod's termination grace
- period (unless delayed by finalizers). Other management of the container blocks until the hook completes
- or until the termination grace period is reached.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PreStop is called immediately
+ before a container is terminated due to an
+ API request or management event such as liveness/startup
+ probe failure, preemption, resource contention,
+ etc. The handler is not called if the container
+ crashes or exits. The Pod''s termination grace
+ period countdown begins before the PreStop
+ hook is executed. Regardless of the outcome
+ of the handler, the container will eventually
+ terminate within the Pod''s termination grace
+ period (unless delayed by finalizers). Other
+ management of the container blocks until the
+ hook completes or until the termination grace
+ period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to
take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command
+ line to execute inside the container,
+ the working directory for the command is
+ root ('/') in the container's filesystem.
+ The command is simply exec'd, it is
+ not run inside a shell, so traditional
+ shell instructions ('|', etc) won't
+ work. To use a shell, you need to
+ explicitly call out to that shell.
+ Exit status of 0 is treated as live/healthy
+ and non-zero is unhealthy.
items:
type: string
type: array
@@ -3342,9 +3520,10 @@ spec:
request to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to,
+ defaults to the pod IP. You probably
+ want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
description: Custom headers to set in
@@ -3356,9 +3535,11 @@ spec:
probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field
+ name. This will be canonicalized
+ upon output, so case-variant
+ names will be understood as
+ the same header.
type: string
value:
description: The header field
@@ -3377,15 +3558,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -3404,10 +3584,12 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT
+ supported as a LifecycleHandler and kept
+ for the backward compatibility. There
+ are no validation of this field and lifecycle
+ hooks will fail in runtime when tcp handler
+ is specified.
properties:
host:
description: 'Optional: Host name to
@@ -3417,10 +3599,10 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
@@ -3428,30 +3610,33 @@ spec:
type: object
type: object
livenessProbe:
- description: |-
- Periodic probe of container liveness.
+ 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
+ Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -3464,12 +3649,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -3479,8 +3663,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -3491,9 +3675,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -3511,35 +3696,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -3554,59 +3739,63 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
name:
- description: |-
- Name of the container specified as a DNS_LABEL.
- Each container in a pod must have a unique name (DNS_LABEL).
- Cannot be updated.
+ description: Name of the container specified as
+ a DNS_LABEL. Each container in a pod must have
+ a unique name (DNS_LABEL). Cannot be updated.
type: string
ports:
- description: |-
- List of ports to expose from the container. Not specifying a port here
- DOES NOT prevent that port from being exposed. Any port which is
- listening on the default "0.0.0.0" address inside a container will be
- accessible from the network.
- Modifying this array with strategic merge patch may corrupt the data.
- For more information See https://github.com/kubernetes/kubernetes/issues/108255.
+ description: List of ports to expose from the container.
+ Not specifying a port here DOES NOT prevent that
+ port from being exposed. Any port which is listening
+ on the default "0.0.0.0" address inside a container
+ will be accessible from the network. Modifying
+ this array with strategic merge patch may corrupt
+ the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255.
Cannot be updated.
items:
description: ContainerPort represents a network
port in a single container.
properties:
containerPort:
- description: |-
- Number of port to expose on the pod's IP address.
- This must be a valid port number, 0 < x < 65536.
+ description: Number of port to expose on the
+ pod's IP address. This must be a valid port
+ number, 0 < x < 65536.
format: int32
type: integer
hostIP:
@@ -3614,24 +3803,24 @@ spec:
port to.
type: string
hostPort:
- description: |-
- Number of port to expose on the host.
- If specified, this must be a valid port number, 0 < x < 65536.
- If HostNetwork is specified, this must match ContainerPort.
+ description: Number of port to expose on the
+ host. If specified, this must be a valid
+ port number, 0 < x < 65536. If HostNetwork
+ is specified, this must match ContainerPort.
Most containers do not need this.
format: int32
type: integer
name:
- description: |-
- If specified, this must be an IANA_SVC_NAME and unique within the pod. Each
- named port in a pod must have a unique name. Name for the port that can be
- referred to by services.
+ description: If specified, this must be an
+ IANA_SVC_NAME and unique within the pod.
+ Each named port in a pod must have a unique
+ name. Name for the port that can be referred
+ to by services.
type: string
protocol:
default: TCP
- description: |-
- Protocol for port. Must be UDP, TCP, or SCTP.
- Defaults to "TCP".
+ description: Protocol for port. Must be UDP,
+ TCP, or SCTP. Defaults to "TCP".
type: string
required:
- containerPort
@@ -3642,30 +3831,34 @@ spec:
- protocol
x-kubernetes-list-type: map
readinessProbe:
- description: |-
- Periodic probe of container service readiness.
- Container will be removed from service endpoints if the probe fails.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Periodic probe of container service
+ readiness. Container will be removed from service
+ endpoints if the probe fails. Cannot be updated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -3678,12 +3871,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -3693,8 +3885,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -3705,9 +3897,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -3725,35 +3918,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -3768,33 +3961,38 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
@@ -3805,14 +4003,14 @@ spec:
resource resize policy for the container.
properties:
resourceName:
- description: |-
- Name of the resource to which this resource resize policy applies.
- Supported values: cpu, memory.
+ description: 'Name of the resource to which
+ this resource resize policy applies. Supported
+ values: cpu, memory.'
type: string
restartPolicy:
- description: |-
- Restart policy to apply when specified resource is resized.
- If not specified, it defaults to NotRequired.
+ description: Restart policy to apply when
+ specified resource is resized. If not specified,
+ it defaults to NotRequired.
type: string
required:
- resourceName
@@ -3821,31 +4019,26 @@ spec:
type: array
x-kubernetes-list-type: atomic
resources:
- description: |-
- Compute Resources required by this container.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Compute Resources required by this
+ container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
properties:
claims:
- description: |-
- Claims lists the names of resources, defined in spec.resourceClaims,
- that are used by this container.
-
-
- This is an alpha field and requires enabling the
- DynamicResourceAllocation feature gate.
-
-
- This field is immutable. It can only be set for containers.
+ description: "Claims lists the names of resources,
+ defined in spec.resourceClaims, that are used
+ by this container. \n This is an alpha field
+ and requires enabling the DynamicResourceAllocation
+ feature gate. \n This field is immutable.
+ It can only be set for containers."
items:
description: ResourceClaim references one
entry in PodSpec.ResourceClaims.
properties:
name:
- description: |-
- Name must match the name of one entry in pod.spec.resourceClaims of
- the Pod where this field is used. It makes that resource available
- inside a container.
+ description: Name must match the name
+ of one entry in pod.spec.resourceClaims
+ of the Pod where this field is used.
+ It makes that resource available inside
+ a container.
type: string
required:
- name
@@ -3861,9 +4054,8 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Limits describes the maximum amount of compute resources allowed.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Limits describes the maximum amount
+ of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -3872,52 +4064,61 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Requests describes the minimum amount of compute resources required.
- If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
- otherwise to an implementation-defined value. Requests cannot exceed Limits.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Requests describes the minimum
+ amount of compute resources required. If Requests
+ is omitted for a container, it defaults to
+ Limits if that is explicitly specified, otherwise
+ to an implementation-defined value. Requests
+ cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
restartPolicy:
- description: |-
- RestartPolicy defines the restart behavior of individual containers in a pod.
- This field may only be set for init containers, and the only allowed value is "Always".
- For non-init containers or when this field is not specified,
- the restart behavior is defined by the Pod's restart policy and the container type.
- Setting the RestartPolicy as "Always" for the init container will have the following effect:
- this init container will be continually restarted on
- exit until all regular containers have terminated. Once all regular
- containers have completed, all init containers with restartPolicy "Always"
- will be shut down. This lifecycle differs from normal init containers and
- is often referred to as a "sidecar" container. Although this init
- container still starts in the init container sequence, it does not wait
- for the container to complete before proceeding to the next init
- container. Instead, the next init container starts immediately after this
- init container is started, or after any startupProbe has successfully
- completed.
+ description: 'RestartPolicy defines the restart
+ behavior of individual containers in a pod. This
+ field may only be set for init containers, and
+ the only allowed value is "Always". For non-init
+ containers or when this field is not specified,
+ the restart behavior is defined by the Pod''s
+ restart policy and the container type. Setting
+ the RestartPolicy as "Always" for the init container
+ will have the following effect: this init container
+ will be continually restarted on exit until all
+ regular containers have terminated. Once all regular
+ containers have completed, all init containers
+ with restartPolicy "Always" will be shut down.
+ This lifecycle differs from normal init containers
+ and is often referred to as a "sidecar" container.
+ Although this init container still starts in the
+ init container sequence, it does not wait for
+ the container to complete before proceeding to
+ the next init container. Instead, the next init
+ container starts immediately after this init container
+ is started, or after any startupProbe has successfully
+ completed.'
type: string
securityContext:
- description: |-
- SecurityContext defines the security options the container should be run with.
- If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
- More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
+ description: 'SecurityContext defines the security
+ options the container should be run with. If set,
+ the fields of SecurityContext override the equivalent
+ fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
properties:
allowPrivilegeEscalation:
- description: |-
- AllowPrivilegeEscalation controls whether a process can gain more
- privileges than its parent process. This bool directly controls if
- the no_new_privs flag will be set on the container process.
- AllowPrivilegeEscalation is true always when the container is:
- 1) run as Privileged
- 2) has CAP_SYS_ADMIN
- Note that this field cannot be set when spec.os.name is windows.
+ description: 'AllowPrivilegeEscalation controls
+ whether a process can gain more privileges
+ than its parent process. This bool directly
+ controls if the no_new_privs flag will be
+ set on the container process. AllowPrivilegeEscalation
+ is true always when the container is: 1) run
+ as Privileged 2) has CAP_SYS_ADMIN Note that
+ this field cannot be set when spec.os.name
+ is windows.'
type: boolean
capabilities:
- description: |-
- The capabilities to add/drop when running containers.
- Defaults to the default set of capabilities granted by the container runtime.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The capabilities to add/drop when
+ running containers. Defaults to the default
+ set of capabilities granted by the container
+ runtime. Note that this field cannot be set
+ when spec.os.name is windows.
properties:
add:
description: Added capabilities
@@ -3935,60 +4136,69 @@ spec:
type: array
type: object
privileged:
- description: |-
- Run container in privileged mode.
- Processes in privileged containers are essentially equivalent to root on the host.
- Defaults to false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Run container in privileged mode.
+ Processes in privileged containers are essentially
+ equivalent to root on the host. Defaults to
+ false. Note that this field cannot be set
+ when spec.os.name is windows.
type: boolean
procMount:
- description: |-
- procMount denotes the type of proc mount to use for the containers.
- The default is DefaultProcMount which uses the container runtime defaults for
- readonly paths and masked paths.
- This requires the ProcMountType feature flag to be enabled.
- Note that this field cannot be set when spec.os.name is windows.
+ description: procMount denotes the type of proc
+ mount to use for the containers. The default
+ is DefaultProcMount which uses the container
+ runtime defaults for readonly paths and masked
+ paths. This requires the ProcMountType feature
+ flag to be enabled. Note that this field cannot
+ be set when spec.os.name is windows.
type: string
readOnlyRootFilesystem:
- description: |-
- Whether this container has a read-only root filesystem.
- Default is false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Whether this container has a read-only
+ root filesystem. Default is false. Note that
+ this field cannot be set when spec.os.name
+ is windows.
type: boolean
runAsGroup:
- description: |-
- The GID to run the entrypoint of the container process.
- Uses runtime default if unset.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The GID to run the entrypoint of
+ the container process. Uses runtime default
+ if unset. May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is windows.
format: int64
type: integer
runAsNonRoot:
- description: |-
- Indicates that the container must run as a non-root user.
- If true, the Kubelet will validate the image at runtime to ensure that it
- does not run as UID 0 (root) and fail to start the container if it does.
- If unset or false, no such validation will be performed.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: Indicates that the container must
+ run as a non-root user. If true, the Kubelet
+ will validate the image at runtime to ensure
+ that it does not run as UID 0 (root) and fail
+ to start the container if it does. If unset
+ or false, no such validation will be performed.
+ May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence.
type: boolean
runAsUser:
- description: |-
- The UID to run the entrypoint of the container process.
- Defaults to user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The UID to run the entrypoint of
+ the container process. Defaults to user specified
+ in image metadata if unspecified. May also
+ be set in PodSecurityContext. If set in both
+ SecurityContext and PodSecurityContext, the
+ value specified in SecurityContext takes precedence.
+ Note that this field cannot be set when spec.os.name
+ is windows.
format: int64
type: integer
seLinuxOptions:
- description: |-
- The SELinux context to be applied to the container.
- If unspecified, the container runtime will allocate a random SELinux context for each
- container. May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The SELinux context to be applied
+ to the container. If unspecified, the container
+ runtime will allocate a random SELinux context
+ for each container. May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is windows.
properties:
level:
description: Level is SELinux level label
@@ -4008,93 +4218,112 @@ spec:
type: string
type: object
seccompProfile:
- description: |-
- The seccomp options to use by this container. If seccomp options are
- provided at both the pod & container level, the container options
- override the pod options.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The seccomp options to use by this
+ container. If seccomp options are provided
+ at both the pod & container level, the container
+ options override the pod options. Note that
+ this field cannot be set when spec.os.name
+ is windows.
properties:
localhostProfile:
- description: |-
- localhostProfile indicates a profile defined in a file on the node should be used.
- The profile must be preconfigured on the node to work.
- Must be a descending path, relative to the kubelet's configured seccomp profile location.
- Must be set if type is "Localhost". Must NOT be set for any other type.
+ description: localhostProfile indicates
+ a profile defined in a file on the node
+ should be used. The profile must be preconfigured
+ on the node to work. Must be a descending
+ path, relative to the kubelet's configured
+ seccomp profile location. Must be set
+ if type is "Localhost". Must NOT be set
+ for any other type.
type: string
type:
- description: |-
- type indicates which kind of seccomp profile will be applied.
- Valid options are:
-
-
- Localhost - a profile defined in a file on the node should be used.
- RuntimeDefault - the container runtime default profile should be used.
- Unconfined - no profile should be applied.
+ description: "type indicates which kind
+ of seccomp profile will be applied. Valid
+ options are: \n Localhost - a profile
+ defined in a file on the node should be
+ used. RuntimeDefault - the container runtime
+ default profile should be used. Unconfined
+ - no profile should be applied."
type: string
required:
- type
type: object
windowsOptions:
- description: |-
- The Windows specific settings applied to all containers.
- If unspecified, the options from the PodSecurityContext will be used.
- If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is linux.
+ description: The Windows specific settings applied
+ to all containers. If unspecified, the options
+ from the PodSecurityContext will be used.
+ If set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is linux.
properties:
gmsaCredentialSpec:
- description: |-
- GMSACredentialSpec is where the GMSA admission webhook
- (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
- GMSA credential spec named by the GMSACredentialSpecName field.
+ description: GMSACredentialSpec is where
+ the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa)
+ inlines the contents of the GMSA credential
+ spec named by the GMSACredentialSpecName
+ field.
type: string
gmsaCredentialSpecName:
description: GMSACredentialSpecName is the
name of the GMSA credential spec to use.
type: string
hostProcess:
- description: |-
- HostProcess determines if a container should be run as a 'Host Process' container.
- All of a Pod's containers must have the same effective HostProcess value
- (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
- In addition, if HostProcess is true then HostNetwork must also be set to true.
+ description: HostProcess determines if a
+ container should be run as a 'Host Process'
+ container. All of a Pod's containers must
+ have the same effective HostProcess value
+ (it is not allowed to have a mix of HostProcess
+ containers and non-HostProcess containers).
+ In addition, if HostProcess is true then
+ HostNetwork must also be set to true.
type: boolean
runAsUserName:
- description: |-
- The UserName in Windows to run the entrypoint of the container process.
- Defaults to the user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: The UserName in Windows to
+ run the entrypoint of the container process.
+ Defaults to the user specified in image
+ metadata if unspecified. May also be set
+ in PodSecurityContext. If set in both
+ SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext
+ takes precedence.
type: string
type: object
type: object
startupProbe:
- description: |-
- StartupProbe indicates that the Pod has successfully initialized.
- If specified, no other probes are executed until this completes successfully.
- If this probe fails, the Pod will be restarted, just as if the livenessProbe failed.
- This can be used to provide different probe parameters at the beginning of a Pod's lifecycle,
- when it might take a long time to load data or warm a cache, than during steady-state operation.
- This cannot be updated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'StartupProbe indicates that the Pod
+ has successfully initialized. If specified, no
+ other probes are executed until this completes
+ successfully. If this probe fails, the Pod will
+ be restarted, just as if the livenessProbe failed.
+ This can be used to provide different probe parameters
+ at the beginning of a Pod''s lifecycle, when it
+ might take a long time to load data or warm a
+ cache, than during steady-state operation. This
+ cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -4107,12 +4336,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -4122,8 +4350,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -4134,9 +4362,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -4154,35 +4383,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -4197,76 +4426,87 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
stdin:
- description: |-
- Whether this container should allocate a buffer for stdin in the container runtime. If this
- is not set, reads from stdin in the container will always result in EOF.
- Default is false.
+ description: Whether this container should allocate
+ a buffer for stdin in the container runtime. If
+ this is not set, reads from stdin in the container
+ will always result in EOF. Default is false.
type: boolean
stdinOnce:
- description: |-
- Whether the container runtime should close the stdin channel after it has been opened by
- a single attach. When stdin is true the stdin stream will remain open across multiple attach
- sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
- first client attaches to stdin, and then remains open and accepts data until the client disconnects,
- at which time stdin is closed and remains closed until the container is restarted. If this
- flag is false, a container processes that reads from stdin will never receive an EOF.
- Default is false
+ description: Whether the container runtime should
+ close the stdin channel after it has been opened
+ by a single attach. When stdin is true the stdin
+ stream will remain open across multiple attach
+ sessions. If stdinOnce is set to true, stdin is
+ opened on container start, is empty until the
+ first client attaches to stdin, and then remains
+ open and accepts data until the client disconnects,
+ at which time stdin is closed and remains closed
+ until the container is restarted. If this flag
+ is false, a container processes that reads from
+ stdin will never receive an EOF. Default is false
type: boolean
terminationMessagePath:
- description: |-
- Optional: Path at which the file to which the container's termination message
- will be written is mounted into the container's filesystem.
- Message written is intended to be brief final status, such as an assertion failure message.
- Will be truncated by the node if greater than 4096 bytes. The total message length across
- all containers will be limited to 12kb.
- Defaults to /dev/termination-log.
- Cannot be updated.
+ description: 'Optional: Path at which the file to
+ which the container''s termination message will
+ be written is mounted into the container''s filesystem.
+ Message written is intended to be brief final
+ status, such as an assertion failure message.
+ Will be truncated by the node if greater than
+ 4096 bytes. The total message length across all
+ containers will be limited to 12kb. Defaults to
+ /dev/termination-log. Cannot be updated.'
type: string
terminationMessagePolicy:
- description: |-
- Indicate how the termination message should be populated. File will use the contents of
- terminationMessagePath to populate the container status message on both success and failure.
- FallbackToLogsOnError will use the last chunk of container log output if the termination
- message file is empty and the container exited with an error.
- The log output is limited to 2048 bytes or 80 lines, whichever is smaller.
- Defaults to File.
- Cannot be updated.
+ description: Indicate how the termination message
+ should be populated. File will use the contents
+ of terminationMessagePath to populate the container
+ status message on both success and failure. FallbackToLogsOnError
+ will use the last chunk of container log output
+ if the termination message file is empty and the
+ container exited with an error. The log output
+ is limited to 2048 bytes or 80 lines, whichever
+ is smaller. Defaults to File. Cannot be updated.
type: string
tty:
- description: |-
- Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
- Default is false.
+ description: Whether this container should allocate
+ a TTY for itself, also requires 'stdin' to be
+ true. Default is false.
type: boolean
volumeDevices:
description: volumeDevices is the list of block
@@ -4290,45 +4530,46 @@ spec:
type: object
type: array
volumeMounts:
- description: |-
- Pod volumes to mount into the container's filesystem.
- Cannot be updated.
+ description: Pod volumes to mount into the container's
+ filesystem. Cannot be updated.
items:
description: VolumeMount describes a mounting
of a Volume within a container.
properties:
mountPath:
- description: |-
- Path within the container at which the volume should be mounted. Must
+ description: Path within the container at
+ which the volume should be mounted. Must
not contain ':'.
type: string
mountPropagation:
- description: |-
- mountPropagation determines how mounts are propagated from the host
- to container and the other way around.
- When not set, MountPropagationNone is used.
- This field is beta in 1.10.
+ description: mountPropagation determines how
+ mounts are propagated from the host to container
+ and the other way around. When not set,
+ MountPropagationNone is used. This field
+ is beta in 1.10.
type: string
name:
description: This must match the Name of a
Volume.
type: string
readOnly:
- description: |-
- Mounted read-only if true, read-write otherwise (false or unspecified).
- Defaults to false.
+ description: Mounted read-only if true, read-write
+ otherwise (false or unspecified). Defaults
+ to false.
type: boolean
subPath:
- description: |-
- Path within the volume from which the container's volume should be mounted.
+ description: Path within the volume from which
+ the container's volume should be mounted.
Defaults to "" (volume's root).
type: string
subPathExpr:
- description: |-
- Expanded path within the volume from which the container's volume should be mounted.
- Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.
- Defaults to "" (volume's root).
- SubPathExpr and SubPath are mutually exclusive.
+ description: Expanded path within the volume
+ from which the container's volume should
+ be mounted. Behaves similarly to SubPath
+ but environment variable references $(VAR_NAME)
+ are expanded using the container's environment.
+ Defaults to "" (volume's root). SubPathExpr
+ and SubPath are mutually exclusive.
type: string
required:
- mountPath
@@ -4336,11 +4577,10 @@ spec:
type: object
type: array
workingDir:
- description: |-
- Container's working directory.
- If not specified, the container runtime's default will be used, which
- might be configured in the container image.
- Cannot be updated.
+ description: Container's working directory. If not
+ specified, the container runtime's default will
+ be used, which might be configured in the container
+ image. Cannot be updated.
type: string
required:
- name
@@ -4358,68 +4598,69 @@ spec:
description: 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.
- Note that this field cannot be set when spec.os.name is windows.
+ description: "A special supplemental group that applies
+ to all containers in a pod. Some volume types allow
+ the Kubelet to change the ownership of that volume
+ to be owned by the pod: \n 1. The owning GID will
+ be the FSGroup 2. The setgid bit is set (new files
+ created in the volume will be owned by FSGroup)
+ 3. The permission bits are OR'd with rw-rw---- \n
+ If unset, the Kubelet will not modify the ownership
+ and permissions of any volume. Note that this field
+ cannot be set when spec.os.name is windows."
format: int64
type: integer
fsGroupChangePolicy:
- description: |-
- fsGroupChangePolicy defines behavior of changing ownership and permission of the volume
- before being exposed inside Pod. This field will only apply to
- volume types which support fsGroup based ownership(and permissions).
- It will have no effect on ephemeral volume types such as: secret, configmaps
- and emptydir.
- Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used.
- Note that this field cannot be set when spec.os.name is windows.
+ description: 'fsGroupChangePolicy defines behavior
+ of changing ownership and permission of the volume
+ before being exposed inside Pod. This field will
+ only apply to volume types which support fsGroup
+ based ownership(and permissions). It will have no
+ effect on ephemeral volume types such as: secret,
+ configmaps and emptydir. Valid values are "OnRootMismatch"
+ and "Always". If not specified, "Always" is used.
+ Note that this field cannot be set when spec.os.name
+ is windows.'
type: string
runAsGroup:
- description: |-
- The GID to run the entrypoint of the container process.
- Uses runtime default if unset.
- May also be set in SecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence
- for that container.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The GID to run the entrypoint of the
+ container process. Uses runtime default if unset.
+ May also be set in SecurityContext. If set in both
+ SecurityContext and PodSecurityContext, the value
+ specified in SecurityContext takes precedence for
+ that container. Note that this field cannot be set
+ when spec.os.name is windows.
format: int64
type: integer
runAsNonRoot:
- description: |-
- Indicates that the container must run as a non-root user.
- If true, the Kubelet will validate the image at runtime to ensure that it
- does not run as UID 0 (root) and fail to start the container if it does.
- If unset or false, no such validation will be performed.
- May also be set in SecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: Indicates that the container must run
+ as a non-root user. If true, the Kubelet will validate
+ the image at runtime to ensure that it does not
+ run as UID 0 (root) and fail to start the container
+ if it does. If unset or false, no such validation
+ will be performed. May also be set in SecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence.
type: boolean
runAsUser:
- description: |-
- The UID to run the entrypoint of the container process.
- Defaults to user specified in image metadata if unspecified.
- May also be set in SecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence
- for that container.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The UID to run the entrypoint of the
+ container process. Defaults to user specified in
+ image metadata if unspecified. May also be set in
+ SecurityContext. If set in both SecurityContext
+ and PodSecurityContext, the value specified in SecurityContext
+ takes precedence for that container. Note that this
+ field cannot be set when spec.os.name is windows.
format: int64
type: integer
seLinuxOptions:
- description: |-
- The SELinux context to be applied to all containers.
- If unspecified, the container runtime will allocate a random SELinux context for each
- container. May also be set in SecurityContext. If set in
- both SecurityContext and PodSecurityContext, the value specified in SecurityContext
- takes precedence for that container.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The SELinux context to be applied to
+ all containers. If unspecified, the container runtime
+ will allocate a random SELinux context for each
+ container. May also be set in SecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence
+ for that container. Note that this field cannot
+ be set when spec.os.name is windows.
properties:
level:
description: Level is SELinux level label that
@@ -4439,48 +4680,52 @@ spec:
type: string
type: object
seccompProfile:
- description: |-
- The seccomp options to use by the containers in this pod.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The seccomp options to use by the containers
+ in this pod. Note that this field cannot be set
+ when spec.os.name is windows.
properties:
localhostProfile:
- description: |-
- localhostProfile indicates a profile defined in a file on the node should be used.
- The profile must be preconfigured on the node to work.
- Must be a descending path, relative to the kubelet's configured seccomp profile location.
- Must be set if type is "Localhost". Must NOT be set for any other type.
+ description: localhostProfile indicates a profile
+ defined in a file on the node should be used.
+ The profile must be preconfigured on the node
+ to work. Must be a descending path, relative
+ to the kubelet's configured seccomp profile
+ location. Must be set if type is "Localhost".
+ Must NOT be set for any other type.
type: string
type:
- description: |-
- type indicates which kind of seccomp profile will be applied.
- Valid options are:
-
-
- Localhost - a profile defined in a file on the node should be used.
- RuntimeDefault - the container runtime default profile should be used.
- Unconfined - no profile should be applied.
+ description: "type indicates which kind of seccomp
+ profile will be applied. Valid options are:
+ \n Localhost - a profile defined in a file on
+ the node should be used. RuntimeDefault - the
+ container runtime default profile should be
+ used. Unconfined - no profile should be applied."
type: string
required:
- type
type: object
supplementalGroups:
- description: |-
- A list of groups applied to the first process run in each container, in addition
- to the container's primary GID, the fsGroup (if specified), and group memberships
- defined in the container image for the uid of the container process. If unspecified,
- no additional groups are added to any container. Note that group memberships
- defined in the container image for the uid of the container process are still effective,
- even if they are not included in this list.
- Note that this field cannot be set when spec.os.name is windows.
+ description: A list of groups applied to the first
+ process run in each container, in addition to the
+ container's primary GID, the fsGroup (if specified),
+ and group memberships defined in the container image
+ for the uid of the container process. If unspecified,
+ no additional groups are added to any container.
+ Note that group memberships defined in the container
+ image for the uid of the container process are still
+ effective, even if they are not included in this
+ list. Note that this field cannot be set when spec.os.name
+ is windows.
items:
format: int64
type: integer
type: array
sysctls:
- description: |-
- Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported
- sysctls (by the container runtime) might fail to launch.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Sysctls hold a list of namespaced sysctls
+ used for the pod. Pods with unsupported sysctls
+ (by the container runtime) might fail to launch.
+ Note that this field cannot be set when spec.os.name
+ is windows.
items:
description: Sysctl defines a kernel parameter to
be set
@@ -4497,35 +4742,42 @@ spec:
type: object
type: array
windowsOptions:
- description: |-
- The Windows specific settings applied to all containers.
- If unspecified, the options within a container's SecurityContext will be used.
- If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is linux.
+ description: The Windows specific settings applied
+ to all containers. If unspecified, the options within
+ a container's SecurityContext will be used. If set
+ in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence.
+ Note that this field cannot be set when spec.os.name
+ is linux.
properties:
gmsaCredentialSpec:
- description: |-
- GMSACredentialSpec is where the GMSA admission webhook
- (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
- GMSA credential spec named by the GMSACredentialSpecName field.
+ description: GMSACredentialSpec is where the GMSA
+ admission webhook (https://github.com/kubernetes-sigs/windows-gmsa)
+ inlines the contents of the GMSA credential
+ spec named by the GMSACredentialSpecName field.
type: string
gmsaCredentialSpecName:
description: GMSACredentialSpecName is the name
of the GMSA credential spec to use.
type: string
hostProcess:
- description: |-
- HostProcess determines if a container should be run as a 'Host Process' container.
- All of a Pod's containers must have the same effective HostProcess value
- (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
- In addition, if HostProcess is true then HostNetwork must also be set to true.
+ description: HostProcess determines if a container
+ should be run as a 'Host Process' container.
+ All of a Pod's containers must have the same
+ effective HostProcess value (it is not allowed
+ to have a mix of HostProcess containers and
+ non-HostProcess containers). In addition, if
+ HostProcess is true then HostNetwork must also
+ be set to true.
type: boolean
runAsUserName:
- description: |-
- The UserName in Windows to run the entrypoint of the container process.
- Defaults to the user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: The UserName in Windows to run the
+ entrypoint of the container process. Defaults
+ to the user specified in image metadata if unspecified.
+ May also be set in PodSecurityContext. If set
+ in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence.
type: string
type: object
type: object
@@ -4540,34 +4792,38 @@ spec:
to spread matching pods among the given topology.
properties:
labelSelector:
- description: |-
- LabelSelector is used to find matching pods.
- Pods that match this label selector are counted to determine the number of pods
- in their corresponding topology domain.
+ description: LabelSelector is used to find matching
+ pods. Pods that match this label selector are
+ counted to determine the number of pods in their
+ corresponding topology domain.
properties:
matchExpressions:
description: matchExpressions is a list of label
selector requirements. The requirements are
ANDed.
items:
- description: |-
- A label selector requirement is a selector that contains values, a key, and an operator that
- relates the key and values.
+ description: A label selector requirement
+ is a selector that contains values, a key,
+ and an operator that relates the key and
+ values.
properties:
key:
description: key is the label key that
the selector applies to.
type: string
operator:
- description: |-
- operator represents a key's relationship to a set of values.
- Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents a key's
+ relationship to a set of values. Valid
+ operators are In, NotIn, Exists and
+ DoesNotExist.
type: string
values:
- description: |-
- values is an array of string values. If the operator is In or NotIn,
- the values array must be non-empty. If the operator is Exists or DoesNotExist,
- the values array must be empty. This array is replaced during a strategic
+ description: values is an array of string
+ values. If the operator is In or NotIn,
+ the values array must be non-empty.
+ If the operator is Exists or DoesNotExist,
+ the values array must be empty. This
+ array is replaced during a strategic
merge patch.
items:
type: string
@@ -4580,134 +4836,146 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: |-
- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions, whose key field is "key", the
- operator is "In", and the values array contains only "value". The requirements are ANDed.
+ description: matchLabels is a map of {key,value}
+ pairs. A single {key,value} in the matchLabels
+ map is equivalent to an element of matchExpressions,
+ whose key field is "key", the operator is
+ "In", and the values array contains only "value".
+ The requirements are ANDed.
type: object
type: object
- x-kubernetes-map-type: atomic
matchLabelKeys:
- description: |-
- MatchLabelKeys is a set of pod label keys to select the pods over which
- spreading will be calculated. The keys are used to lookup values from the
- incoming pod labels, those key-value labels are ANDed with labelSelector
- to select the group of existing pods over which spreading will be calculated
- for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.
- MatchLabelKeys cannot be set when LabelSelector isn't set.
- Keys that don't exist in the incoming pod labels will
- be ignored. A null or empty list means only match against labelSelector.
-
-
- This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).
+ description: "MatchLabelKeys is a set of pod label
+ keys to select the pods over which spreading will
+ be calculated. The keys are used to lookup values
+ from the incoming pod labels, those key-value
+ labels are ANDed with labelSelector to select
+ the group of existing pods over which spreading
+ will be calculated for the incoming pod. The same
+ key is forbidden to exist in both MatchLabelKeys
+ and LabelSelector. MatchLabelKeys cannot be set
+ when LabelSelector isn't set. Keys that don't
+ exist in the incoming pod labels will be ignored.
+ A null or empty list means only match against
+ labelSelector. \n This is a beta field and requires
+ the MatchLabelKeysInPodTopologySpread feature
+ gate to be enabled (enabled by default)."
items:
type: string
type: array
x-kubernetes-list-type: atomic
maxSkew:
- description: |-
- MaxSkew describes the degree to which pods may be unevenly distributed.
- When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference
- between the number of matching pods in the target topology and the global minimum.
- The global minimum is the minimum number of matching pods in an eligible domain
- or zero if the number of eligible domains is less than MinDomains.
- For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same
- labelSelector spread as 2/2/1:
- In this case, the global minimum is 1.
- | zone1 | zone2 | zone3 |
- | P P | P P | P |
- - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2;
- scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2)
- violate MaxSkew(1).
- - if MaxSkew is 2, incoming pod can be scheduled onto any zone.
- When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence
- to topologies that satisfy it.
- It's a required field. Default value is 1 and 0 is not allowed.
+ description: 'MaxSkew describes the degree to which
+ pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`,
+ it is the maximum permitted difference between
+ the number of matching pods in the target topology
+ and the global minimum. The global minimum is
+ the minimum number of matching pods in an eligible
+ domain or zero if the number of eligible domains
+ is less than MinDomains. For example, in a 3-zone
+ cluster, MaxSkew is set to 1, and pods with the
+ same labelSelector spread as 2/2/1: In this case,
+ the global minimum is 1. | zone1 | zone2 | zone3
+ | | P P | P P | P | - if MaxSkew is 1,
+ incoming pod can only be scheduled to zone3 to
+ become 2/2/2; scheduling it onto zone1(zone2)
+ would make the ActualSkew(3-1) on zone1(zone2)
+ violate MaxSkew(1). - if MaxSkew is 2, incoming
+ pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`,
+ it is used to give higher precedence to topologies
+ that satisfy it. It''s a required field. Default
+ value is 1 and 0 is not allowed.'
format: int32
type: integer
minDomains:
- description: |-
- MinDomains indicates a minimum number of eligible domains.
- When the number of eligible domains with matching topology keys is less than minDomains,
- Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed.
- And when the number of eligible domains with matching topology keys equals or greater than minDomains,
- this value has no effect on scheduling.
- As a result, when the number of eligible domains is less than minDomains,
- scheduler won't schedule more than maxSkew Pods to those domains.
- If value is nil, the constraint behaves as if MinDomains is equal to 1.
- Valid values are integers greater than 0.
- When value is not nil, WhenUnsatisfiable must be DoNotSchedule.
-
-
- For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same
- labelSelector spread as 2/2/2:
- | zone1 | zone2 | zone3 |
- | P P | P P | P P |
- The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0.
- In this situation, new pod with the same labelSelector cannot be scheduled,
- because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones,
- it will violate MaxSkew.
-
-
- This is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default).
+ description: "MinDomains indicates a minimum number
+ of eligible domains. When the number of eligible
+ domains with matching topology keys is less than
+ minDomains, Pod Topology Spread treats \"global
+ minimum\" as 0, and then the calculation of Skew
+ is performed. And when the number of eligible
+ domains with matching topology keys equals or
+ greater than minDomains, this value has no effect
+ on scheduling. As a result, when the number of
+ eligible domains is less than minDomains, scheduler
+ won't schedule more than maxSkew Pods to those
+ domains. If value is nil, the constraint behaves
+ as if MinDomains is equal to 1. Valid values are
+ integers greater than 0. When value is not nil,
+ WhenUnsatisfiable must be DoNotSchedule. \n For
+ example, in a 3-zone cluster, MaxSkew is set to
+ 2, MinDomains is set to 5 and pods with the same
+ labelSelector spread as 2/2/2: | zone1 | zone2
+ | zone3 | | P P | P P | P P | The number
+ of domains is less than 5(MinDomains), so \"global
+ minimum\" is treated as 0. In this situation,
+ new pod with the same labelSelector cannot be
+ scheduled, because computed skew will be 3(3 -
+ 0) if new Pod is scheduled to any of the three
+ zones, it will violate MaxSkew. \n This is a beta
+ field and requires the MinDomainsInPodTopologySpread
+ feature gate to be enabled (enabled by default)."
format: int32
type: integer
nodeAffinityPolicy:
- description: |-
- NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector
- when calculating pod topology spread skew. Options are:
- - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations.
- - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.
-
-
- If this value is nil, the behavior is equivalent to the Honor policy.
- This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
+ description: "NodeAffinityPolicy indicates how we
+ will treat Pod's nodeAffinity/nodeSelector when
+ calculating pod topology spread skew. Options
+ are: - Honor: only nodes matching nodeAffinity/nodeSelector
+ are included in the calculations. - Ignore: nodeAffinity/nodeSelector
+ are ignored. All nodes are included in the calculations.
+ \n If this value is nil, the behavior is equivalent
+ to the Honor policy. This is a beta-level feature
+ default enabled by the NodeInclusionPolicyInPodTopologySpread
+ feature flag."
type: string
nodeTaintsPolicy:
- description: |-
- NodeTaintsPolicy indicates how we will treat node taints when calculating
- pod topology spread skew. Options are:
- - Honor: nodes without taints, along with tainted nodes for which the incoming pod
- has a toleration, are included.
- - Ignore: node taints are ignored. All nodes are included.
-
-
- If this value is nil, the behavior is equivalent to the Ignore policy.
- This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
+ description: "NodeTaintsPolicy indicates how we
+ will treat node taints when calculating pod topology
+ spread skew. Options are: - Honor: nodes without
+ taints, along with tainted nodes for which the
+ incoming pod has a toleration, are included. -
+ Ignore: node taints are ignored. All nodes are
+ included. \n If this value is nil, the behavior
+ is equivalent to the Ignore policy. This is a
+ beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread
+ feature flag."
type: string
topologyKey:
- description: |-
- TopologyKey is the key of node labels. Nodes that have a label with this key
- and identical values are considered to be in the same topology.
- We consider each as a "bucket", and try to put balanced number
- of pods into each bucket.
- We define a domain as a particular instance of a topology.
- Also, we define an eligible domain as a domain whose nodes meet the requirements of
- nodeAffinityPolicy and nodeTaintsPolicy.
- e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology.
- And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology.
- It's a required field.
+ description: TopologyKey is the key of node labels.
+ Nodes that have a label with this key and identical
+ values are considered to be in the same topology.
+ We consider each as a "bucket", and
+ try to put balanced number of pods into each bucket.
+ We define a domain as a particular instance of
+ a topology. Also, we define an eligible domain
+ as a domain whose nodes meet the requirements
+ of nodeAffinityPolicy and nodeTaintsPolicy. e.g.
+ If TopologyKey is "kubernetes.io/hostname", each
+ Node is a domain of that topology. And, if TopologyKey
+ is "topology.kubernetes.io/zone", each zone is
+ a domain of that topology. It's a required field.
type: string
whenUnsatisfiable:
- description: |-
- WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy
- the spread constraint.
- - DoNotSchedule (default) tells the scheduler not to schedule it.
- - ScheduleAnyway tells the scheduler to schedule the pod in any location,
- but giving higher precedence to topologies that would help reduce the
- skew.
- A constraint is considered "Unsatisfiable" for an incoming pod
- if and only if every possible node assignment for that pod would violate
- "MaxSkew" on some topology.
- For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same
- labelSelector spread as 3/1/1:
- | zone1 | zone2 | zone3 |
- | P P P | P | P |
- If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled
- to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies
- MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler
- won't make it *more* imbalanced.
- It's a required field.
+ description: 'WhenUnsatisfiable indicates how to
+ deal with a pod if it doesn''t satisfy the spread
+ constraint. - DoNotSchedule (default) tells the
+ scheduler not to schedule it. - ScheduleAnyway
+ tells the scheduler to schedule the pod in any
+ location, but giving higher precedence to topologies
+ that would help reduce the skew. A constraint
+ is considered "Unsatisfiable" for an incoming
+ pod if and only if every possible node assignment
+ for that pod would violate "MaxSkew" on some topology.
+ For example, in a 3-zone cluster, MaxSkew is set
+ to 1, and pods with the same labelSelector spread
+ as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P |
+ If WhenUnsatisfiable is set to DoNotSchedule,
+ incoming pod can only be scheduled to zone2(zone3)
+ to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3)
+ satisfies MaxSkew(1). In other words, the cluster
+ can still be imbalanced, but scheduler won''t
+ make it *more* imbalanced. It''s a required field.'
type: string
required:
- maxSkew
@@ -4722,36 +4990,40 @@ spec:
that may be accessed by any container in the pod.
properties:
awsElasticBlockStore:
- description: |-
- awsElasticBlockStore represents an AWS Disk resource that is attached to a
- kubelet's host machine and then exposed to the pod.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ description: 'awsElasticBlockStore represents an
+ AWS Disk resource that is attached to a kubelet''s
+ host machine and then exposed to the pod. More
+ info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
properties:
fsType:
- description: |-
- fsType is the filesystem type of the volume that you want to mount.
- Tip: Ensure that the filesystem type is supported by the host operating system.
- Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
- TODO: how do we prevent errors in the filesystem from compromising the machine
+ description: 'fsType is the filesystem type
+ of the volume that you want to mount. Tip:
+ Ensure that the filesystem type is supported
+ by the host operating system. Examples: "ext4",
+ "xfs", "ntfs". Implicitly inferred to be "ext4"
+ if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
partition:
- description: |-
- partition is the partition in the volume that you want to mount.
- If omitted, the default is to mount by volume name.
- Examples: For volume /dev/sda1, you specify the partition as "1".
- Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
+ description: 'partition is the partition in
+ the volume that you want to mount. If omitted,
+ the default is to mount by volume name. Examples:
+ For volume /dev/sda1, you specify the partition
+ as "1". Similarly, the volume partition for
+ /dev/sda is "0" (or you can leave the property
+ empty).'
format: int32
type: integer
readOnly:
- description: |-
- readOnly value true will force the readOnly setting in VolumeMounts.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ description: 'readOnly value true will force
+ the readOnly setting in VolumeMounts. More
+ info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
type: boolean
volumeID:
- description: |-
- volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume).
- More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ description: 'volumeID is unique ID of the persistent
+ disk resource in AWS (Amazon EBS volume).
+ More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
type: string
required:
- volumeID
@@ -4773,10 +5045,11 @@ spec:
in the blob storage
type: string
fsType:
- description: |-
- fsType is Filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: fsType is Filesystem type to mount.
+ Must be a filesystem type supported by the
+ host operating system. Ex. "ext4", "xfs",
+ "ntfs". Implicitly inferred to be "ext4" if
+ unspecified.
type: string
kind:
description: 'kind expected values are Shared:
@@ -4786,9 +5059,9 @@ spec:
set). defaults to shared'
type: string
readOnly:
- description: |-
- readOnly Defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: readOnly Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
required:
- diskName
@@ -4800,9 +5073,9 @@ spec:
pod.
properties:
readOnly:
- description: |-
- readOnly defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: readOnly defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
secretName:
description: secretName is the name of secret
@@ -4821,9 +5094,9 @@ spec:
the host that shares a pod's lifetime
properties:
monitors:
- description: |-
- monitors is Required: Monitors is a collection of Ceph monitors
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ description: 'monitors is Required: Monitors
+ is a collection of Ceph monitors More info:
+ https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
items:
type: string
type: array
@@ -4833,72 +5106,68 @@ spec:
default is /'
type: string
readOnly:
- description: |-
- readOnly is Optional: Defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ description: 'readOnly is Optional: Defaults
+ to false (read/write). ReadOnly here will
+ force the ReadOnly setting in VolumeMounts.
+ More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
type: boolean
secretFile:
- description: |-
- secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ description: 'secretFile is Optional: SecretFile
+ is the path to key ring for User, default
+ is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
type: string
secretRef:
- description: |-
- secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty.
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ description: 'secretRef is Optional: SecretRef
+ is reference to the authentication secret
+ for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
user:
- description: |-
- user is optional: User is the rados user name, default is admin
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ description: 'user is optional: User is the
+ rados user name, default is admin More info:
+ https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
type: string
required:
- monitors
type: object
cinder:
- description: |-
- cinder represents a cinder volume attached and mounted on kubelets host machine.
- More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ description: 'cinder represents a cinder volume
+ attached and mounted on kubelets host machine.
+ More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
properties:
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ description: 'fsType is the filesystem type
+ to mount. Must be a filesystem type supported
+ by the host operating system. Examples: "ext4",
+ "xfs", "ntfs". Implicitly inferred to be "ext4"
+ if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
type: string
readOnly:
- description: |-
- readOnly defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
- More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ description: 'readOnly defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
type: boolean
secretRef:
- description: |-
- secretRef is optional: points to a secret object containing parameters used to connect
- to OpenStack.
+ description: 'secretRef is optional: points
+ to a secret object containing parameters used
+ to connect to OpenStack.'
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
volumeID:
- description: |-
- volumeID used to identify the volume in cinder.
- More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ description: 'volumeID used to identify the
+ volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
type: string
required:
- volumeID
@@ -4908,25 +5177,31 @@ spec:
should populate this volume
properties:
defaultMode:
- description: |-
- defaultMode is optional: mode bits used to set permissions on created files by default.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- Defaults to 0644.
- Directories within the path are not affected by this setting.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'defaultMode is optional: mode
+ bits used to set permissions on created files
+ by default. Must be an octal value between
+ 0000 and 0777 or a decimal value between 0
+ and 511. YAML accepts both octal and decimal
+ values, JSON requires decimal values for mode
+ bits. Defaults to 0644. Directories within
+ the path are not affected by this setting.
+ This might be in conflict with other options
+ that affect the file mode, like fsGroup, and
+ the result can be other mode bits set.'
format: int32
type: integer
items:
- description: |-
- items if unspecified, each key-value pair in the Data field of the referenced
- ConfigMap will be projected into the volume as a file whose name is the
- key and content is the value. If specified, the listed keys will be
- projected into the specified paths, and unlisted keys will not be
- present. If a key is specified which is not present in the ConfigMap,
- the volume setup will error unless it is marked optional. Paths must be
- relative and may not contain the '..' path or start with '..'.
+ description: items if unspecified, each key-value
+ pair in the Data field of the referenced ConfigMap
+ will be projected into the volume as a file
+ whose name is the key and content is the value.
+ If specified, the listed keys will be projected
+ into the specified paths, and unlisted keys
+ will not be present. If a key is specified
+ which is not present in the ConfigMap, the
+ volume setup will error unless it is marked
+ optional. Paths must be relative and may not
+ contain the '..' path or start with '..'.
items:
description: Maps a string key to a path within
a volume.
@@ -4935,21 +5210,26 @@ spec:
description: key is the key to project.
type: string
mode:
- description: |-
- mode is Optional: mode bits used to set permissions on this file.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'mode is Optional: mode bits
+ used to set permissions on this file.
+ Must be an octal value between 0000
+ and 0777 or a decimal value between
+ 0 and 511. YAML accepts both octal and
+ decimal values, JSON requires decimal
+ values for mode bits. If not specified,
+ the volume defaultMode will be used.
+ This might be in conflict with other
+ options that affect the file mode, like
+ fsGroup, and the result can be other
+ mode bits set.'
format: int32
type: integer
path:
- description: |-
- path is the relative path of the file to map the key to.
- May not be an absolute path.
- May not contain the path element '..'.
- May not start with the string '..'.
+ description: path is the relative path
+ of the file to map the key to. May not
+ be an absolute path. May not contain
+ the path element '..'. May not start
+ with the string '..'.
type: string
required:
- key
@@ -4957,60 +5237,62 @@ spec:
type: object
type: array
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: optional specify whether the ConfigMap
or its keys must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
csi:
description: csi (Container Storage Interface) represents
ephemeral storage that is handled by certain external
CSI drivers (Beta feature).
properties:
driver:
- description: |-
- driver is the name of the CSI driver that handles this volume.
- Consult with your admin for the correct name as registered in the cluster.
+ description: driver is the name of the CSI driver
+ that handles this volume. Consult with your
+ admin for the correct name as registered in
+ the cluster.
type: string
fsType:
- description: |-
- fsType to mount. Ex. "ext4", "xfs", "ntfs".
- If not provided, the empty value is passed to the associated CSI driver
- which will determine the default filesystem to apply.
+ description: fsType to mount. Ex. "ext4", "xfs",
+ "ntfs". If not provided, the empty value is
+ passed to the associated CSI driver which
+ will determine the default filesystem to apply.
type: string
nodePublishSecretRef:
- description: |-
- nodePublishSecretRef is a reference to the secret object containing
- sensitive information to pass to the CSI driver to complete the CSI
- NodePublishVolume and NodeUnpublishVolume calls.
- This field is optional, and may be empty if no secret is required. If the
- secret object contains more than one secret, all secret references are passed.
+ description: nodePublishSecretRef is a reference
+ to the secret object containing sensitive
+ information to pass to the CSI driver to complete
+ the CSI NodePublishVolume and NodeUnpublishVolume
+ calls. This field is optional, and may be
+ empty if no secret is required. If the secret
+ object contains more than one secret, all
+ secret references are passed.
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
readOnly:
- description: |-
- readOnly specifies a read-only configuration for the volume.
- Defaults to false (read/write).
+ description: readOnly specifies a read-only
+ configuration for the volume. Defaults to
+ false (read/write).
type: boolean
volumeAttributes:
additionalProperties:
type: string
- description: |-
- volumeAttributes stores driver-specific properties that are passed to the CSI
- driver. Consult your driver's documentation for supported values.
+ description: volumeAttributes stores driver-specific
+ properties that are passed to the CSI driver.
+ Consult your driver's documentation for supported
+ values.
type: object
required:
- driver
@@ -5020,15 +5302,18 @@ spec:
about the pod that should populate this volume
properties:
defaultMode:
- description: |-
- Optional: mode bits to use on created files by default. Must be a
- Optional: mode bits used to set permissions on created files by default.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- Defaults to 0644.
- Directories within the path are not affected by this setting.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'Optional: mode bits to use on
+ created files by default. Must be a Optional:
+ mode bits used to set permissions on created
+ files by default. Must be an octal value between
+ 0000 and 0777 or a decimal value between 0
+ and 511. YAML accepts both octal and decimal
+ values, JSON requires decimal values for mode
+ bits. Defaults to 0644. Directories within
+ the path are not affected by this setting.
+ This might be in conflict with other options
+ that affect the file mode, like fsGroup, and
+ the result can be other mode bits set.'
format: int32
type: integer
items:
@@ -5056,15 +5341,19 @@ spec:
required:
- fieldPath
type: object
- x-kubernetes-map-type: atomic
mode:
- description: |-
- Optional: mode bits used to set permissions on this file, must be an octal value
- between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'Optional: mode bits used
+ to set permissions on this file, must
+ be an octal value between 0000 and 0777
+ or a decimal value between 0 and 511.
+ YAML accepts both octal and decimal
+ values, JSON requires decimal values
+ for mode bits. If not specified, the
+ volume defaultMode will be used. This
+ might be in conflict with other options
+ that affect the file mode, like fsGroup,
+ and the result can be other mode bits
+ set.'
format: int32
type: integer
path:
@@ -5076,9 +5365,11 @@ spec:
must not start with ''..'''
type: string
resourceFieldRef:
- description: |-
- Selects a resource of the container: only resources limits and requests
- (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
+ description: 'Selects a resource of the
+ container: only resources limits and
+ requests (limits.cpu, limits.memory,
+ requests.cpu and requests.memory) are
+ currently supported.'
properties:
containerName:
description: 'Container name: required
@@ -5100,132 +5391,134 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
required:
- path
type: object
type: array
type: object
emptyDir:
- description: |-
- emptyDir represents a temporary directory that shares a pod's lifetime.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
+ description: 'emptyDir represents a temporary directory
+ that shares a pod''s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
properties:
medium:
- description: |-
- medium represents what type of storage medium should back this directory.
- The default is "" which means to use the node's default medium.
- Must be an empty string (default) or Memory.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
+ description: 'medium represents what type of
+ storage medium should back this directory.
+ The default is "" which means to use the node''s
+ default medium. Must be an empty string (default)
+ or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
type: string
sizeLimit:
anyOf:
- type: integer
- type: string
- description: |-
- sizeLimit is the total amount of local storage required for this EmptyDir volume.
- The size limit is also applicable for memory medium.
- The maximum usage on memory medium EmptyDir would be the minimum value between
- the SizeLimit specified here and the sum of memory limits of all containers in a pod.
- The default is nil which means that the limit is undefined.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
+ description: 'sizeLimit is the total amount
+ of local storage required for this EmptyDir
+ volume. The size limit is also applicable
+ for memory medium. The maximum usage on memory
+ medium EmptyDir would be the minimum value
+ between the SizeLimit specified here and the
+ sum of memory limits of all containers in
+ a pod. The default is nil which means that
+ the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
type: object
ephemeral:
- description: |-
- ephemeral represents a volume that is handled by a cluster storage driver.
- The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts,
- and deleted when the pod is removed.
-
-
- Use this if:
+ description: "ephemeral represents a volume that
+ is handled by a cluster storage driver. The volume's
+ lifecycle is tied to the pod that defines it -
+ it will be created before the pod starts, and
+ deleted when the pod is removed. \n Use this if:
a) the volume is only needed while the pod runs,
- b) features of normal volumes like restoring from snapshot or capacity
- tracking are needed,
- c) the storage driver is specified through a storage class, and
- d) the storage driver supports dynamic volume provisioning through
- a PersistentVolumeClaim (see EphemeralVolumeSource for more
- information on the connection between this volume type
- and PersistentVolumeClaim).
-
-
- Use PersistentVolumeClaim or one of the vendor-specific
- APIs for volumes that persist for longer than the lifecycle
- of an individual pod.
-
-
- Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to
- be used that way - see the documentation of the driver for
- more information.
-
-
- A pod can use both types of ephemeral volumes and
- persistent volumes at the same time.
+ b) features of normal volumes like restoring from
+ snapshot or capacity tracking are needed, c)
+ the storage driver is specified through a storage
+ class, and d) the storage driver supports dynamic
+ volume provisioning through a PersistentVolumeClaim
+ (see EphemeralVolumeSource for more information
+ on the connection between this volume type and
+ PersistentVolumeClaim). \n Use PersistentVolumeClaim
+ or one of the vendor-specific APIs for volumes
+ that persist for longer than the lifecycle of
+ an individual pod. \n Use CSI for light-weight
+ local ephemeral volumes if the CSI driver is meant
+ to be used that way - see the documentation of
+ the driver for more information. \n A pod can
+ use both types of ephemeral volumes and persistent
+ volumes at the same time."
properties:
volumeClaimTemplate:
- description: |-
- Will be used to create a stand-alone PVC to provision the volume.
- The pod in which this EphemeralVolumeSource is embedded will be the
- owner of the PVC, i.e. the PVC will be deleted together with the
- pod. The name of the PVC will be `-` where
- `` is the name from the `PodSpec.Volumes` array
- entry. Pod validation will reject the pod if the concatenated name
+ description: "Will be used to create a stand-alone
+ PVC to provision the volume. The pod in which
+ this EphemeralVolumeSource is embedded will
+ be the owner of the PVC, i.e. the PVC will
+ be deleted together with the pod. The name
+ of the PVC will be `-`
+ where `` is the name from the
+ `PodSpec.Volumes` array entry. Pod validation
+ will reject the pod if the concatenated name
is not valid for a PVC (for example, too long).
-
-
- An existing PVC with that name that is not owned by the pod
- will *not* be used for the pod to avoid using an unrelated
- volume by mistake. Starting the pod is then blocked until
- the unrelated PVC is removed. If such a pre-created PVC is
- meant to be used by the pod, the PVC has to updated with an
- owner reference to the pod once the pod exists. Normally
- this should not be necessary, but it may be useful when
- manually reconstructing a broken cluster.
-
-
- This field is read-only and no changes will be made by Kubernetes
- to the PVC after it has been created.
-
-
- Required, must not be nil.
+ \n An existing PVC with that name that is
+ not owned by the pod will *not* be used for
+ the pod to avoid using an unrelated volume
+ by mistake. Starting the pod is then blocked
+ until the unrelated PVC is removed. If such
+ a pre-created PVC is meant to be used by the
+ pod, the PVC has to updated with an owner
+ reference to the pod once the pod exists.
+ Normally this should not be necessary, but
+ it may be useful when manually reconstructing
+ a broken cluster. \n This field is read-only
+ and no changes will be made by Kubernetes
+ to the PVC after it has been created. \n Required,
+ must not be nil."
properties:
metadata:
- description: |-
- May contain labels and annotations that will be copied into the PVC
- when creating it. No other fields are allowed and will be rejected during
- validation.
+ description: May contain labels and annotations
+ that will be copied into the PVC when
+ creating it. No other fields are allowed
+ and will be rejected during validation.
type: object
spec:
- description: |-
- The specification for the PersistentVolumeClaim. The entire content is
- copied unchanged into the PVC that gets created from this
+ description: The specification for the PersistentVolumeClaim.
+ The entire content is copied unchanged
+ into the PVC that gets created from this
template. The same fields as in a PersistentVolumeClaim
are also valid here.
properties:
accessModes:
- description: |-
- accessModes contains the desired access modes the volume should have.
- More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
+ description: 'accessModes contains the
+ desired access modes the volume should
+ have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
items:
type: string
type: array
dataSource:
- description: |-
- dataSource field can be used to specify either:
- * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
+ description: 'dataSource field can be
+ used to specify either: * An existing
+ VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
* An existing PVC (PersistentVolumeClaim)
- If the provisioner or an external controller can support the specified data source,
- it will create a new volume based on the contents of the specified data source.
- When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,
- and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.
- If the namespace is specified, then dataSourceRef will not be copied to dataSource.
+ If the provisioner or an external
+ controller can support the specified
+ data source, it will create a new
+ volume based on the contents of the
+ specified data source. When the AnyVolumeDataSource
+ feature gate is enabled, dataSource
+ contents will be copied to dataSourceRef,
+ and dataSourceRef contents will be
+ copied to dataSource when dataSourceRef.namespace
+ is not specified. If the namespace
+ is specified, then dataSourceRef will
+ not be copied to dataSource.'
properties:
apiGroup:
- description: |-
- APIGroup is the group for the resource being referenced.
- If APIGroup is not specified, the specified Kind must be in the core API group.
- For any other third-party types, APIGroup is required.
+ description: APIGroup is the group
+ for the resource being referenced.
+ If APIGroup is not specified,
+ the specified Kind must be in
+ the core API group. For any other
+ third-party types, APIGroup is
+ required.
type: string
kind:
description: Kind is the type of
@@ -5239,38 +5532,57 @@ spec:
- kind
- name
type: object
- x-kubernetes-map-type: atomic
dataSourceRef:
- description: |-
- dataSourceRef specifies the object from which to populate the volume with data, if a non-empty
- volume is desired. This may be any object from a non-empty API group (non
- core object) or a PersistentVolumeClaim object.
- When this field is specified, volume binding will only succeed if the type of
- the specified object matches some installed volume populator or dynamic
- provisioner.
- This field will replace the functionality of the dataSource field and as such
- if both fields are non-empty, they must have the same value. For backwards
- compatibility, when namespace isn't specified in dataSourceRef,
- both fields (dataSource and dataSourceRef) will be set to the same
- value automatically if one of them is empty and the other is non-empty.
- When namespace is specified in dataSourceRef,
- dataSource isn't set to the same value and must be empty.
- There are three important differences between dataSource and dataSourceRef:
- * While dataSource only allows two specific types of objects, dataSourceRef
- allows any non-core object, as well as PersistentVolumeClaim objects.
- * While dataSource ignores disallowed values (dropping them), dataSourceRef
- preserves all values, and generates an error if a disallowed value is
- specified.
- * While dataSource only allows local objects, dataSourceRef allows objects
- in any namespaces.
- (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
- (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
+ description: 'dataSourceRef specifies
+ the object from which to populate
+ the volume with data, if a non-empty
+ volume is desired. This may be any
+ object from a non-empty API group
+ (non core object) or a PersistentVolumeClaim
+ object. When this field is specified,
+ volume binding will only succeed if
+ the type of the specified object matches
+ some installed volume populator or
+ dynamic provisioner. This field will
+ replace the functionality of the dataSource
+ field and as such if both fields are
+ non-empty, they must have the same
+ value. For backwards compatibility,
+ when namespace isn''t specified in
+ dataSourceRef, both fields (dataSource
+ and dataSourceRef) will be set to
+ the same value automatically if one
+ of them is empty and the other is
+ non-empty. When namespace is specified
+ in dataSourceRef, dataSource isn''t
+ set to the same value and must be
+ empty. There are three important differences
+ between dataSource and dataSourceRef:
+ * While dataSource only allows two
+ specific types of objects, dataSourceRef allows
+ any non-core object, as well as PersistentVolumeClaim
+ objects. * While dataSource ignores
+ disallowed values (dropping them),
+ dataSourceRef preserves all values,
+ and generates an error if a disallowed
+ value is specified. * While dataSource
+ only allows local objects, dataSourceRef
+ allows objects in any namespaces.
+ (Beta) Using this field requires the
+ AnyVolumeDataSource feature gate to
+ be enabled. (Alpha) Using the namespace
+ field of dataSourceRef requires the
+ CrossNamespaceVolumeDataSource feature
+ gate to be enabled.'
properties:
apiGroup:
- description: |-
- APIGroup is the group for the resource being referenced.
- If APIGroup is not specified, the specified Kind must be in the core API group.
- For any other third-party types, APIGroup is required.
+ description: APIGroup is the group
+ for the resource being referenced.
+ If APIGroup is not specified,
+ the specified Kind must be in
+ the core API group. For any other
+ third-party types, APIGroup is
+ required.
type: string
kind:
description: Kind is the type of
@@ -5281,22 +5593,32 @@ spec:
resource being referenced
type: string
namespace:
- description: |-
- Namespace is the namespace of resource being referenced
- Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.
- (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
+ description: Namespace is the namespace
+ of resource being referenced Note
+ that when a namespace is specified,
+ a gateway.networking.k8s.io/ReferenceGrant
+ object is required in the referent
+ namespace to allow that namespace's
+ owner to accept the reference.
+ See the ReferenceGrant documentation
+ for details. (Alpha) This field
+ requires the CrossNamespaceVolumeDataSource
+ feature gate to be enabled.
type: string
required:
- kind
- name
type: object
resources:
- description: |-
- resources represents the minimum resources the volume should have.
- If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements
- that are lower than previous value but must still be higher than capacity recorded in the
- status field of the claim.
- More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
+ description: 'resources represents the
+ minimum resources the volume should
+ have. If RecoverVolumeExpansionFailure
+ feature is enabled users are allowed
+ to specify resource requirements that
+ are lower than previous value but
+ must still be higher than capacity
+ recorded in the status field of the
+ claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
properties:
limits:
additionalProperties:
@@ -5305,9 +5627,9 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Limits describes the maximum amount of compute resources allowed.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Limits describes the
+ maximum amount of compute resources
+ allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -5316,11 +5638,15 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Requests describes the minimum amount of compute resources required.
- If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
- otherwise to an implementation-defined value. Requests cannot exceed Limits.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Requests describes
+ the minimum amount of compute
+ resources required. If Requests
+ is omitted for a container, it
+ defaults to Limits if that is
+ explicitly specified, otherwise
+ to an implementation-defined value.
+ Requests cannot exceed Limits.
+ More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
selector:
@@ -5332,9 +5658,11 @@ spec:
a list of label selector requirements.
The requirements are ANDed.
items:
- description: |-
- A label selector requirement is a selector that contains values, a key, and an operator that
- relates the key and values.
+ description: A label selector
+ requirement is a selector that
+ contains values, a key, and
+ an operator that relates the
+ key and values.
properties:
key:
description: key is the label
@@ -5342,16 +5670,23 @@ spec:
to.
type: string
operator:
- description: |-
- operator represents a key's relationship to a set of values.
- Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents
+ a key's relationship to
+ a set of values. Valid operators
+ are In, NotIn, Exists and
+ DoesNotExist.
type: string
values:
- description: |-
- values is an array of string values. If the operator is In or NotIn,
- the values array must be non-empty. If the operator is Exists or DoesNotExist,
- the values array must be empty. This array is replaced during a strategic
- merge patch.
+ description: values is an
+ array of string values.
+ If the operator is In or
+ NotIn, the values array
+ must be non-empty. If the
+ operator is Exists or DoesNotExist,
+ the values array must be
+ empty. This array is replaced
+ during a strategic merge
+ patch.
items:
type: string
type: array
@@ -5363,37 +5698,55 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: |-
- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions, whose key field is "key", the
- operator is "In", and the values array contains only "value". The requirements are ANDed.
+ description: matchLabels is a map
+ of {key,value} pairs. A single
+ {key,value} in the matchLabels
+ map is equivalent to an element
+ of matchExpressions, whose key
+ field is "key", the operator is
+ "In", and the values array contains
+ only "value". The requirements
+ are ANDed.
type: object
type: object
- x-kubernetes-map-type: atomic
storageClassName:
- description: |-
- storageClassName is the name of the StorageClass required by the claim.
- More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
+ description: 'storageClassName is the
+ name of the StorageClass required
+ by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
type: string
volumeAttributesClassName:
- description: |-
- volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.
- If specified, the CSI driver will create or update the volume with the attributes defined
- in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,
- it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass
- will be applied to the claim but it's not allowed to reset this field to empty string once it is set.
- If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass
- will be set by the persistentvolume controller if it exists.
- If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be
- set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource
- exists.
+ description: 'volumeAttributesClassName
+ may be used to set the VolumeAttributesClass
+ used by this claim. If specified,
+ the CSI driver will create or update
+ the volume with the attributes defined
+ in the corresponding VolumeAttributesClass.
+ This has a different purpose than
+ storageClassName, it can be changed
+ after the claim is created. An empty
+ string value means that no VolumeAttributesClass
+ will be applied to the claim but it''s
+ not allowed to reset this field to
+ empty string once it is set. If unspecified
+ and the PersistentVolumeClaim is unbound,
+ the default VolumeAttributesClass
+ will be set by the persistentvolume
+ controller if it exists. If the resource
+ referred to by volumeAttributesClass
+ does not exist, this PersistentVolumeClaim
+ will be set to a Pending state, as
+ reflected by the modifyVolumeStatus
+ field, until such as a resource exists.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass
- (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.
+ (Alpha) Using this field requires
+ the VolumeAttributesClass feature
+ gate to be enabled.'
type: string
volumeMode:
- description: |-
- volumeMode defines what type of volume is required by the claim.
- Value of Filesystem is implied when not included in claim spec.
+ description: volumeMode defines what
+ type of volume is required by the
+ claim. Value of Filesystem is implied
+ when not included in claim spec.
type: string
volumeName:
description: volumeName is the binding
@@ -5411,11 +5764,12 @@ spec:
then exposed to the pod.
properties:
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- TODO: how do we prevent errors in the filesystem from compromising the machine
+ description: 'fsType is the filesystem type
+ to mount. Must be a filesystem type supported
+ by the host operating system. Ex. "ext4",
+ "xfs", "ntfs". Implicitly inferred to be "ext4"
+ if unspecified. TODO: how do we prevent errors
+ in the filesystem from compromising the machine'
type: string
lun:
description: 'lun is Optional: FC target lun
@@ -5423,9 +5777,9 @@ spec:
format: int32
type: integer
readOnly:
- description: |-
- readOnly is Optional: Defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: 'readOnly is Optional: Defaults
+ to false (read/write). ReadOnly here will
+ force the ReadOnly setting in VolumeMounts.'
type: boolean
targetWWNs:
description: 'targetWWNs is Optional: FC target
@@ -5434,27 +5788,29 @@ spec:
type: string
type: array
wwids:
- description: |-
- wwids Optional: FC volume world wide identifiers (wwids)
- Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
+ description: 'wwids Optional: FC volume world
+ wide identifiers (wwids) Either wwids or combination
+ of targetWWNs and lun must be set, but not
+ both simultaneously.'
items:
type: string
type: array
type: object
flexVolume:
- description: |-
- flexVolume represents a generic volume resource that is
- provisioned/attached using an exec based plugin.
+ description: flexVolume represents a generic volume
+ resource that is provisioned/attached using an
+ exec based plugin.
properties:
driver:
description: driver is the name of the driver
to use for this volume.
type: string
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
+ description: fsType is the filesystem type to
+ mount. Must be a filesystem type supported
+ by the host operating system. Ex. "ext4",
+ "xfs", "ntfs". The default filesystem depends
+ on FlexVolume script.
type: string
options:
additionalProperties:
@@ -5463,26 +5819,26 @@ spec:
holds extra command options if any.'
type: object
readOnly:
- description: |-
- readOnly is Optional: defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: 'readOnly is Optional: defaults
+ to false (read/write). ReadOnly here will
+ force the ReadOnly setting in VolumeMounts.'
type: boolean
secretRef:
- description: |-
- secretRef is Optional: secretRef is reference to the secret object containing
- sensitive information to pass to the plugin scripts. This may be
- empty if no secret object is specified. If the secret object
- contains more than one secret, all secrets are passed to the plugin
- scripts.
+ description: 'secretRef is Optional: secretRef
+ is reference to the secret object containing
+ sensitive information to pass to the plugin
+ scripts. This may be empty if no secret object
+ is specified. If the secret object contains
+ more than one secret, all secrets are passed
+ to the plugin scripts.'
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
required:
- driver
type: object
@@ -5492,9 +5848,9 @@ spec:
on the Flocker control service being running
properties:
datasetName:
- description: |-
- datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker
- should be considered as deprecated
+ description: datasetName is Name of the dataset
+ stored as metadata -> name on the dataset
+ for Flocker should be considered as deprecated
type: string
datasetUUID:
description: datasetUUID is the UUID of the
@@ -5503,55 +5859,59 @@ spec:
type: string
type: object
gcePersistentDisk:
- description: |-
- gcePersistentDisk represents a GCE Disk resource that is attached to a
- kubelet's host machine and then exposed to the pod.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ description: 'gcePersistentDisk represents a GCE
+ Disk resource that is attached to a kubelet''s
+ host machine and then exposed to the pod. More
+ info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
properties:
fsType:
- description: |-
- fsType is filesystem type of the volume that you want to mount.
- Tip: Ensure that the filesystem type is supported by the host operating system.
- Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
- TODO: how do we prevent errors in the filesystem from compromising the machine
+ description: 'fsType is filesystem type of the
+ volume that you want to mount. Tip: Ensure
+ that the filesystem type is supported by the
+ host operating system. Examples: "ext4", "xfs",
+ "ntfs". Implicitly inferred to be "ext4" if
+ unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
partition:
- description: |-
- partition is the partition in the volume that you want to mount.
- If omitted, the default is to mount by volume name.
- Examples: For volume /dev/sda1, you specify the partition as "1".
- Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ description: 'partition is the partition in
+ the volume that you want to mount. If omitted,
+ the default is to mount by volume name. Examples:
+ For volume /dev/sda1, you specify the partition
+ as "1". Similarly, the volume partition for
+ /dev/sda is "0" (or you can leave the property
+ empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
format: int32
type: integer
pdName:
- description: |-
- pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ description: 'pdName is unique name of the PD
+ resource in GCE. Used to identify the disk
+ in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
type: string
readOnly:
- description: |-
- readOnly here will force the ReadOnly setting in VolumeMounts.
- Defaults to false.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ description: 'readOnly here will force the ReadOnly
+ setting in VolumeMounts. Defaults to false.
+ More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
type: boolean
required:
- pdName
type: object
gitRepo:
- description: |-
- gitRepo represents a git repository at a particular revision.
- DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an
- EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir
- into the Pod's container.
+ description: 'gitRepo represents a git repository
+ at a particular revision. DEPRECATED: GitRepo
+ is deprecated. To provision a container with a
+ git repo, mount an EmptyDir into an InitContainer
+ that clones the repo using git, then mount the
+ EmptyDir into the Pod''s container.'
properties:
directory:
- description: |-
- directory is the target directory name.
- Must not contain or start with '..'. If '.' is supplied, the volume directory will be the
- git repository. Otherwise, if specified, the volume will contain the git repository in
- the subdirectory with the given name.
+ description: directory is the target directory
+ name. Must not contain or start with '..'. If
+ '.' is supplied, the volume directory will
+ be the git repository. Otherwise, if specified,
+ the volume will contain the git repository
+ in the subdirectory with the given name.
type: string
repository:
description: repository is the URL
@@ -5564,61 +5924,55 @@ spec:
- repository
type: object
glusterfs:
- description: |-
- glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.
- More info: https://examples.k8s.io/volumes/glusterfs/README.md
+ description: 'glusterfs represents a Glusterfs mount
+ on the host that shares a pod''s lifetime. More
+ info: https://examples.k8s.io/volumes/glusterfs/README.md'
properties:
endpoints:
- description: |-
- endpoints is the endpoint name that details Glusterfs topology.
- More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
+ description: 'endpoints is the endpoint name
+ that details Glusterfs topology. More info:
+ https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: string
path:
- description: |-
- path is the Glusterfs volume path.
- More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
+ description: 'path is the Glusterfs volume path.
+ More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: string
readOnly:
- description: |-
- readOnly here will force the Glusterfs volume to be mounted with read-only permissions.
- Defaults to false.
- More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
+ description: 'readOnly here will force the Glusterfs
+ volume to be mounted with read-only permissions.
+ Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: boolean
required:
- endpoints
- path
type: object
hostPath:
- description: |-
- hostPath represents a pre-existing file or directory on the host
- machine that is directly exposed to the container. This is generally
- used for system agents or other privileged things that are allowed
- to see the host machine. Most containers will NOT need this.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
- ---
- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not
- mount host directories as read/write.
+ description: 'hostPath represents a pre-existing
+ file or directory on the host machine that is
+ directly exposed to the container. This is generally
+ used for system agents or other privileged things
+ that are allowed to see the host machine. Most
+ containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
+ --- TODO(jonesdl) We need to restrict who can
+ use host directory mounts and who can/can not
+ mount host directories as read/write.'
properties:
path:
- description: |-
- path of the directory on the host.
- If the path is a symlink, it will follow the link to the real path.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
+ description: 'path of the directory on the host.
+ If the path is a symlink, it will follow the
+ link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
type: string
type:
- description: |-
- type for HostPath Volume
- Defaults to ""
- More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
+ description: 'type for HostPath Volume Defaults
+ to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
type: string
required:
- path
type: object
iscsi:
- description: |-
- iscsi represents an ISCSI Disk resource that is attached to a
- kubelet's host machine and then exposed to the pod.
- More info: https://examples.k8s.io/volumes/iscsi/README.md
+ description: 'iscsi represents an ISCSI Disk resource
+ that is attached to a kubelet''s host machine
+ and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md'
properties:
chapAuthDiscovery:
description: chapAuthDiscovery defines whether
@@ -5629,27 +5983,30 @@ spec:
support iSCSI Session CHAP authentication
type: boolean
fsType:
- description: |-
- fsType is the filesystem type of the volume that you want to mount.
- Tip: Ensure that the filesystem type is supported by the host operating system.
- Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
- TODO: how do we prevent errors in the filesystem from compromising the machine
+ description: 'fsType is the filesystem type
+ of the volume that you want to mount. Tip:
+ Ensure that the filesystem type is supported
+ by the host operating system. Examples: "ext4",
+ "xfs", "ntfs". Implicitly inferred to be "ext4"
+ if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
initiatorName:
- description: |-
- initiatorName is the custom iSCSI Initiator Name.
- If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface
- : will be created for the connection.
+ description: initiatorName is the custom iSCSI
+ Initiator Name. If initiatorName is specified
+ with iscsiInterface simultaneously, new iSCSI
+ interface : will
+ be created for the connection.
type: string
iqn:
description: iqn is the target iSCSI Qualified
Name.
type: string
iscsiInterface:
- description: |-
- iscsiInterface is the interface Name that uses an iSCSI transport.
- Defaults to 'default' (tcp).
+ description: iscsiInterface is the interface
+ Name that uses an iSCSI transport. Defaults
+ to 'default' (tcp).
type: string
lun:
description: lun represents iSCSI Target Lun
@@ -5657,33 +6014,33 @@ spec:
format: int32
type: integer
portals:
- description: |-
- portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port
- is other than default (typically TCP ports 860 and 3260).
+ description: portals is the iSCSI Target Portal
+ List. The portal is either an IP or ip_addr:port
+ if the port is other than default (typically
+ TCP ports 860 and 3260).
items:
type: string
type: array
readOnly:
- description: |-
- readOnly here will force the ReadOnly setting in VolumeMounts.
- Defaults to false.
+ description: readOnly here will force the ReadOnly
+ setting in VolumeMounts. Defaults to false.
type: boolean
secretRef:
description: secretRef is the CHAP Secret for
iSCSI target and initiator authentication
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
targetPortal:
- description: |-
- targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port
- is other than default (typically TCP ports 860 and 3260).
+ description: targetPortal is iSCSI Target Portal.
+ The Portal is either an IP or ip_addr:port
+ if the port is other than default (typically
+ TCP ports 860 and 3260).
type: string
required:
- iqn
@@ -5691,51 +6048,44 @@ spec:
- targetPortal
type: object
name:
- description: |-
- name of the volume.
- Must be a DNS_LABEL and unique within the pod.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ description: 'name of the volume. Must be a DNS_LABEL
+ and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
type: string
nfs:
- description: |-
- nfs represents an NFS mount on the host that shares a pod's lifetime
- More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ description: 'nfs represents an NFS mount on the
+ host that shares a pod''s lifetime More info:
+ https://kubernetes.io/docs/concepts/storage/volumes#nfs'
properties:
path:
- description: |-
- path that is exported by the NFS server.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ description: 'path that is exported by the NFS
+ server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: string
readOnly:
- description: |-
- readOnly here will force the NFS export to be mounted with read-only permissions.
- Defaults to false.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ description: 'readOnly here will force the NFS
+ export to be mounted with read-only permissions.
+ Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: boolean
server:
- description: |-
- server is the hostname or IP address of the NFS server.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ description: 'server is the hostname or IP address
+ of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: string
required:
- path
- server
type: object
persistentVolumeClaim:
- description: |-
- persistentVolumeClaimVolumeSource represents a reference to a
- PersistentVolumeClaim in the same namespace.
- More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
+ description: 'persistentVolumeClaimVolumeSource
+ represents a reference to a PersistentVolumeClaim
+ in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
properties:
claimName:
- description: |-
- claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.
- More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
+ description: 'claimName is the name of a PersistentVolumeClaim
+ in the same namespace as the pod using this
+ volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
type: string
readOnly:
- description: |-
- readOnly Will force the ReadOnly setting in VolumeMounts.
- Default false.
+ description: readOnly Will force the ReadOnly
+ setting in VolumeMounts. Default false.
type: boolean
required:
- claimName
@@ -5746,10 +6096,11 @@ spec:
host machine
properties:
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: fsType is the filesystem type to
+ mount. Must be a filesystem type supported
+ by the host operating system. Ex. "ext4",
+ "xfs", "ntfs". Implicitly inferred to be "ext4"
+ if unspecified.
type: string
pdID:
description: pdID is the ID that identifies
@@ -5763,15 +6114,16 @@ spec:
volume attached and mounted on kubelets host machine
properties:
fsType:
- description: |-
- fSType represents the filesystem type to mount
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
+ description: fSType represents the filesystem
+ type to mount Must be a filesystem type supported
+ by the host operating system. Ex. "ext4",
+ "xfs". Implicitly inferred to be "ext4" if
+ unspecified.
type: string
readOnly:
- description: |-
- readOnly defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: readOnly defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
volumeID:
description: volumeID uniquely identifies a
@@ -5785,13 +6137,16 @@ spec:
secrets, configmaps, and downward API
properties:
defaultMode:
- description: |-
- defaultMode are the mode bits used to set permissions on created files by default.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- Directories within the path are not affected by this setting.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: defaultMode are the mode bits used
+ to set permissions on created files by default.
+ Must be an octal value between 0000 and 0777
+ or a decimal value between 0 and 511. YAML
+ accepts both octal and decimal values, JSON
+ requires decimal values for mode bits. Directories
+ within the path are not affected by this setting.
+ This might be in conflict with other options
+ that affect the file mode, like fsGroup, and
+ the result can be other mode bits set.
format: int32
type: integer
sources:
@@ -5801,30 +6156,31 @@ spec:
along with other supported volume types
properties:
clusterTrustBundle:
- description: |-
- ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field
- of ClusterTrustBundle objects in an auto-updating file.
-
-
- Alpha, gated by the ClusterTrustBundleProjection feature gate.
-
-
- ClusterTrustBundle objects can either be selected by name, or by the
- combination of signer name and a label selector.
-
-
- Kubelet performs aggressive normalization of the PEM contents written
- into the pod filesystem. Esoteric PEM features such as inter-block
- comments and block headers are stripped. Certificates are deduplicated.
- The ordering of certificates within the file is arbitrary, and Kubelet
- may change the order over time.
+ description: "ClusterTrustBundle allows
+ a pod to access the `.spec.trustBundle`
+ field of ClusterTrustBundle objects
+ in an auto-updating file. \n Alpha,
+ gated by the ClusterTrustBundleProjection
+ feature gate. \n ClusterTrustBundle
+ objects can either be selected by name,
+ or by the combination of signer name
+ and a label selector. \n Kubelet performs
+ aggressive normalization of the PEM
+ contents written into the pod filesystem.
+ \ Esoteric PEM features such as inter-block
+ comments and block headers are stripped.
+ \ Certificates are deduplicated. The
+ ordering of certificates within the
+ file is arbitrary, and Kubelet may change
+ the order over time."
properties:
labelSelector:
- description: |-
- Select all ClusterTrustBundles that match this label selector. Only has
- effect if signerName is set. Mutually-exclusive with name. If unset,
- interpreted as "match nothing". If set but empty, interpreted as "match
- everything".
+ description: Select all ClusterTrustBundles
+ that match this label selector. Only
+ has effect if signerName is set. Mutually-exclusive
+ with name. If unset, interpreted
+ as "match nothing". If set but
+ empty, interpreted as "match everything".
properties:
matchExpressions:
description: matchExpressions
@@ -5832,9 +6188,11 @@ spec:
requirements. The requirements
are ANDed.
items:
- description: |-
- A label selector requirement is a selector that contains values, a key, and an operator that
- relates the key and values.
+ description: A label selector
+ requirement is a selector
+ that contains values, a key,
+ and an operator that relates
+ the key and values.
properties:
key:
description: key is the
@@ -5842,16 +6200,23 @@ spec:
applies to.
type: string
operator:
- description: |-
- operator represents a key's relationship to a set of values.
- Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents
+ a key's relationship to
+ a set of values. Valid
+ operators are In, NotIn,
+ Exists and DoesNotExist.
type: string
values:
- description: |-
- values is an array of string values. If the operator is In or NotIn,
- the values array must be non-empty. If the operator is Exists or DoesNotExist,
- the values array must be empty. This array is replaced during a strategic
- merge patch.
+ description: values is an
+ array of string values.
+ If the operator is In
+ or NotIn, the values array
+ must be non-empty. If
+ the operator is Exists
+ or DoesNotExist, the values
+ array must be empty. This
+ array is replaced during
+ a strategic merge patch.
items:
type: string
type: array
@@ -5863,35 +6228,42 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: |-
- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions, whose key field is "key", the
- operator is "In", and the values array contains only "value". The requirements are ANDed.
+ description: matchLabels is a
+ map of {key,value} pairs. A
+ single {key,value} in the matchLabels
+ map is equivalent to an element
+ of matchExpressions, whose key
+ field is "key", the operator
+ is "In", and the values array
+ contains only "value". The requirements
+ are ANDed.
type: object
type: object
- x-kubernetes-map-type: atomic
name:
- description: |-
- Select a single ClusterTrustBundle by object name. Mutually-exclusive
+ description: Select a single ClusterTrustBundle
+ by object name. Mutually-exclusive
with signerName and labelSelector.
type: string
optional:
- description: |-
- If true, don't block pod startup if the referenced ClusterTrustBundle(s)
- aren't available. If using name, then the named ClusterTrustBundle is
- allowed not to exist. If using signerName, then the combination of
- signerName and labelSelector is allowed to match zero
- ClusterTrustBundles.
+ description: If true, don't block
+ pod startup if the referenced ClusterTrustBundle(s)
+ aren't available. If using name,
+ then the named ClusterTrustBundle
+ is allowed not to exist. If using
+ signerName, then the combination
+ of signerName and labelSelector
+ is allowed to match zero ClusterTrustBundles.
type: boolean
path:
description: Relative path from the
volume root to write the bundle.
type: string
signerName:
- description: |-
- Select all ClusterTrustBundles that match this signer name.
- Mutually-exclusive with name. The contents of all selected
- ClusterTrustBundles will be unified and deduplicated.
+ description: Select all ClusterTrustBundles
+ that match this signer name. Mutually-exclusive
+ with name. The contents of all
+ selected ClusterTrustBundles will
+ be unified and deduplicated.
type: string
required:
- path
@@ -5901,14 +6273,21 @@ spec:
the configMap data to project
properties:
items:
- description: |-
- items if unspecified, each key-value pair in the Data field of the referenced
- ConfigMap will be projected into the volume as a file whose name is the
- key and content is the value. If specified, the listed keys will be
- projected into the specified paths, and unlisted keys will not be
- present. If a key is specified which is not present in the ConfigMap,
- the volume setup will error unless it is marked optional. Paths must be
- relative and may not contain the '..' path or start with '..'.
+ description: items if unspecified,
+ each key-value pair in the Data
+ field of the referenced ConfigMap
+ will be projected into the volume
+ as a file whose name is the key
+ and content is the value. If specified,
+ the listed keys will be projected
+ into the specified paths, and unlisted
+ keys will not be present. If a key
+ is specified which is not present
+ in the ConfigMap, the volume setup
+ will error unless it is marked optional.
+ Paths must be relative and may not
+ contain the '..' path or start with
+ '..'.
items:
description: Maps a string key to
a path within a volume.
@@ -5918,21 +6297,30 @@ spec:
to project.
type: string
mode:
- description: |-
- mode is Optional: mode bits used to set permissions on this file.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'mode is Optional:
+ mode bits used to set permissions
+ on this file. Must be an octal
+ value between 0000 and 0777
+ or a decimal value between
+ 0 and 511. YAML accepts both
+ octal and decimal values,
+ JSON requires decimal values
+ for mode bits. If not specified,
+ the volume defaultMode will
+ be used. This might be in
+ conflict with other options
+ that affect the file mode,
+ like fsGroup, and the result
+ can be other mode bits set.'
format: int32
type: integer
path:
- description: |-
- path is the relative path of the file to map the key to.
- May not be an absolute path.
- May not contain the path element '..'.
- May not start with the string '..'.
+ description: path is the relative
+ path of the file to map the
+ key to. May not be an absolute
+ path. May not contain the
+ path element '..'. May not
+ start with the string '..'.
type: string
required:
- key
@@ -5940,10 +6328,10 @@ spec:
type: object
type: array
name:
- description: |-
- Name of the referent.
+ description: 'Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: optional specify whether
@@ -5951,7 +6339,6 @@ spec:
defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
downwardAPI:
description: downwardAPI information about
the downwardAPI data to project
@@ -5984,15 +6371,22 @@ spec:
required:
- fieldPath
type: object
- x-kubernetes-map-type: atomic
mode:
- description: |-
- Optional: mode bits used to set permissions on this file, must be an octal value
- between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'Optional: mode
+ bits used to set permissions
+ on this file, must be an octal
+ value between 0000 and 0777
+ or a decimal value between
+ 0 and 511. YAML accepts both
+ octal and decimal values,
+ JSON requires decimal values
+ for mode bits. If not specified,
+ the volume defaultMode will
+ be used. This might be in
+ conflict with other options
+ that affect the file mode,
+ like fsGroup, and the result
+ can be other mode bits set.'
format: int32
type: integer
path:
@@ -6006,9 +6400,12 @@ spec:
start with ''..'''
type: string
resourceFieldRef:
- description: |-
- Selects a resource of the container: only resources limits and requests
- (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
+ description: 'Selects a resource
+ of the container: only resources
+ limits and requests (limits.cpu,
+ limits.memory, requests.cpu
+ and requests.memory) are currently
+ supported.'
properties:
containerName:
description: 'Container
@@ -6032,7 +6429,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
required:
- path
type: object
@@ -6043,14 +6439,21 @@ spec:
the secret data to project
properties:
items:
- description: |-
- items if unspecified, each key-value pair in the Data field of the referenced
- Secret will be projected into the volume as a file whose name is the
- key and content is the value. If specified, the listed keys will be
- projected into the specified paths, and unlisted keys will not be
- present. If a key is specified which is not present in the Secret,
- the volume setup will error unless it is marked optional. Paths must be
- relative and may not contain the '..' path or start with '..'.
+ description: items if unspecified,
+ each key-value pair in the Data
+ field of the referenced Secret will
+ be projected into the volume as
+ a file whose name is the key and
+ content is the value. If specified,
+ the listed keys will be projected
+ into the specified paths, and unlisted
+ keys will not be present. If a key
+ is specified which is not present
+ in the Secret, the volume setup
+ will error unless it is marked optional.
+ Paths must be relative and may not
+ contain the '..' path or start with
+ '..'.
items:
description: Maps a string key to
a path within a volume.
@@ -6060,21 +6463,30 @@ spec:
to project.
type: string
mode:
- description: |-
- mode is Optional: mode bits used to set permissions on this file.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'mode is Optional:
+ mode bits used to set permissions
+ on this file. Must be an octal
+ value between 0000 and 0777
+ or a decimal value between
+ 0 and 511. YAML accepts both
+ octal and decimal values,
+ JSON requires decimal values
+ for mode bits. If not specified,
+ the volume defaultMode will
+ be used. This might be in
+ conflict with other options
+ that affect the file mode,
+ like fsGroup, and the result
+ can be other mode bits set.'
format: int32
type: integer
path:
- description: |-
- path is the relative path of the file to map the key to.
- May not be an absolute path.
- May not contain the path element '..'.
- May not start with the string '..'.
+ description: path is the relative
+ path of the file to map the
+ key to. May not be an absolute
+ path. May not contain the
+ path element '..'. May not
+ start with the string '..'.
type: string
required:
- key
@@ -6082,10 +6494,10 @@ spec:
type: object
type: array
name:
- description: |-
- Name of the referent.
+ description: 'Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: optional field specify
@@ -6093,33 +6505,40 @@ spec:
be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
serviceAccountToken:
description: serviceAccountToken is information
about the serviceAccountToken data to
project
properties:
audience:
- description: |-
- audience is the intended audience of the token. A recipient of a token
- must identify itself with an identifier specified in the audience of the
- token, and otherwise should reject the token. The audience defaults to the
- identifier of the apiserver.
+ description: audience is the intended
+ audience of the token. A recipient
+ of a token must identify itself
+ with an identifier specified in
+ the audience of the token, and otherwise
+ should reject the token. The audience
+ defaults to the identifier of the
+ apiserver.
type: string
expirationSeconds:
- description: |-
- expirationSeconds is the requested duration of validity of the service
- account token. As the token approaches expiration, the kubelet volume
- plugin will proactively rotate the service account token. The kubelet will
- start trying to rotate the token if the token is older than 80 percent of
- its time to live or if the token is older than 24 hours.Defaults to 1 hour
+ description: expirationSeconds is
+ the requested duration of validity
+ of the service account token. As
+ the token approaches expiration,
+ the kubelet volume plugin will proactively
+ rotate the service account token.
+ The kubelet will start trying to
+ rotate the token if the token is
+ older than 80 percent of its time
+ to live or if the token is older
+ than 24 hours.Defaults to 1 hour
and must be at least 10 minutes.
format: int64
type: integer
path:
- description: |-
- path is the path relative to the mount point of the file to project the
- token into.
+ description: path is the path relative
+ to the mount point of the file to
+ project the token into.
type: string
required:
- path
@@ -6132,30 +6551,30 @@ spec:
on the host that shares a pod's lifetime
properties:
group:
- description: |-
- group to map volume access to
- Default is no group
+ description: group to map volume access to Default
+ is no group
type: string
readOnly:
- description: |-
- readOnly here will force the Quobyte volume to be mounted with read-only permissions.
+ description: readOnly here will force the Quobyte
+ volume to be mounted with read-only permissions.
Defaults to false.
type: boolean
registry:
- description: |-
- registry represents a single or multiple Quobyte Registry services
- specified as a string as host:port pair (multiple entries are separated with commas)
- which acts as the central registry for volumes
+ description: registry represents a single or
+ multiple Quobyte Registry services specified
+ as a string as host:port pair (multiple entries
+ are separated with commas) which acts as the
+ central registry for volumes
type: string
tenant:
- description: |-
- tenant owning the given Quobyte volume in the Backend
- Used with dynamically provisioned Quobyte volumes, value is set by the plugin
+ description: tenant owning the given Quobyte
+ volume in the Backend Used with dynamically
+ provisioned Quobyte volumes, value is set
+ by the plugin
type: string
user:
- description: |-
- user to map volume access to
- Defaults to serivceaccount user
+ description: user to map volume access to Defaults
+ to serivceaccount user
type: string
volume:
description: volume is a string that references
@@ -6166,68 +6585,59 @@ spec:
- volume
type: object
rbd:
- description: |-
- rbd represents a Rados Block Device mount on the host that shares a pod's lifetime.
- More info: https://examples.k8s.io/volumes/rbd/README.md
+ description: 'rbd represents a Rados Block Device
+ mount on the host that shares a pod''s lifetime.
+ More info: https://examples.k8s.io/volumes/rbd/README.md'
properties:
fsType:
- description: |-
- fsType is the filesystem type of the volume that you want to mount.
- Tip: Ensure that the filesystem type is supported by the host operating system.
- Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd
- TODO: how do we prevent errors in the filesystem from compromising the machine
+ description: 'fsType is the filesystem type
+ of the volume that you want to mount. Tip:
+ Ensure that the filesystem type is supported
+ by the host operating system. Examples: "ext4",
+ "xfs", "ntfs". Implicitly inferred to be "ext4"
+ if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
image:
- description: |-
- image is the rados image name.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'image is the rados image name.
+ More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
keyring:
- description: |-
- keyring is the path to key ring for RBDUser.
- Default is /etc/ceph/keyring.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'keyring is the path to key ring
+ for RBDUser. Default is /etc/ceph/keyring.
+ More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
monitors:
- description: |-
- monitors is a collection of Ceph monitors.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'monitors is a collection of Ceph
+ monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
items:
type: string
type: array
pool:
- description: |-
- pool is the rados pool name.
- Default is rbd.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'pool is the rados pool name. Default
+ is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
readOnly:
- description: |-
- readOnly here will force the ReadOnly setting in VolumeMounts.
- Defaults to false.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'readOnly here will force the ReadOnly
+ setting in VolumeMounts. Defaults to false.
+ More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: boolean
secretRef:
- description: |-
- secretRef is name of the authentication secret for RBDUser. If provided
- overrides keyring.
- Default is nil.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'secretRef is name of the authentication
+ secret for RBDUser. If provided overrides
+ keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
user:
- description: |-
- user is the rados user name.
- Default is admin.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'user is the rados user name. Default
+ is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
required:
- image
@@ -6238,11 +6648,10 @@ spec:
volume attached and mounted on Kubernetes nodes.
properties:
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs".
- Default is "xfs".
+ description: fsType is the filesystem type to
+ mount. Must be a filesystem type supported
+ by the host operating system. Ex. "ext4",
+ "xfs", "ntfs". Default is "xfs".
type: string
gateway:
description: gateway is the host address of
@@ -6254,31 +6663,31 @@ spec:
storage.
type: string
readOnly:
- description: |-
- readOnly Defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: readOnly Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
secretRef:
- description: |-
- secretRef references to the secret for ScaleIO user and other
- sensitive information. If this is not provided, Login operation will fail.
+ description: secretRef references to the secret
+ for ScaleIO user and other sensitive information.
+ If this is not provided, Login operation will
+ fail.
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
sslEnabled:
description: sslEnabled Flag enable/disable
SSL communication with Gateway, default false
type: boolean
storageMode:
- description: |-
- storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.
- Default is ThinProvisioned.
+ description: storageMode indicates whether the
+ storage for a volume should be ThickProvisioned
+ or ThinProvisioned. Default is ThinProvisioned.
type: string
storagePool:
description: storagePool is the ScaleIO Storage
@@ -6289,9 +6698,9 @@ spec:
system as configured in ScaleIO.
type: string
volumeName:
- description: |-
- volumeName is the name of a volume already created in the ScaleIO system
- that is associated with this volume source.
+ description: volumeName is the name of a volume
+ already created in the ScaleIO system that
+ is associated with this volume source.
type: string
required:
- gateway
@@ -6299,30 +6708,35 @@ spec:
- system
type: object
secret:
- description: |-
- secret represents a secret that should populate this volume.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
+ description: 'secret represents a secret that should
+ populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
properties:
defaultMode:
- description: |-
- defaultMode is Optional: mode bits used to set permissions on created files by default.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values
- for mode bits. Defaults to 0644.
- Directories within the path are not affected by this setting.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'defaultMode is Optional: mode
+ bits used to set permissions on created files
+ by default. Must be an octal value between
+ 0000 and 0777 or a decimal value between 0
+ and 511. YAML accepts both octal and decimal
+ values, JSON requires decimal values for mode
+ bits. Defaults to 0644. Directories within
+ the path are not affected by this setting.
+ This might be in conflict with other options
+ that affect the file mode, like fsGroup, and
+ the result can be other mode bits set.'
format: int32
type: integer
items:
- description: |-
- items If unspecified, each key-value pair in the Data field of the referenced
- Secret will be projected into the volume as a file whose name is the
- key and content is the value. If specified, the listed keys will be
- projected into the specified paths, and unlisted keys will not be
- present. If a key is specified which is not present in the Secret,
- the volume setup will error unless it is marked optional. Paths must be
- relative and may not contain the '..' path or start with '..'.
+ description: items If unspecified, each key-value
+ pair in the Data field of the referenced Secret
+ will be projected into the volume as a file
+ whose name is the key and content is the value.
+ If specified, the listed keys will be projected
+ into the specified paths, and unlisted keys
+ will not be present. If a key is specified
+ which is not present in the Secret, the volume
+ setup will error unless it is marked optional.
+ Paths must be relative and may not contain
+ the '..' path or start with '..'.
items:
description: Maps a string key to a path within
a volume.
@@ -6331,21 +6745,26 @@ spec:
description: key is the key to project.
type: string
mode:
- description: |-
- mode is Optional: mode bits used to set permissions on this file.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'mode is Optional: mode bits
+ used to set permissions on this file.
+ Must be an octal value between 0000
+ and 0777 or a decimal value between
+ 0 and 511. YAML accepts both octal and
+ decimal values, JSON requires decimal
+ values for mode bits. If not specified,
+ the volume defaultMode will be used.
+ This might be in conflict with other
+ options that affect the file mode, like
+ fsGroup, and the result can be other
+ mode bits set.'
format: int32
type: integer
path:
- description: |-
- path is the relative path of the file to map the key to.
- May not be an absolute path.
- May not contain the path element '..'.
- May not start with the string '..'.
+ description: path is the relative path
+ of the file to map the key to. May not
+ be an absolute path. May not contain
+ the path element '..'. May not start
+ with the string '..'.
type: string
required:
- key
@@ -6357,9 +6776,9 @@ spec:
the Secret or its keys must be defined
type: boolean
secretName:
- description: |-
- secretName is the name of the secret in the pod's namespace to use.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
+ description: 'secretName is the name of the
+ secret in the pod''s namespace to use. More
+ info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
type: string
type: object
storageos:
@@ -6367,42 +6786,45 @@ spec:
attached and mounted on Kubernetes nodes.
properties:
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: fsType is the filesystem type to
+ mount. Must be a filesystem type supported
+ by the host operating system. Ex. "ext4",
+ "xfs", "ntfs". Implicitly inferred to be "ext4"
+ if unspecified.
type: string
readOnly:
- description: |-
- readOnly defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: readOnly defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
secretRef:
- description: |-
- secretRef specifies the secret to use for obtaining the StorageOS API
- credentials. If not specified, default values will be attempted.
+ description: secretRef specifies the secret
+ to use for obtaining the StorageOS API credentials. If
+ not specified, default values will be attempted.
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
volumeName:
- description: |-
- volumeName is the human-readable name of the StorageOS volume. Volume
- names are only unique within a namespace.
+ description: volumeName is the human-readable
+ name of the StorageOS volume. Volume names
+ are only unique within a namespace.
type: string
volumeNamespace:
- description: |-
- volumeNamespace specifies the scope of the volume within StorageOS. If no
- namespace is specified then the Pod's namespace will be used. This allows the
- Kubernetes name scoping to be mirrored within StorageOS for tighter integration.
- Set VolumeName to any name to override the default behaviour.
- Set to "default" if you are not using namespaces within StorageOS.
- Namespaces that do not pre-exist within StorageOS will be created.
+ description: volumeNamespace specifies the scope
+ of the volume within StorageOS. If no namespace
+ is specified then the Pod's namespace will
+ be used. This allows the Kubernetes name
+ scoping to be mirrored within StorageOS for
+ tighter integration. Set VolumeName to any
+ name to override the default behaviour. Set
+ to "default" if you are not using namespaces
+ within StorageOS. Namespaces that do not pre-exist
+ within StorageOS will be created.
type: string
type: object
vsphereVolume:
@@ -6410,10 +6832,11 @@ spec:
volume attached and mounted on kubelets host machine
properties:
fsType:
- description: |-
- fsType is filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: fsType is filesystem type to mount.
+ Must be a filesystem type supported by the
+ host operating system. Ex. "ext4", "xfs",
+ "ntfs". Implicitly inferred to be "ext4" if
+ unspecified.
type: string
storagePolicyID:
description: storagePolicyID is the storage
@@ -6464,9 +6887,8 @@ spec:
description: The configuration of Affinity trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6485,9 +6907,9 @@ spec:
integration in the same node (default `false`).
type: boolean
podAffinityLabels:
- description: |-
- Defines a set of pods (namely those matching the label selector, relative to the given namespace) that the
- integration pod(s) should be co-located with.
+ description: Defines a set of pods (namely those matching
+ the label selector, relative to the given namespace)
+ that the integration pod(s) should be co-located with.
items:
type: string
type: array
@@ -6496,9 +6918,10 @@ spec:
integration in the same node (default `false`).
type: boolean
podAntiAffinityLabels:
- description: |-
- Defines a set of pods (namely those matching the label selector, relative to the given namespace) that the
- integration pod(s) should not be co-located with.
+ description: Defines a set of pods (namely those matching
+ the label selector, relative to the given namespace)
+ that the integration pod(s) should not be co-located
+ with.
items:
type: string
type: array
@@ -6513,14 +6936,14 @@ spec:
use for the builder pod.
type: object
baseImage:
- description: |-
- Specify a base image. In order to have the application working properly it must be a container image which has a Java JDK
- installed and ready to use on path (ie `/usr/bin/java`).
+ description: Specify a base image. In order to have the
+ application working properly it must be a container
+ image which has a Java JDK installed and ready to use
+ on path (ie `/usr/bin/java`).
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6531,21 +6954,28 @@ spec:
reuse existing containers (default `true`)
type: boolean
limitCPU:
- description: |-
- When using `pod` strategy, the maximum amount of CPU required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the maximum amount
+ of CPU required by the pod builder. Deprecated: use
+ TasksRequestCPU instead with task name `builder`.'
type: string
limitMemory:
- description: |-
- When using `pod` strategy, the maximum amount of memory required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the maximum amount
+ of memory required by the pod builder. Deprecated: use
+ TasksRequestCPU instead with task name `builder`.'
type: string
mavenProfiles:
- description: |-
- A list of references pointing to configmaps/secrets that contains a maven profile.
- This configmap/secret is a resource of the IntegrationKit created, therefore it needs to be present in the namespace where the operator is going to create the IntegrationKit.
- The content of the maven profile is expected to be a text containing a valid maven profile starting with `` and ending with `` that will be integrated as an inline profile in the POM.
- Syntax: [configmap|secret]:name[/key], where name represents the resource name, key optionally represents the resource key to be filtered (default key value = profile.xml).
+ description: 'A list of references pointing to configmaps/secrets
+ that contains a maven profile. This configmap/secret
+ is a resource of the IntegrationKit created, therefore
+ it needs to be present in the namespace where the operator
+ is going to create the IntegrationKit. The content of
+ the maven profile is expected to be a text containing
+ a valid maven profile starting with `` and
+ ending with `` that will be integrated as
+ an inline profile in the POM. Syntax: [configmap|secret]:name[/key],
+ where name represents the resource name, key optionally
+ represents the resource key to be filtered (default
+ key value = profile.xml).'
items:
type: string
type: array
@@ -6577,14 +7007,14 @@ spec:
type: string
type: array
requestCPU:
- description: |-
- When using `pod` strategy, the minimum amount of CPU required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the minimum amount
+ of CPU required by the pod builder. Deprecated: use
+ TasksRequestCPU instead with task name `builder`.'
type: string
requestMemory:
- description: |-
- When using `pod` strategy, the minimum amount of memory required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the minimum amount
+ of memory required by the pod builder. Deprecated: use
+ TasksRequestCPU instead with task name `builder`.'
type: string
strategy:
description: The strategy to use, either `pod` or `routine`
@@ -6600,10 +7030,11 @@ spec:
type: string
type: array
tasksFilter:
- description: |-
- A list of tasks sorted by the order of execution in a csv format, ie, `,,...`.
- Mind that you must include also the operator tasks (`builder`, `quarkus-native`, `package`, `jib`, `s2i`)
- if you need to execute them. Useful only with `pod` strategy.
+ description: A list of tasks sorted by the order of execution
+ in a csv format, ie, `,,...`.
+ Mind that you must include also the operator tasks (`builder`,
+ `quarkus-native`, `package`, `jib`, `s2i`) if you need
+ to execute them. Useful only with `pod` strategy.
type: string
tasksLimitCPU:
description: A list of limit cpu configuration for the
@@ -6630,18 +7061,17 @@ spec:
type: string
type: array
verbose:
- description: |-
- Enable verbose logging on build components that support it (e.g. Kaniko build pod).
- Deprecated no longer in use
+ description: Enable verbose logging on build components
+ that support it (e.g. Kaniko build pod). Deprecated
+ no longer in use
type: boolean
type: object
camel:
description: The configuration of Camel trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6654,10 +7084,12 @@ spec:
type: string
type: array
runtimeVersion:
- description: |-
- The camel-k-runtime version to use for the integration. It overrides the default version set in the Integration Platform.
- You can use a fixed version (for example "3.2.3") or a semantic version (for example "3.x") which will try to resolve
- to the best matching Catalog existing on the cluster.
+ description: The camel-k-runtime version to use for the
+ integration. It overrides the default version set in
+ the Integration Platform. You can use a fixed version
+ (for example "3.2.3") or a semantic version (for example
+ "3.x") which will try to resolve to the best matching
+ Catalog existing on the cluster.
type: string
type: object
container:
@@ -6687,9 +7119,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6700,10 +7131,14 @@ spec:
kubernetes Service.
type: boolean
image:
- description: |-
- The main container image to use for the Integration. When using this parameter the operator will create a synthetic IntegrationKit which
- won't be able to execute traits requiring CamelCatalog. If the container image you're using is coming from an IntegrationKit, use instead
- Integration `.spec.integrationKit` parameter. If you're moving the Integration across environments, you will also need to create an "external" IntegrationKit.
+ description: The main container image to use for the Integration.
+ When using this parameter the operator will create a
+ synthetic IntegrationKit which won't be able to execute
+ traits requiring CamelCatalog. If the container image
+ you're using is coming from an IntegrationKit, use instead
+ Integration `.spec.integrationKit` parameter. If you're
+ moving the Integration across environments, you will
+ also need to create an "external" IntegrationKit.
type: string
imagePullPolicy:
description: 'The pull policy: Always|Never|IfNotPresent'
@@ -6771,52 +7206,52 @@ spec:
description: The configuration of Cron trait
properties:
activeDeadlineSeconds:
- description: |-
- Specifies the duration in seconds, relative to the start time, that the job
- may be continuously active before it is considered to be failed.
- It defaults to 60s.
+ description: Specifies the duration in seconds, relative
+ to the start time, that the job may be continuously
+ active before it is considered to be failed. It defaults
+ to 60s.
format: int64
type: integer
auto:
- description: |-
- Automatically deploy the integration as CronJob when all routes are
- either starting from a periodic consumer (only `cron`, `timer` and `quartz` are supported) or a passive consumer (e.g. `direct` is a passive consumer).
-
-
- It's required that all periodic consumers have the same period, and it can be expressed as cron schedule (e.g. `1m` can be expressed as `0/1 * * * *`,
- while `35m` or `50s` cannot).
+ description: "Automatically deploy the integration as
+ CronJob when all routes are either starting from a periodic
+ consumer (only `cron`, `timer` and `quartz` are supported)
+ or a passive consumer (e.g. `direct` is a passive consumer).
+ \n It's required that all periodic consumers have the
+ same period, and it can be expressed as cron schedule
+ (e.g. `1m` can be expressed as `0/1 * * * *`, while
+ `35m` or `50s` cannot)."
type: boolean
backoffLimit:
- description: |-
- Specifies the number of retries before marking the job failed.
- It defaults to 2.
+ description: Specifies the number of retries before marking
+ the job failed. It defaults to 2.
format: int32
type: integer
components:
- description: |-
- A comma separated list of the Camel components that need to be customized in order for them to work when the schedule is triggered externally by Kubernetes.
- A specific customizer is activated for each specified component. E.g. for the `timer` component, the `cron-timer` customizer is
- activated (it's present in the `org.apache.camel.k:camel-k-cron` library).
-
-
- Supported components are currently: `cron`, `timer` and `quartz`.
+ description: "A comma separated list of the Camel components
+ that need to be customized in order for them to work
+ when the schedule is triggered externally by Kubernetes.
+ A specific customizer is activated for each specified
+ component. E.g. for the `timer` component, the `cron-timer`
+ customizer is activated (it's present in the `org.apache.camel.k:camel-k-cron`
+ library). \n Supported components are currently: `cron`,
+ `timer` and `quartz`."
type: string
concurrencyPolicy:
- description: |-
- Specifies how to treat concurrent executions of a Job.
- Valid values are:
- - "Allow": allows CronJobs to run concurrently;
- - "Forbid" (default): forbids concurrent runs, skipping next run if previous run hasn't finished yet;
- - "Replace": cancels currently running job and replaces it with a new one
+ description: 'Specifies how to treat concurrent executions
+ of a Job. Valid values are: - "Allow": allows CronJobs
+ to run concurrently; - "Forbid" (default): forbids concurrent
+ runs, skipping next run if previous run hasn''t finished
+ yet; - "Replace": cancels currently running job and
+ replaces it with a new one'
enum:
- Allow
- Forbid
- Replace
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6824,19 +7259,19 @@ spec:
All traits share this common property.
type: boolean
fallback:
- description: |-
- Use the default Camel implementation of the `cron` endpoint (`quartz`) instead of trying to materialize the integration
- as Kubernetes CronJob.
+ description: Use the default Camel implementation of the
+ `cron` endpoint (`quartz`) instead of trying to materialize
+ the integration as Kubernetes CronJob.
type: boolean
schedule:
- description: |-
- The CronJob schedule for the whole integration. If multiple routes are declared, they must have the same schedule for this
- mechanism to work correctly.
+ description: The CronJob schedule for the whole integration.
+ If multiple routes are declared, they must have the
+ same schedule for this mechanism to work correctly.
type: string
startingDeadlineSeconds:
- description: |-
- Optional deadline in seconds for starting the job if it misses scheduled
- time for any reason. Missed jobs executions will be counted as failed ones.
+ description: Optional deadline in seconds for starting
+ the job if it misses scheduled time for any reason. Missed
+ jobs executions will be counted as failed ones.
format: int64
type: integer
timeZone:
@@ -6847,9 +7282,8 @@ spec:
description: The configuration of Dependencies trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6860,9 +7294,8 @@ spec:
description: The configuration of Deployer trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6878,51 +7311,49 @@ spec:
- knative-service
type: string
useSSA:
- description: |-
- Use server-side apply to update the owned resources (default `true`).
- Note that it automatically falls back to client-side patching, if SSA is not available, e.g., on old Kubernetes clusters.
+ description: Use server-side apply to update the owned
+ resources (default `true`). Note that it automatically
+ falls back to client-side patching, if SSA is not available,
+ e.g., on old Kubernetes clusters.
type: boolean
type: object
deployment:
description: The configuration of Deployment trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
description: 'Deprecated: no longer in use.'
type: boolean
progressDeadlineSeconds:
- description: |-
- The maximum time in seconds for the deployment to make progress before it
- is considered to be failed. It defaults to `60s`.
+ description: The maximum time in seconds for the deployment
+ to make progress before it is considered to be failed.
+ It defaults to `60s`.
format: int32
type: integer
rollingUpdateMaxSurge:
anyOf:
- type: integer
- type: string
- description: |-
- The maximum number of pods that can be scheduled above the desired number of
- pods.
- Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
- This can not be 0 if MaxUnavailable is 0.
- Absolute number is calculated from percentage by rounding up.
- Defaults to `25%`.
+ description: 'The maximum number of pods that can be scheduled
+ above the desired number of pods. Value can be an absolute
+ number (ex: 5) or a percentage of desired pods (ex:
+ 10%). This can not be 0 if MaxUnavailable is 0. Absolute
+ number is calculated from percentage by rounding up.
+ Defaults to `25%`.'
x-kubernetes-int-or-string: true
rollingUpdateMaxUnavailable:
anyOf:
- type: integer
- type: string
- description: |-
- The maximum number of pods that can be unavailable during the update.
- Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
- Absolute number is calculated from percentage by rounding down.
- This can not be 0 if MaxSurge is 0.
- Defaults to `25%`.
+ description: 'The maximum number of pods that can be unavailable
+ during the update. Value can be an absolute number (ex:
+ 5) or a percentage of desired pods (ex: 10%). Absolute
+ number is calculated from percentage by rounding down.
+ This can not be 0 if MaxSurge is 0. Defaults to `25%`.'
x-kubernetes-int-or-string: true
strategy:
description: The deployment strategy to use to replace
@@ -6936,9 +7367,8 @@ spec:
description: The configuration of Environment trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
containerMeta:
@@ -6953,11 +7383,12 @@ spec:
and `NO_PROXY` environment variables (default `true`)
type: boolean
vars:
- description: |-
- A list of environment variables to be added to the integration container.
- The syntax is either VAR=VALUE or VAR=[configmap|secret]:name/key, where name represents the resource name,
- and key represents the resource key to be mapped as and environment variable.
- These take precedence over any previously defined environment variables.
+ description: A list of environment variables to be added
+ to the integration container. The syntax is either VAR=VALUE
+ or VAR=[configmap|secret]:name/key, where name represents
+ the resource name, and key represents the resource key
+ to be mapped as and environment variable. These take
+ precedence over any previously defined environment variables.
items:
type: string
type: array
@@ -6966,9 +7397,8 @@ spec:
description: The configuration of Error Handler trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6983,15 +7413,14 @@ spec:
description: The configuration of GC trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
discoveryCache:
- description: |-
- Discovery client cache to be used, either `disabled`, `disk` or `memory` (default `memory`).
- Deprecated: to be removed from trait configuration.
+ description: 'Discovery client cache to be used, either
+ `disabled`, `disk` or `memory` (default `memory`). Deprecated:
+ to be removed from trait configuration.'
enum:
- disabled
- disk
@@ -7006,9 +7435,8 @@ spec:
description: The configuration of Health trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7130,19 +7558,17 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to the ingress.
- This can be used to set controller specific annotations, e.g., when using the NGINX Ingress controller:
- See https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md
+ description: 'The annotations added to the ingress. This
+ can be used to set controller specific annotations,
+ e.g., when using the NGINX Ingress controller: See https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md'
type: object
auto:
description: To automatically add an ingress whenever
the integration uses an HTTP endpoint consumer.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7152,14 +7578,18 @@ spec:
host:
description: To configure the host exposed by the ingress.
type: string
+ ingressClassName:
+ description: The Ingress class name as defined by the
+ Ingress spec See https://kubernetes.io/docs/concepts/services-networking/ingress/
+ type: string
path:
description: To configure the path exposed by the ingress
(default `/`).
type: string
pathType:
- description: |-
- To configure the path type exposed by the ingress.
- One of `Exact`, `Prefix`, `ImplementationSpecific` (default to `Prefix`).
+ description: To configure the path type exposed by the
+ ingress. One of `Exact`, `Prefix`, `ImplementationSpecific`
+ (default to `Prefix`).
enum:
- Exact
- Prefix
@@ -7184,9 +7614,8 @@ spec:
default).
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7203,23 +7632,25 @@ spec:
description: The configuration of Jolokia trait
properties:
CACert:
- description: |-
- The PEM encoded CA certification file path, used to verify client certificates,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt` for OpenShift).
+ description: The PEM encoded CA certification file path,
+ used to verify client certificates, applicable when
+ `protocol` is `https` and `use-ssl-client-authentication`
+ is `true` (default `/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt`
+ for OpenShift).
type: string
clientPrincipal:
- description: |-
- The principal(s) which must be given in a client certificate to allow access to the Jolokia endpoint,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `clientPrincipal=cn=system:master-proxy`, `cn=hawtio-online.hawtio.svc` and `cn=fuse-console.fuse.svc` for OpenShift).
+ description: The principal(s) which must be given in a
+ client certificate to allow access to the Jolokia endpoint,
+ applicable when `protocol` is `https` and `use-ssl-client-authentication`
+ is `true` (default `clientPrincipal=cn=system:master-proxy`,
+ `cn=hawtio-online.hawtio.svc` and `cn=fuse-console.fuse.svc`
+ for OpenShift).
items:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
discoveryEnabled:
@@ -7230,20 +7661,20 @@ spec:
All traits share this common property.
type: boolean
extendedClientCheck:
- description: |-
- Mandate the client certificate contains a client flag in the extended key usage section,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `true` for OpenShift).
+ description: Mandate the client certificate contains a
+ client flag in the extended key usage section, applicable
+ when `protocol` is `https` and `use-ssl-client-authentication`
+ is `true` (default `true` for OpenShift).
type: boolean
host:
- description: |-
- The Host address to which the Jolokia agent should bind to. If `"\*"` or `"0.0.0.0"` is given,
- the servers binds to every network interface (default `"*"`).
+ description: The Host address to which the Jolokia agent
+ should bind to. If `"\*"` or `"0.0.0.0"` is given, the
+ servers binds to every network interface (default `"*"`).
type: string
options:
- description: |-
- A list of additional Jolokia options as defined
- in https://jolokia.org/reference/html/agents.html#agent-jvm-config[JVM agent configuration options]
+ description: A list of additional Jolokia options as defined
+ in https://jolokia.org/reference/html/agents.html#agent-jvm-config[JVM
+ agent configuration options]
items:
type: string
type: array
@@ -7274,9 +7705,8 @@ spec:
separator)
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
debug:
@@ -7305,9 +7735,9 @@ spec:
type: string
type: array
printCommand:
- description: |-
- Prints the command used the start the JVM in the container logs (default `true`)
- Deprecated: no longer in use.
+ description: 'Prints the command used the start the JVM
+ in the container logs (default `true`) Deprecated: no
+ longer in use.'
type: boolean
type: object
kamelets:
@@ -7318,9 +7748,8 @@ spec:
and their default configuration (enabled by default)
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7353,16 +7782,16 @@ spec:
description: Enable automatic discovery of all trait properties.
type: boolean
channelSinks:
- description: |-
- List of channels used as destination of integration routes.
- Can contain simple channel names or full Camel URIs.
+ description: List of channels used as destination of integration
+ routes. Can contain simple channel names or full Camel
+ URIs.
items:
type: string
type: array
channelSources:
- description: |-
- List of channels used as source of integration routes.
- Can contain simple channel names or full Camel URIs.
+ description: List of channels used as source of integration
+ routes. Can contain simple channel names or full Camel
+ URIs.
items:
type: string
type: array
@@ -7371,9 +7800,8 @@ spec:
configuration in JSON format.
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7381,9 +7809,9 @@ spec:
All traits share this common property.
type: boolean
endpointSinks:
- description: |-
- List of endpoints used as destination of integration routes.
- Can contain simple endpoint names or full Camel URIs.
+ description: List of endpoints used as destination of
+ integration routes. Can contain simple endpoint names
+ or full Camel URIs.
items:
type: string
type: array
@@ -7394,49 +7822,56 @@ spec:
type: string
type: array
eventSinks:
- description: |-
- List of event types that the integration will produce.
- Can contain simple event types or full Camel URIs (to use a specific broker).
+ description: List of event types that the integration
+ will produce. Can contain simple event types or full
+ Camel URIs (to use a specific broker).
items:
type: string
type: array
eventSources:
- description: |-
- List of event types that the integration will be subscribed to.
- Can contain simple event types or full Camel URIs (to use a specific broker different from "default").
+ description: List of event types that the integration
+ will be subscribed to. Can contain simple event types
+ or full Camel URIs (to use a specific broker different
+ from "default").
items:
type: string
type: array
filterEventType:
- description: |-
- Enables the default filtering for the Knative trigger using the event type
- If this is true, the created Knative trigger uses the event type as a filter on the event stream when no other filter criteria is given. (default: true)
+ description: 'Enables the default filtering for the Knative
+ trigger using the event type If this is true, the created
+ Knative trigger uses the event type as a filter on the
+ event stream when no other filter criteria is given.
+ (default: true)'
type: boolean
filterSourceChannels:
- description: |-
- Enables filtering on events based on the header "ce-knativehistory". Since this header has been removed in newer versions of
- Knative, filtering is disabled by default.
+ description: Enables filtering on events based on the
+ header "ce-knativehistory". Since this header has been
+ removed in newer versions of Knative, filtering is disabled
+ by default.
type: boolean
filters:
- description: |-
- Sets filter attributes on the event stream (such as event type, source, subject and so on).
- A list of key-value pairs that represent filter attributes and its values.
- The syntax is KEY=VALUE, e.g., `source="my.source"`.
- Filter attributes get set on the Knative trigger that is being created as part of this integration.
+ description: Sets filter attributes on the event stream
+ (such as event type, source, subject and so on). A list
+ of key-value pairs that represent filter attributes
+ and its values. The syntax is KEY=VALUE, e.g., `source="my.source"`.
+ Filter attributes get set on the Knative trigger that
+ is being created as part of this integration.
items:
type: string
type: array
namespaceLabel:
- description: |-
- Enables the camel-k-operator to set the "bindings.knative.dev/include=true" label to the namespace
- As Knative requires this label to perform injection of K_SINK URL into the service.
- If this is false, the integration pod may start and fail, read the SinkBinding Knative documentation. (default: true)
+ description: 'Enables the camel-k-operator to set the
+ "bindings.knative.dev/include=true" label to the namespace
+ As Knative requires this label to perform injection
+ of K_SINK URL into the service. If this is false, the
+ integration pod may start and fail, read the SinkBinding
+ Knative documentation. (default: true)'
type: boolean
sinkBinding:
- description: |-
- Allows binding the integration to a sink via a Knative SinkBinding resource.
- This can be used when the integration targets a single sink.
- It's enabled by default when the integration targets a single sink
+ description: Allows binding the integration to a sink
+ via a Knative SinkBinding resource. This can be used
+ when the integration targets a single sink. It's enabled
+ by default when the integration targets a single sink
(except when the integration is owned by a Knative source).
type: boolean
type: object
@@ -7446,47 +7881,41 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to route.
- This can be used to set knative service specific annotations
- CLI usage example: -t "knative-service.annotations.'haproxy.router.openshift.io/balance'=true"
+ description: 'The annotations added to route. This can
+ be used to set knative service specific annotations
+ CLI usage example: -t "knative-service.annotations.''haproxy.router.openshift.io/balance''=true"'
type: object
auto:
- description: |-
- Automatically deploy the integration as Knative service when all conditions hold:
-
-
- * Integration is using the Knative profile
- * All routes are either starting from an HTTP based consumer or a passive consumer (e.g. `direct` is a passive consumer)
+ description: "Automatically deploy the integration as
+ Knative service when all conditions hold: \n * Integration
+ is using the Knative profile * All routes are either
+ starting from an HTTP based consumer or a passive consumer
+ (e.g. `direct` is a passive consumer)"
type: boolean
autoscalingMetric:
- description: |-
- Configures the Knative autoscaling metric property (e.g. to set `concurrency` based or `cpu` based autoscaling).
-
-
- Refer to the Knative documentation for more information.
+ description: "Configures the Knative autoscaling metric
+ property (e.g. to set `concurrency` based or `cpu` based
+ autoscaling). \n Refer to the Knative documentation
+ for more information."
type: string
autoscalingTarget:
- description: |-
- Sets the allowed concurrency level or CPU percentage (depending on the autoscaling metric) for each Pod.
-
-
- Refer to the Knative documentation for more information.
+ description: "Sets the allowed concurrency level or CPU
+ percentage (depending on the autoscaling metric) for
+ each Pod. \n Refer to the Knative documentation for
+ more information."
type: integer
class:
- description: |-
- Configures the Knative autoscaling class property (e.g. to set `hpa.autoscaling.knative.dev` or `kpa.autoscaling.knative.dev` autoscaling).
-
-
- Refer to the Knative documentation for more information.
+ description: "Configures the Knative autoscaling class
+ property (e.g. to set `hpa.autoscaling.knative.dev`
+ or `kpa.autoscaling.knative.dev` autoscaling). \n Refer
+ to the Knative documentation for more information."
enum:
- kpa.autoscaling.knative.dev
- hpa.autoscaling.knative.dev
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7494,43 +7923,38 @@ spec:
All traits share this common property.
type: boolean
maxScale:
- description: |-
- An upper bound for the number of Pods that can be running in parallel for the integration.
- Knative has its own cap value that depends on the installation.
-
-
- Refer to the Knative documentation for more information.
+ description: "An upper bound for the number of Pods that
+ can be running in parallel for the integration. Knative
+ has its own cap value that depends on the installation.
+ \n Refer to the Knative documentation for more information."
type: integer
minScale:
- description: |-
- The minimum number of Pods that should be running at any time for the integration. It's **zero** by default, meaning that
- the integration is scaled down to zero when not used for a configured amount of time.
-
-
- Refer to the Knative documentation for more information.
+ description: "The minimum number of Pods that should be
+ running at any time for the integration. It's **zero**
+ by default, meaning that the integration is scaled down
+ to zero when not used for a configured amount of time.
+ \n Refer to the Knative documentation for more information."
type: integer
rolloutDuration:
- description: |-
- Enables to gradually shift traffic to the latest Revision and sets the rollout duration.
- It's disabled by default and must be expressed as a Golang `time.Duration` string representation,
- rounded to a second precision.
+ description: Enables to gradually shift traffic to the
+ latest Revision and sets the rollout duration. It's
+ disabled by default and must be expressed as a Golang
+ `time.Duration` string representation, rounded to a
+ second precision.
type: string
timeoutSeconds:
- description: |-
- The maximum duration in seconds that the request instance is allowed to respond to a request.
+ description: "The maximum duration in seconds that the
+ request instance is allowed to respond to a request.
This field propagates to the integration pod's terminationGracePeriodSeconds
-
-
- Refer to the Knative documentation for more information.
+ \n Refer to the Knative documentation for more information."
format: int64
type: integer
visibility:
- description: |-
- Setting `cluster-local`, Knative service becomes a private service.
- Specifically, this option applies the `networking.knative.dev/visibility` label to Knative service.
-
-
- Refer to the Knative documentation for more information.
+ description: "Setting `cluster-local`, Knative service
+ becomes a private service. Specifically, this option
+ applies the `networking.knative.dev/visibility` label
+ to Knative service. \n Refer to the Knative documentation
+ for more information."
enum:
- cluster-local
type: string
@@ -7542,9 +7966,8 @@ spec:
description: Colorize the log output
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7584,18 +8007,20 @@ spec:
description: The configuration of Mount trait
properties:
configs:
- description: |-
- A list of configuration pointing to configmap/secret.
- The configuration are expected to be UTF-8 resources as they are processed by runtime Camel Context and tried to be parsed as property files.
- They are also made available on the classpath in order to ease their usage directly from the Route.
- Syntax: [configmap|secret]:name[/key], where name represents the resource name and key optionally represents the resource key to be filtered
+ description: 'A list of configuration pointing to configmap/secret.
+ The configuration are expected to be UTF-8 resources
+ as they are processed by runtime Camel Context and tried
+ to be parsed as property files. They are also made available
+ on the classpath in order to ease their usage directly
+ from the Route. Syntax: [configmap|secret]:name[/key],
+ where name represents the resource name and key optionally
+ represents the resource key to be filtered'
items:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
emptyDirs:
@@ -7608,17 +8033,21 @@ spec:
description: 'Deprecated: no longer in use.'
type: boolean
hotReload:
- description: |-
- Enable "hot reload" when a secret/configmap mounted is edited (default `false`). The configmap/secret must be
- marked with `camel.apache.org/integration` label to be taken in account. The resource will be watched for any kind change, also for
- changes in metadata.
+ description: Enable "hot reload" when a secret/configmap
+ mounted is edited (default `false`). The configmap/secret
+ must be marked with `camel.apache.org/integration` label
+ to be taken in account. The resource will be watched
+ for any kind change, also for changes in metadata.
type: boolean
resources:
- description: |-
- A list of resources (text or binary content) pointing to configmap/secret.
- The resources are expected to be any resource type (text or binary content).
- The destination path can be either a default location or any path specified by the user.
- Syntax: [configmap|secret]:name[/key][@path], where name represents the resource name, key optionally represents the resource key to be filtered and path represents the destination path
+ description: 'A list of resources (text or binary content)
+ pointing to configmap/secret. The resources are expected
+ to be any resource type (text or binary content). The
+ destination path can be either a default location or
+ any path specified by the user. Syntax: [configmap|secret]:name[/key][@path],
+ where name represents the resource name, key optionally
+ represents the resource key to be filtered and path
+ represents the destination path'
items:
type: string
type: array
@@ -7643,9 +8072,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7656,9 +8084,8 @@ spec:
description: The configuration of Owner trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7680,9 +8107,8 @@ spec:
description: The configuration of PDB trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7690,53 +8116,56 @@ spec:
All traits share this common property.
type: boolean
maxUnavailable:
- description: |-
- The number of pods for the Integration that can be unavailable after an eviction.
- It can be either an absolute number or a percentage (default `1` if `min-available` is also not set).
- Only one of `max-unavailable` and `min-available` can be specified.
+ description: The number of pods for the Integration that
+ can be unavailable after an eviction. It can be either
+ an absolute number or a percentage (default `1` if `min-available`
+ is also not set). Only one of `max-unavailable` and
+ `min-available` can be specified.
type: string
minAvailable:
- description: |-
- The number of pods for the Integration that must still be available after an eviction.
- It can be either an absolute number or a percentage.
- Only one of `min-available` and `max-unavailable` can be specified.
+ description: The number of pods for the Integration that
+ must still be available after an eviction. It can be
+ either an absolute number or a percentage. Only one
+ of `min-available` and `max-unavailable` can be specified.
type: string
type: object
platform:
description: The configuration of Platform trait
properties:
auto:
- description: |-
- To automatically detect from the environment if a default platform can be created (it will be created on OpenShift or when a registry address is set).
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'To automatically detect from the environment
+ if a default platform can be created (it will be created
+ on OpenShift or when a registry address is set). Deprecated:
+ Platform is auto generated by the operator install procedure
+ - maintained for backward compatibility'
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
createDefault:
- description: |-
- To create a default (empty) platform when the platform is missing.
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'To create a default (empty) platform when
+ the platform is missing. Deprecated: Platform is auto
+ generated by the operator install procedure - maintained
+ for backward compatibility'
type: boolean
enabled:
description: 'Deprecated: no longer in use.'
type: boolean
global:
- description: |-
- Indicates if the platform should be created globally in the case of global operator (default true).
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'Indicates if the platform should be created
+ globally in the case of global operator (default true).
+ Deprecated: Platform is auto generated by the operator
+ install procedure - maintained for backward compatibility'
type: boolean
type: object
pod:
description: The configuration of Pod trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7748,9 +8177,8 @@ spec:
description: The configuration of Prometheus trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7776,9 +8204,8 @@ spec:
secret on the pod if it is of type `kubernetes.io/dockerconfigjson`.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7801,10 +8228,11 @@ spec:
description: The configuration of Quarkus trait
properties:
buildMode:
- description: |-
- The Quarkus mode to run: either `jvm` or `native` (default `jvm`).
- In case both `jvm` and `native` are specified, two `IntegrationKit` resources are created,
- with the `native` kit having precedence over the `jvm` one once ready.
+ description: 'The Quarkus mode to run: either `jvm` or
+ `native` (default `jvm`). In case both `jvm` and `native`
+ are specified, two `IntegrationKit` resources are created,
+ with the `native` kit having precedence over the `jvm`
+ one once ready.'
items:
description: QuarkusMode is the type of Quarkus build
packaging.
@@ -7814,9 +8242,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7832,18 +8259,19 @@ spec:
in the runtime catalog)
type: string
packageTypes:
- description: |-
- The Quarkus package types, `fast-jar` or `native` (default `fast-jar`).
- In case both `fast-jar` and `native` are specified, two `IntegrationKit` resources are created,
- with the native kit having precedence over the `fast-jar` one once ready.
- The order influences the resolution of the current kit for the integration.
- The kit corresponding to the first package type will be assigned to the
- integration in case no existing kit that matches the integration exists.
- Deprecated: use `build-mode` instead.
+ description: 'The Quarkus package types, `fast-jar` or
+ `native` (default `fast-jar`). In case both `fast-jar`
+ and `native` are specified, two `IntegrationKit` resources
+ are created, with the native kit having precedence over
+ the `fast-jar` one once ready. The order influences
+ the resolution of the current kit for the integration.
+ The kit corresponding to the first package type will
+ be assigned to the integration in case no existing kit
+ that matches the integration exists. Deprecated: use
+ `build-mode` instead.'
items:
- description: |-
- QuarkusPackageType is the type of Quarkus build packaging.
- Deprecated: use `QuarkusMode` instead.
+ description: 'QuarkusPackageType is the type of Quarkus
+ build packaging. Deprecated: use `QuarkusMode` instead.'
enum:
- fast-jar
- native
@@ -7851,14 +8279,13 @@ spec:
type: array
type: object
registry:
- description: |-
- The configuration of Registry trait (support removed since version 2.5.0).
- Deprecated: use jvm trait or read documentation.
+ description: 'The configuration of Registry trait (support
+ removed since version 2.5.0). Deprecated: use jvm trait
+ or read documentation.'
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7872,16 +8299,14 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to route.
- This can be used to set route specific annotations
- For annotations options see https://docs.openshift.com/container-platform/3.11/architecture/networking/routes.html#route-specific-annotations
- CLI usage example: -t "route.annotations.'haproxy.router.openshift.io/balance'=true"
+ description: 'The annotations added to route. This can
+ be used to set route specific annotations For annotations
+ options see https://docs.openshift.com/container-platform/3.11/architecture/networking/routes.html#route-specific-annotations
+ CLI usage example: -t "route.annotations.''haproxy.router.openshift.io/balance''=true"'
type: object
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7892,82 +8317,82 @@ spec:
description: To configure the host exposed by the route.
type: string
tlsCACertificate:
- description: |-
- The TLS CA certificate contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS CA certificate contents. \n Refer
+ to the OpenShift route documentation for additional
+ information."
type: string
tlsCACertificateSecret:
- description: |-
- The secret name and key reference to the TLS CA certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the
+ TLS CA certificate. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only
+ one key in the secret it will be read, otherwise you
+ can set a key name separated with a \"/\". \n Refer
+ to the OpenShift route documentation for additional
+ information."
type: string
tlsCertificate:
- description: |-
- The TLS certificate contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS certificate contents. \n Refer to
+ the OpenShift route documentation for additional information."
type: string
tlsCertificateSecret:
- description: |-
- The secret name and key reference to the TLS certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the
+ TLS certificate. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only
+ one key in the secret it will be read, otherwise you
+ can set a key name separated with a \"/\". \n Refer
+ to the OpenShift route documentation for additional
+ information."
type: string
tlsDestinationCACertificate:
- description: |-
- The destination CA certificate provides the contents of the ca certificate of the final destination. When using reencrypt
- termination this file should be provided in order to have routers use it for health checks on the secure connection.
- If this field is not specified, the router may provide its own destination CA and perform hostname validation using
- the short service name (service.namespace.svc), which allows infrastructure generated certificates to automatically
- verify.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The destination CA certificate provides
+ the contents of the ca certificate of the final destination.
+ \ When using reencrypt termination this file should
+ be provided in order to have routers use it for health
+ checks on the secure connection. If this field is not
+ specified, the router may provide its own destination
+ CA and perform hostname validation using the short service
+ name (service.namespace.svc), which allows infrastructure
+ generated certificates to automatically verify. \n Refer
+ to the OpenShift route documentation for additional
+ information."
type: string
tlsDestinationCACertificateSecret:
- description: |-
- The secret name and key reference to the destination CA certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the
+ destination CA certificate. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only
+ one key in the secret it will be read, otherwise you
+ can set a key name separated with a \"/\". \n Refer
+ to the OpenShift route documentation for additional
+ information."
type: string
tlsInsecureEdgeTerminationPolicy:
- description: |-
- To configure how to deal with insecure traffic, e.g. `Allow`, `Disable` or `Redirect` traffic.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "To configure how to deal with insecure traffic,
+ e.g. `Allow`, `Disable` or `Redirect` traffic. \n Refer
+ to the OpenShift route documentation for additional
+ information."
enum:
- None
- Allow
- Redirect
type: string
tlsKey:
- description: |-
- The TLS certificate key contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS certificate key contents. \n Refer
+ to the OpenShift route documentation for additional
+ information."
type: string
tlsKeySecret:
- description: |-
- The secret name and key reference to the TLS certificate key. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the
+ TLS certificate key. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only
+ one key in the secret it will be read, otherwise you
+ can set a key name separated with a \"/\". \n Refer
+ to the OpenShift route documentation for additional
+ information."
type: string
tlsTermination:
- description: |-
- The TLS termination type, like `edge`, `passthrough` or `reencrypt`.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS termination type, like `edge`, `passthrough`
+ or `reencrypt`. \n Refer to the OpenShift route documentation
+ for additional information."
enum:
- edge
- reencrypt
@@ -7978,9 +8403,8 @@ spec:
description: The configuration of Security Context trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -8012,9 +8436,8 @@ spec:
a Service needs to be created.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -8022,9 +8445,8 @@ spec:
All traits share this common property.
type: boolean
nodePort:
- description: |-
- Enable Service to be exposed as NodePort (default `false`).
- Deprecated: Use service type instead.
+ description: 'Enable Service to be exposed as NodePort
+ (default `false`). Deprecated: Use service type instead.'
type: boolean
type:
description: The type of service to be used, either 'ClusterIP',
@@ -8039,9 +8461,8 @@ spec:
description: The configuration of Service Binding trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -8068,9 +8489,8 @@ spec:
description: The configuration of Toleration trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -8135,48 +8555,39 @@ spec:
description: API version of the referent.
type: string
fieldPath:
- description: |-
- If referring to a piece of an object instead of an entire object, this string
- should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
- For example, if the object reference is to a container within a pod, this would take on a value like:
- "spec.containers{name}" (where "name" refers to the name of the container that triggered
- the event) or if no container name is specified "spec.containers[2]" (container with
- index 2 in this pod). This syntax is chosen only to have some well-defined way of
- referencing a part of an object.
- TODO: this design is not final and this field is subject to change in the future.
+ description: 'If referring to a piece of an object instead
+ of an entire object, this string should contain a valid
+ JSON/Go field access statement, such as desiredState.manifest.containers[2].
+ For example, if the object reference is to a container within
+ a pod, this would take on a value like: "spec.containers{name}"
+ (where "name" refers to the name of the container that triggered
+ the event) or if no container name is specified "spec.containers[2]"
+ (container with index 2 in this pod). This syntax is chosen
+ only to have some well-defined way of referencing a part
+ of an object. TODO: this design is not final and this field
+ is subject to change in the future.'
type: string
kind:
- description: |-
- Kind of the referent.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ 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: 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'
type: string
namespace:
- description: |-
- Namespace of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
+ description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type: string
resourceVersion:
- description: |-
- Specific resourceVersion to which this reference is made, if any.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
+ description: 'Specific resourceVersion to which this reference
+ is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
type: string
uid:
- description: |-
- UID of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
+ description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
type: string
type: object
- x-kubernetes-map-type: atomic
types:
additionalProperties:
- description: |-
- EventTypeSpec represents a specification for an event type.
- Deprecated: In favor of using DataTypeSpec.
+ description: 'EventTypeSpec represents a specification for an
+ event type. Deprecated: In favor of using DataTypeSpec.'
properties:
mediaType:
description: media type as expected for HTTP media types
@@ -8191,9 +8602,9 @@ spec:
description:
type: string
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value.
+ These types are supported: bool, int64, float64, string,
+ []interface{}, map[string]interface{} and nil.'
x-kubernetes-preserve-unknown-fields: true
externalDocs:
description: ExternalDocumentation allows referencing
@@ -8219,49 +8630,64 @@ spec:
type: string
enum:
items:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON
+ value. These types are supported: bool, int64,
+ float64, string, []interface{}, map[string]interface{}
+ and nil.'
x-kubernetes-preserve-unknown-fields: true
type: array
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value.
+ These types are supported: bool, int64, float64,
+ string, []interface{}, map[string]interface{}
+ and nil.'
x-kubernetes-preserve-unknown-fields: true
exclusiveMaximum:
type: boolean
exclusiveMinimum:
type: boolean
format:
- description: |-
- format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:
-
-
- - bsonobjectid: a bson object ID, i.e. a 24 characters hex string
- - uri: an URI as parsed by Golang net/url.ParseRequestURI
- - email: an email address as parsed by Golang net/mail.ParseAddress
- - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034].
- - ipv4: an IPv4 IP as parsed by Golang net.ParseIP
- - ipv6: an IPv6 IP as parsed by Golang net.ParseIP
- - cidr: a CIDR as parsed by Golang net.ParseCIDR
- - mac: a MAC address as parsed by Golang net.ParseMAC
- - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041"
- - isbn10: an ISBN10 number string like "0321751043"
- - isbn13: an ISBN13 number string like "978-0321751041"
- - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\d{3})\\d{11})$ with any non digit characters mixed in
- - ssn: a U.S. social security number following the regex ^\\d{3}[- ]?\\d{2}[- ]?\\d{4}$
- - hexcolor: an hexadecimal color code like "#FFFFFF" following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
- - rgbcolor: an RGB color code like rgb like "rgb(255,255,255)"
- - byte: base64 encoded binary data
- - password: any kind of string
- - date: a date string like "2006-01-02" as defined by full-date in RFC3339
- - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format
- - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339.
+ description: "format is an OpenAPI v3 format string.
+ Unknown formats are ignored. The following formats
+ are validated: \n - bsonobjectid: a bson object
+ ID, i.e. a 24 characters hex string - uri: an
+ URI as parsed by Golang net/url.ParseRequestURI
+ - email: an email address as parsed by Golang
+ net/mail.ParseAddress - hostname: a valid representation
+ for an Internet host name, as defined by RFC
+ 1034, section 3.1 [RFC1034]. - ipv4: an IPv4
+ IP as parsed by Golang net.ParseIP - ipv6: an
+ IPv6 IP as parsed by Golang net.ParseIP - cidr:
+ a CIDR as parsed by Golang net.ParseCIDR - mac:
+ a MAC address as parsed by Golang net.ParseMAC
+ - uuid: an UUID that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid3: an UUID3 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid4: an UUID4 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - uuid5: an UUID5 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - isbn: an ISBN10 or ISBN13 number string like
+ \"0321751043\" or \"978-0321751041\" - isbn10:
+ an ISBN10 number string like \"0321751043\"
+ - isbn13: an ISBN13 number string like \"978-0321751041\"
+ - creditcard: a credit card number defined by
+ the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\\\d{3})\\\\d{11})$
+ with any non digit characters mixed in - ssn:
+ a U.S. social security number following the
+ regex ^\\\\d{3}[- ]?\\\\d{2}[- ]?\\\\d{4}$ -
+ hexcolor: an hexadecimal color code like \"#FFFFFF\"
+ following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
+ - rgbcolor: an RGB color code like rgb like
+ \"rgb(255,255,255)\" - byte: base64 encoded
+ binary data - password: any kind of string -
+ date: a date string like \"2006-01-02\" as defined
+ by full-date in RFC3339 - duration: a duration
+ string like \"22 ns\" as parsed by Golang time.ParseDuration
+ or compatible with Scala duration format - datetime:
+ a date time string like \"2014-12-15T19:30:20.000Z\"
+ as defined by date-time in RFC3339."
type: string
id:
type: string
@@ -8324,9 +8750,9 @@ spec:
type: string
type: object
type: object
- description: |-
- Types defines the data type of the data produced/consumed by the endpoint and references a given data type specification.
- Deprecated: In favor of using DataTypes
+ description: 'Types defines the data type of the data produced/consumed
+ by the endpoint and references a given data type specification.
+ Deprecated: In favor of using DataTypes'
type: object
uri:
description: URI can be used to specify the (Camel) endpoint explicitly
@@ -8364,48 +8790,39 @@ spec:
description: API version of the referent.
type: string
fieldPath:
- description: |-
- If referring to a piece of an object instead of an entire object, this string
- should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
- For example, if the object reference is to a container within a pod, this would take on a value like:
- "spec.containers{name}" (where "name" refers to the name of the container that triggered
- the event) or if no container name is specified "spec.containers[2]" (container with
- index 2 in this pod). This syntax is chosen only to have some well-defined way of
- referencing a part of an object.
- TODO: this design is not final and this field is subject to change in the future.
+ description: 'If referring to a piece of an object instead
+ of an entire object, this string should contain a valid
+ JSON/Go field access statement, such as desiredState.manifest.containers[2].
+ For example, if the object reference is to a container within
+ a pod, this would take on a value like: "spec.containers{name}"
+ (where "name" refers to the name of the container that triggered
+ the event) or if no container name is specified "spec.containers[2]"
+ (container with index 2 in this pod). This syntax is chosen
+ only to have some well-defined way of referencing a part
+ of an object. TODO: this design is not final and this field
+ is subject to change in the future.'
type: string
kind:
- description: |-
- Kind of the referent.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ 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: 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'
type: string
namespace:
- description: |-
- Namespace of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
+ description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type: string
resourceVersion:
- description: |-
- Specific resourceVersion to which this reference is made, if any.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
+ description: 'Specific resourceVersion to which this reference
+ is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
type: string
uid:
- description: |-
- UID of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
+ description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
type: string
type: object
- x-kubernetes-map-type: atomic
types:
additionalProperties:
- description: |-
- EventTypeSpec represents a specification for an event type.
- Deprecated: In favor of using DataTypeSpec.
+ description: 'EventTypeSpec represents a specification for an
+ event type. Deprecated: In favor of using DataTypeSpec.'
properties:
mediaType:
description: media type as expected for HTTP media types
@@ -8420,9 +8837,9 @@ spec:
description:
type: string
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value.
+ These types are supported: bool, int64, float64, string,
+ []interface{}, map[string]interface{} and nil.'
x-kubernetes-preserve-unknown-fields: true
externalDocs:
description: ExternalDocumentation allows referencing
@@ -8448,49 +8865,64 @@ spec:
type: string
enum:
items:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON
+ value. These types are supported: bool, int64,
+ float64, string, []interface{}, map[string]interface{}
+ and nil.'
x-kubernetes-preserve-unknown-fields: true
type: array
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value.
+ These types are supported: bool, int64, float64,
+ string, []interface{}, map[string]interface{}
+ and nil.'
x-kubernetes-preserve-unknown-fields: true
exclusiveMaximum:
type: boolean
exclusiveMinimum:
type: boolean
format:
- description: |-
- format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:
-
-
- - bsonobjectid: a bson object ID, i.e. a 24 characters hex string
- - uri: an URI as parsed by Golang net/url.ParseRequestURI
- - email: an email address as parsed by Golang net/mail.ParseAddress
- - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034].
- - ipv4: an IPv4 IP as parsed by Golang net.ParseIP
- - ipv6: an IPv6 IP as parsed by Golang net.ParseIP
- - cidr: a CIDR as parsed by Golang net.ParseCIDR
- - mac: a MAC address as parsed by Golang net.ParseMAC
- - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041"
- - isbn10: an ISBN10 number string like "0321751043"
- - isbn13: an ISBN13 number string like "978-0321751041"
- - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\d{3})\\d{11})$ with any non digit characters mixed in
- - ssn: a U.S. social security number following the regex ^\\d{3}[- ]?\\d{2}[- ]?\\d{4}$
- - hexcolor: an hexadecimal color code like "#FFFFFF" following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
- - rgbcolor: an RGB color code like rgb like "rgb(255,255,255)"
- - byte: base64 encoded binary data
- - password: any kind of string
- - date: a date string like "2006-01-02" as defined by full-date in RFC3339
- - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format
- - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339.
+ description: "format is an OpenAPI v3 format string.
+ Unknown formats are ignored. The following formats
+ are validated: \n - bsonobjectid: a bson object
+ ID, i.e. a 24 characters hex string - uri: an
+ URI as parsed by Golang net/url.ParseRequestURI
+ - email: an email address as parsed by Golang
+ net/mail.ParseAddress - hostname: a valid representation
+ for an Internet host name, as defined by RFC
+ 1034, section 3.1 [RFC1034]. - ipv4: an IPv4
+ IP as parsed by Golang net.ParseIP - ipv6: an
+ IPv6 IP as parsed by Golang net.ParseIP - cidr:
+ a CIDR as parsed by Golang net.ParseCIDR - mac:
+ a MAC address as parsed by Golang net.ParseMAC
+ - uuid: an UUID that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid3: an UUID3 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid4: an UUID4 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - uuid5: an UUID5 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - isbn: an ISBN10 or ISBN13 number string like
+ \"0321751043\" or \"978-0321751041\" - isbn10:
+ an ISBN10 number string like \"0321751043\"
+ - isbn13: an ISBN13 number string like \"978-0321751041\"
+ - creditcard: a credit card number defined by
+ the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\\\d{3})\\\\d{11})$
+ with any non digit characters mixed in - ssn:
+ a U.S. social security number following the
+ regex ^\\\\d{3}[- ]?\\\\d{2}[- ]?\\\\d{4}$ -
+ hexcolor: an hexadecimal color code like \"#FFFFFF\"
+ following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
+ - rgbcolor: an RGB color code like rgb like
+ \"rgb(255,255,255)\" - byte: base64 encoded
+ binary data - password: any kind of string -
+ date: a date string like \"2006-01-02\" as defined
+ by full-date in RFC3339 - duration: a duration
+ string like \"22 ns\" as parsed by Golang time.ParseDuration
+ or compatible with Scala duration format - datetime:
+ a date time string like \"2014-12-15T19:30:20.000Z\"
+ as defined by date-time in RFC3339."
type: string
id:
type: string
@@ -8553,9 +8985,9 @@ spec:
type: string
type: object
type: object
- description: |-
- Types defines the data type of the data produced/consumed by the endpoint and references a given data type specification.
- Deprecated: In favor of using DataTypes
+ description: 'Types defines the data type of the data produced/consumed
+ by the endpoint and references a given data type specification.
+ Deprecated: In favor of using DataTypes'
type: object
uri:
description: URI can be used to specify the (Camel) endpoint explicitly
@@ -8596,48 +9028,40 @@ spec:
description: API version of the referent.
type: string
fieldPath:
- description: |-
- If referring to a piece of an object instead of an entire object, this string
- should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
- For example, if the object reference is to a container within a pod, this would take on a value like:
- "spec.containers{name}" (where "name" refers to the name of the container that triggered
- the event) or if no container name is specified "spec.containers[2]" (container with
- index 2 in this pod). This syntax is chosen only to have some well-defined way of
- referencing a part of an object.
- TODO: this design is not final and this field is subject to change in the future.
+ description: 'If referring to a piece of an object instead
+ of an entire object, this string should contain a valid
+ JSON/Go field access statement, such as desiredState.manifest.containers[2].
+ For example, if the object reference is to a container
+ within a pod, this would take on a value like: "spec.containers{name}"
+ (where "name" refers to the name of the container that
+ triggered the event) or if no container name is specified
+ "spec.containers[2]" (container with index 2 in this pod).
+ This syntax is chosen only to have some well-defined way
+ of referencing a part of an object. TODO: this design
+ is not final and this field is subject to change in the
+ future.'
type: string
kind:
- description: |-
- Kind of the referent.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ 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: 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'
type: string
namespace:
- description: |-
- Namespace of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
+ description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type: string
resourceVersion:
- description: |-
- Specific resourceVersion to which this reference is made, if any.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
+ description: 'Specific resourceVersion to which this reference
+ is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
type: string
uid:
- description: |-
- UID of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
+ description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
type: string
type: object
- x-kubernetes-map-type: atomic
types:
additionalProperties:
- description: |-
- EventTypeSpec represents a specification for an event type.
- Deprecated: In favor of using DataTypeSpec.
+ description: 'EventTypeSpec represents a specification for
+ an event type. Deprecated: In favor of using DataTypeSpec.'
properties:
mediaType:
description: media type as expected for HTTP media types
@@ -8652,9 +9076,10 @@ spec:
description:
type: string
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value.
+ These types are supported: bool, int64, float64,
+ string, []interface{}, map[string]interface{} and
+ nil.'
x-kubernetes-preserve-unknown-fields: true
externalDocs:
description: ExternalDocumentation allows referencing
@@ -8680,49 +9105,65 @@ spec:
type: string
enum:
items:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON
+ value. These types are supported: bool,
+ int64, float64, string, []interface{}, map[string]interface{}
+ and nil.'
x-kubernetes-preserve-unknown-fields: true
type: array
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON
+ value. These types are supported: bool, int64,
+ float64, string, []interface{}, map[string]interface{}
+ and nil.'
x-kubernetes-preserve-unknown-fields: true
exclusiveMaximum:
type: boolean
exclusiveMinimum:
type: boolean
format:
- description: |-
- format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:
-
-
- - bsonobjectid: a bson object ID, i.e. a 24 characters hex string
- - uri: an URI as parsed by Golang net/url.ParseRequestURI
- - email: an email address as parsed by Golang net/mail.ParseAddress
- - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034].
+ description: "format is an OpenAPI v3 format
+ string. Unknown formats are ignored. The following
+ formats are validated: \n - bsonobjectid:
+ a bson object ID, i.e. a 24 characters hex
+ string - uri: an URI as parsed by Golang net/url.ParseRequestURI
+ - email: an email address as parsed by Golang
+ net/mail.ParseAddress - hostname: a valid
+ representation for an Internet host name,
+ as defined by RFC 1034, section 3.1 [RFC1034].
- ipv4: an IPv4 IP as parsed by Golang net.ParseIP
- ipv6: an IPv6 IP as parsed by Golang net.ParseIP
- cidr: a CIDR as parsed by Golang net.ParseCIDR
- mac: a MAC address as parsed by Golang net.ParseMAC
- - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041"
- - isbn10: an ISBN10 number string like "0321751043"
- - isbn13: an ISBN13 number string like "978-0321751041"
- - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\d{3})\\d{11})$ with any non digit characters mixed in
- - ssn: a U.S. social security number following the regex ^\\d{3}[- ]?\\d{2}[- ]?\\d{4}$
- - hexcolor: an hexadecimal color code like "#FFFFFF" following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
- - rgbcolor: an RGB color code like rgb like "rgb(255,255,255)"
- - byte: base64 encoded binary data
- - password: any kind of string
- - date: a date string like "2006-01-02" as defined by full-date in RFC3339
- - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format
- - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339.
+ - uuid: an UUID that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid3: an UUID3 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid4: an UUID4 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - uuid5: an UUID5 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - isbn: an ISBN10 or ISBN13 number string
+ like \"0321751043\" or \"978-0321751041\"
+ - isbn10: an ISBN10 number string like \"0321751043\"
+ - isbn13: an ISBN13 number string like \"978-0321751041\"
+ - creditcard: a credit card number defined
+ by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\\\d{3})\\\\d{11})$
+ with any non digit characters mixed in - ssn:
+ a U.S. social security number following the
+ regex ^\\\\d{3}[- ]?\\\\d{2}[- ]?\\\\d{4}$
+ - hexcolor: an hexadecimal color code like
+ \"#FFFFFF\" following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
+ - rgbcolor: an RGB color code like rgb like
+ \"rgb(255,255,255)\" - byte: base64 encoded
+ binary data - password: any kind of string
+ - date: a date string like \"2006-01-02\"
+ as defined by full-date in RFC3339 - duration:
+ a duration string like \"22 ns\" as parsed
+ by Golang time.ParseDuration or compatible
+ with Scala duration format - datetime: a date
+ time string like \"2014-12-15T19:30:20.000Z\"
+ as defined by date-time in RFC3339."
type: string
id:
type: string
@@ -8785,9 +9226,9 @@ spec:
type: string
type: object
type: object
- description: |-
- Types defines the data type of the data produced/consumed by the endpoint and references a given data type specification.
- Deprecated: In favor of using DataTypes
+ description: 'Types defines the data type of the data produced/consumed
+ by the endpoint and references a given data type specification.
+ Deprecated: In favor of using DataTypes'
type: object
uri:
description: URI can be used to specify the (Camel) endpoint
@@ -8845,15 +9286,12 @@ spec:
the condition's last transition.
type: string
status:
- description: |-
- Status is the status of the condition.
- Can be True, False, Unknown.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
+ description: 'Status is the status of the condition.
+ Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions'
type: string
type:
- description: |-
- Type is the type of the condition.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
+ description: 'Type is the type of the condition. More
+ info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions'
type: string
required:
- status
@@ -8863,10 +9301,10 @@ spec:
items:
properties:
data:
- description: |-
- RawMessage is a raw encoded JSON value.
+ description: RawMessage is a raw encoded JSON value.
It implements Marshaler and Unmarshaler and can
- be used to delay JSON decoding or precompute a JSON encoding.
+ be used to delay JSON decoding or precompute a
+ JSON encoding.
x-kubernetes-preserve-unknown-fields: true
name:
type: string
@@ -8919,3 +9357,9 @@ spec:
specReplicasPath: .spec.replicas
statusReplicasPath: .status.replicas
status: {}
+status:
+ acceptedNames:
+ kind: ""
+ plural: ""
+ conditions: []
+ storedVersions: []
diff --git a/pkg/resources/config/crd/bases/camel.apache.org_kamelets.yaml b/pkg/resources/config/crd/bases/camel.apache.org_kamelets.yaml
index c06419ae4b..9c62a7f091 100644
--- a/pkg/resources/config/crd/bases/camel.apache.org_kamelets.yaml
+++ b/pkg/resources/config/crd/bases/camel.apache.org_kamelets.yaml
@@ -15,12 +15,14 @@
# limitations under the License.
# ---------------------------------------------------------------------------
+
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
- controller-gen.kubebuilder.io/version: v0.15.0
+ controller-gen.kubebuilder.io/version: v0.6.1
+ creationTimestamp: null
name: kamelets.camel.apache.org
spec:
group: camel.apache.org
@@ -47,19 +49,14 @@ spec:
description: Kamelet is the Schema for the kamelets API.
properties:
apiVersion:
- description: |-
- APIVersion defines the versioned schema of this representation of an object.
- Servers should convert recognized schemas to the latest internal value, and
- may reject unrecognized values.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+ description: 'APIVersion defines the versioned schema of this representation
+ of an object. Servers should convert recognized schemas to the latest
+ internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: |-
- Kind is a string value representing the REST resource this object represents.
- Servers may infer this from the endpoint the client submits requests to.
- Cannot be updated.
- In CamelCase.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ description: 'Kind is a string value representing the REST resource this
+ object represents. Servers may infer this from the endpoint the client
+ submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
@@ -140,9 +137,10 @@ spec:
description:
type: string
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value.
+ These types are supported: bool, int64, float64,
+ string, []interface{}, map[string]interface{} and
+ nil.'
x-kubernetes-preserve-unknown-fields: true
externalDocs:
description: ExternalDocumentation allows referencing
@@ -168,49 +166,65 @@ spec:
type: string
enum:
items:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON
+ value. These types are supported: bool,
+ int64, float64, string, []interface{}, map[string]interface{}
+ and nil.'
x-kubernetes-preserve-unknown-fields: true
type: array
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON
+ value. These types are supported: bool, int64,
+ float64, string, []interface{}, map[string]interface{}
+ and nil.'
x-kubernetes-preserve-unknown-fields: true
exclusiveMaximum:
type: boolean
exclusiveMinimum:
type: boolean
format:
- description: |-
- format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:
-
-
- - bsonobjectid: a bson object ID, i.e. a 24 characters hex string
- - uri: an URI as parsed by Golang net/url.ParseRequestURI
- - email: an email address as parsed by Golang net/mail.ParseAddress
- - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034].
+ description: "format is an OpenAPI v3 format
+ string. Unknown formats are ignored. The following
+ formats are validated: \n - bsonobjectid:
+ a bson object ID, i.e. a 24 characters hex
+ string - uri: an URI as parsed by Golang net/url.ParseRequestURI
+ - email: an email address as parsed by Golang
+ net/mail.ParseAddress - hostname: a valid
+ representation for an Internet host name,
+ as defined by RFC 1034, section 3.1 [RFC1034].
- ipv4: an IPv4 IP as parsed by Golang net.ParseIP
- ipv6: an IPv6 IP as parsed by Golang net.ParseIP
- cidr: a CIDR as parsed by Golang net.ParseCIDR
- mac: a MAC address as parsed by Golang net.ParseMAC
- - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041"
- - isbn10: an ISBN10 number string like "0321751043"
- - isbn13: an ISBN13 number string like "978-0321751041"
- - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\d{3})\\d{11})$ with any non digit characters mixed in
- - ssn: a U.S. social security number following the regex ^\\d{3}[- ]?\\d{2}[- ]?\\d{4}$
- - hexcolor: an hexadecimal color code like "#FFFFFF" following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
- - rgbcolor: an RGB color code like rgb like "rgb(255,255,255)"
- - byte: base64 encoded binary data
- - password: any kind of string
- - date: a date string like "2006-01-02" as defined by full-date in RFC3339
- - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format
- - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339.
+ - uuid: an UUID that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid3: an UUID3 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid4: an UUID4 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - uuid5: an UUID5 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - isbn: an ISBN10 or ISBN13 number string
+ like \"0321751043\" or \"978-0321751041\"
+ - isbn10: an ISBN10 number string like \"0321751043\"
+ - isbn13: an ISBN13 number string like \"978-0321751041\"
+ - creditcard: a credit card number defined
+ by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\\\d{3})\\\\d{11})$
+ with any non digit characters mixed in - ssn:
+ a U.S. social security number following the
+ regex ^\\\\d{3}[- ]?\\\\d{2}[- ]?\\\\d{4}$
+ - hexcolor: an hexadecimal color code like
+ \"#FFFFFF\" following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
+ - rgbcolor: an RGB color code like rgb like
+ \"rgb(255,255,255)\" - byte: base64 encoded
+ binary data - password: any kind of string
+ - date: a date string like \"2006-01-02\"
+ as defined by full-date in RFC3339 - duration:
+ a duration string like \"22 ns\" as parsed
+ by Golang time.ParseDuration or compatible
+ with Scala duration format - datetime: a date
+ time string like \"2014-12-15T19:30:20.000Z\"
+ as defined by date-time in RFC3339."
type: string
id:
type: string
@@ -291,9 +305,9 @@ spec:
description:
type: string
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value. These types
+ are supported: bool, int64, float64, string, []interface{},
+ map[string]interface{} and nil.'
x-kubernetes-preserve-unknown-fields: true
externalDocs:
description: ExternalDocumentation allows referencing an external
@@ -319,49 +333,56 @@ spec:
type: string
enum:
items:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value. These
+ types are supported: bool, int64, float64, string, []interface{},
+ map[string]interface{} and nil.'
x-kubernetes-preserve-unknown-fields: true
type: array
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value. These
+ types are supported: bool, int64, float64, string, []interface{},
+ map[string]interface{} and nil.'
x-kubernetes-preserve-unknown-fields: true
exclusiveMaximum:
type: boolean
exclusiveMinimum:
type: boolean
format:
- description: |-
- format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:
-
-
- - bsonobjectid: a bson object ID, i.e. a 24 characters hex string
- - uri: an URI as parsed by Golang net/url.ParseRequestURI
+ description: "format is an OpenAPI v3 format string. Unknown
+ formats are ignored. The following formats are validated:
+ \n - bsonobjectid: a bson object ID, i.e. a 24 characters
+ hex string - uri: an URI as parsed by Golang net/url.ParseRequestURI
- email: an email address as parsed by Golang net/mail.ParseAddress
- - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034].
- - ipv4: an IPv4 IP as parsed by Golang net.ParseIP
- - ipv6: an IPv6 IP as parsed by Golang net.ParseIP
- - cidr: a CIDR as parsed by Golang net.ParseCIDR
- - mac: a MAC address as parsed by Golang net.ParseMAC
- - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041"
- - isbn10: an ISBN10 number string like "0321751043"
- - isbn13: an ISBN13 number string like "978-0321751041"
- - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\d{3})\\d{11})$ with any non digit characters mixed in
- - ssn: a U.S. social security number following the regex ^\\d{3}[- ]?\\d{2}[- ]?\\d{4}$
- - hexcolor: an hexadecimal color code like "#FFFFFF" following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
- - rgbcolor: an RGB color code like rgb like "rgb(255,255,255)"
- - byte: base64 encoded binary data
- - password: any kind of string
- - date: a date string like "2006-01-02" as defined by full-date in RFC3339
- - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format
- - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339.
+ - hostname: a valid representation for an Internet host
+ name, as defined by RFC 1034, section 3.1 [RFC1034]. -
+ ipv4: an IPv4 IP as parsed by Golang net.ParseIP - ipv6:
+ an IPv6 IP as parsed by Golang net.ParseIP - cidr: a CIDR
+ as parsed by Golang net.ParseCIDR - mac: a MAC address
+ as parsed by Golang net.ParseMAC - uuid: an UUID that
+ allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid3: an UUID3 that allows uppercase defined by the
+ regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid4: an UUID4 that allows uppercase defined by the
+ regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - uuid5: an UUID5 that allows uppercase defined by the
+ regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - isbn: an ISBN10 or ISBN13 number string like \"0321751043\"
+ or \"978-0321751041\" - isbn10: an ISBN10 number string
+ like \"0321751043\" - isbn13: an ISBN13 number string
+ like \"978-0321751041\" - creditcard: a credit card number
+ defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\\\d{3})\\\\d{11})$
+ with any non digit characters mixed in - ssn: a U.S. social
+ security number following the regex ^\\\\d{3}[- ]?\\\\d{2}[-
+ ]?\\\\d{4}$ - hexcolor: an hexadecimal color code like
+ \"#FFFFFF\" following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
+ - rgbcolor: an RGB color code like rgb like \"rgb(255,255,255)\"
+ - byte: base64 encoded binary data - password: any kind
+ of string - date: a date string like \"2006-01-02\" as
+ defined by full-date in RFC3339 - duration: a duration
+ string like \"22 ns\" as parsed by Golang time.ParseDuration
+ or compatible with Scala duration format - datetime: a
+ date time string like \"2014-12-15T19:30:20.000Z\" as
+ defined by date-time in RFC3339."
type: string
id:
type: string
@@ -449,8 +470,7 @@ spec:
description: True if the spec is generated from a Kamelet
type: boolean
interceptors:
- description: |-
- Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
+ description: Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
uses to pre/post process sources
items:
type: string
@@ -460,9 +480,8 @@ spec:
to interpret this source code
type: string
loader:
- description: |-
- Loader is an optional id of the org.apache.camel.k.RoutesLoader that will
- interpret this source at runtime
+ description: Loader is an optional id of the org.apache.camel.k.RoutesLoader
+ that will interpret this source at runtime
type: string
name:
description: the name of the specification
@@ -492,9 +511,8 @@ spec:
x-kubernetes-preserve-unknown-fields: true
types:
additionalProperties:
- description: |-
- EventTypeSpec represents a specification for an event type.
- Deprecated: In favor of using DataTypeSpec.
+ description: 'EventTypeSpec represents a specification for an event
+ type. Deprecated: In favor of using DataTypeSpec.'
properties:
mediaType:
description: media type as expected for HTTP media types (ie,
@@ -509,9 +527,9 @@ spec:
description:
type: string
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value. These
+ types are supported: bool, int64, float64, string, []interface{},
+ map[string]interface{} and nil.'
x-kubernetes-preserve-unknown-fields: true
externalDocs:
description: ExternalDocumentation allows referencing an
@@ -537,49 +555,61 @@ spec:
type: string
enum:
items:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value.
+ These types are supported: bool, int64, float64,
+ string, []interface{}, map[string]interface{}
+ and nil.'
x-kubernetes-preserve-unknown-fields: true
type: array
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value.
+ These types are supported: bool, int64, float64,
+ string, []interface{}, map[string]interface{} and
+ nil.'
x-kubernetes-preserve-unknown-fields: true
exclusiveMaximum:
type: boolean
exclusiveMinimum:
type: boolean
format:
- description: |-
- format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:
-
-
- - bsonobjectid: a bson object ID, i.e. a 24 characters hex string
- - uri: an URI as parsed by Golang net/url.ParseRequestURI
- - email: an email address as parsed by Golang net/mail.ParseAddress
- - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034].
+ description: "format is an OpenAPI v3 format string.
+ Unknown formats are ignored. The following formats
+ are validated: \n - bsonobjectid: a bson object
+ ID, i.e. a 24 characters hex string - uri: an URI
+ as parsed by Golang net/url.ParseRequestURI - email:
+ an email address as parsed by Golang net/mail.ParseAddress
+ - hostname: a valid representation for an Internet
+ host name, as defined by RFC 1034, section 3.1 [RFC1034].
- ipv4: an IPv4 IP as parsed by Golang net.ParseIP
- ipv6: an IPv6 IP as parsed by Golang net.ParseIP
- cidr: a CIDR as parsed by Golang net.ParseCIDR
- mac: a MAC address as parsed by Golang net.ParseMAC
- - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041"
- - isbn10: an ISBN10 number string like "0321751043"
- - isbn13: an ISBN13 number string like "978-0321751041"
- - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\d{3})\\d{11})$ with any non digit characters mixed in
- - ssn: a U.S. social security number following the regex ^\\d{3}[- ]?\\d{2}[- ]?\\d{4}$
- - hexcolor: an hexadecimal color code like "#FFFFFF" following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
- - rgbcolor: an RGB color code like rgb like "rgb(255,255,255)"
- - byte: base64 encoded binary data
- - password: any kind of string
- - date: a date string like "2006-01-02" as defined by full-date in RFC3339
- - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format
- - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339.
+ - uuid: an UUID that allows uppercase defined by
+ the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid3: an UUID3 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid4: an UUID4 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - uuid5: an UUID5 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - isbn: an ISBN10 or ISBN13 number string like \"0321751043\"
+ or \"978-0321751041\" - isbn10: an ISBN10 number
+ string like \"0321751043\" - isbn13: an ISBN13 number
+ string like \"978-0321751041\" - creditcard: a credit
+ card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\\\d{3})\\\\d{11})$
+ with any non digit characters mixed in - ssn: a
+ U.S. social security number following the regex
+ ^\\\\d{3}[- ]?\\\\d{2}[- ]?\\\\d{4}$ - hexcolor:
+ an hexadecimal color code like \"#FFFFFF\" following
+ the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ -
+ rgbcolor: an RGB color code like rgb like \"rgb(255,255,255)\"
+ - byte: base64 encoded binary data - password: any
+ kind of string - date: a date string like \"2006-01-02\"
+ as defined by full-date in RFC3339 - duration: a
+ duration string like \"22 ns\" as parsed by Golang
+ time.ParseDuration or compatible with Scala duration
+ format - datetime: a date time string like \"2014-12-15T19:30:20.000Z\"
+ as defined by date-time in RFC3339."
type: string
id:
type: string
@@ -638,17 +668,15 @@ spec:
type: string
type: object
type: object
- description: |-
- data specification types for the events consumed/produced by the Kamelet
- Deprecated: In favor of using DataTypes
+ description: 'data specification types for the events consumed/produced
+ by the Kamelet Deprecated: In favor of using DataTypes'
type: object
type: object
status:
default:
phase: Ready
- description: |-
- the actual status of the resource
- Deprecated no longer in use
+ description: the actual status of the resource Deprecated no longer in
+ use
properties:
conditions:
description: Conditions --
@@ -724,19 +752,14 @@ spec:
description: Kamelet is the Schema for the kamelets API.
properties:
apiVersion:
- description: |-
- APIVersion defines the versioned schema of this representation of an object.
- Servers should convert recognized schemas to the latest internal value, and
- may reject unrecognized values.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+ description: 'APIVersion defines the versioned schema of this representation
+ of an object. Servers should convert recognized schemas to the latest
+ internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: |-
- Kind is a string value representing the REST resource this object represents.
- Servers may infer this from the endpoint the client submits requests to.
- Cannot be updated.
- In CamelCase.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ description: 'Kind is a string value representing the REST resource this
+ object represents. Servers may infer this from the endpoint the client
+ submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
@@ -817,9 +840,10 @@ spec:
description:
type: string
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value.
+ These types are supported: bool, int64, float64,
+ string, []interface{}, map[string]interface{} and
+ nil.'
x-kubernetes-preserve-unknown-fields: true
externalDocs:
description: ExternalDocumentation allows referencing
@@ -845,49 +869,65 @@ spec:
type: string
enum:
items:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON
+ value. These types are supported: bool,
+ int64, float64, string, []interface{}, map[string]interface{}
+ and nil.'
x-kubernetes-preserve-unknown-fields: true
type: array
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON
+ value. These types are supported: bool, int64,
+ float64, string, []interface{}, map[string]interface{}
+ and nil.'
x-kubernetes-preserve-unknown-fields: true
exclusiveMaximum:
type: boolean
exclusiveMinimum:
type: boolean
format:
- description: |-
- format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:
-
-
- - bsonobjectid: a bson object ID, i.e. a 24 characters hex string
- - uri: an URI as parsed by Golang net/url.ParseRequestURI
- - email: an email address as parsed by Golang net/mail.ParseAddress
- - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034].
+ description: "format is an OpenAPI v3 format
+ string. Unknown formats are ignored. The following
+ formats are validated: \n - bsonobjectid:
+ a bson object ID, i.e. a 24 characters hex
+ string - uri: an URI as parsed by Golang net/url.ParseRequestURI
+ - email: an email address as parsed by Golang
+ net/mail.ParseAddress - hostname: a valid
+ representation for an Internet host name,
+ as defined by RFC 1034, section 3.1 [RFC1034].
- ipv4: an IPv4 IP as parsed by Golang net.ParseIP
- ipv6: an IPv6 IP as parsed by Golang net.ParseIP
- cidr: a CIDR as parsed by Golang net.ParseCIDR
- mac: a MAC address as parsed by Golang net.ParseMAC
- - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041"
- - isbn10: an ISBN10 number string like "0321751043"
- - isbn13: an ISBN13 number string like "978-0321751041"
- - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\d{3})\\d{11})$ with any non digit characters mixed in
- - ssn: a U.S. social security number following the regex ^\\d{3}[- ]?\\d{2}[- ]?\\d{4}$
- - hexcolor: an hexadecimal color code like "#FFFFFF" following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
- - rgbcolor: an RGB color code like rgb like "rgb(255,255,255)"
- - byte: base64 encoded binary data
- - password: any kind of string
- - date: a date string like "2006-01-02" as defined by full-date in RFC3339
- - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format
- - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339.
+ - uuid: an UUID that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid3: an UUID3 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid4: an UUID4 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - uuid5: an UUID5 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - isbn: an ISBN10 or ISBN13 number string
+ like \"0321751043\" or \"978-0321751041\"
+ - isbn10: an ISBN10 number string like \"0321751043\"
+ - isbn13: an ISBN13 number string like \"978-0321751041\"
+ - creditcard: a credit card number defined
+ by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\\\d{3})\\\\d{11})$
+ with any non digit characters mixed in - ssn:
+ a U.S. social security number following the
+ regex ^\\\\d{3}[- ]?\\\\d{2}[- ]?\\\\d{4}$
+ - hexcolor: an hexadecimal color code like
+ \"#FFFFFF\" following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
+ - rgbcolor: an RGB color code like rgb like
+ \"rgb(255,255,255)\" - byte: base64 encoded
+ binary data - password: any kind of string
+ - date: a date string like \"2006-01-02\"
+ as defined by full-date in RFC3339 - duration:
+ a duration string like \"22 ns\" as parsed
+ by Golang time.ParseDuration or compatible
+ with Scala duration format - datetime: a date
+ time string like \"2014-12-15T19:30:20.000Z\"
+ as defined by date-time in RFC3339."
type: string
id:
type: string
@@ -968,9 +1008,9 @@ spec:
description:
type: string
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value. These types
+ are supported: bool, int64, float64, string, []interface{},
+ map[string]interface{} and nil.'
x-kubernetes-preserve-unknown-fields: true
externalDocs:
description: ExternalDocumentation allows referencing an external
@@ -996,49 +1036,56 @@ spec:
type: string
enum:
items:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value. These
+ types are supported: bool, int64, float64, string, []interface{},
+ map[string]interface{} and nil.'
x-kubernetes-preserve-unknown-fields: true
type: array
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value. These
+ types are supported: bool, int64, float64, string, []interface{},
+ map[string]interface{} and nil.'
x-kubernetes-preserve-unknown-fields: true
exclusiveMaximum:
type: boolean
exclusiveMinimum:
type: boolean
format:
- description: |-
- format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:
-
-
- - bsonobjectid: a bson object ID, i.e. a 24 characters hex string
- - uri: an URI as parsed by Golang net/url.ParseRequestURI
+ description: "format is an OpenAPI v3 format string. Unknown
+ formats are ignored. The following formats are validated:
+ \n - bsonobjectid: a bson object ID, i.e. a 24 characters
+ hex string - uri: an URI as parsed by Golang net/url.ParseRequestURI
- email: an email address as parsed by Golang net/mail.ParseAddress
- - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034].
- - ipv4: an IPv4 IP as parsed by Golang net.ParseIP
- - ipv6: an IPv6 IP as parsed by Golang net.ParseIP
- - cidr: a CIDR as parsed by Golang net.ParseCIDR
- - mac: a MAC address as parsed by Golang net.ParseMAC
- - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041"
- - isbn10: an ISBN10 number string like "0321751043"
- - isbn13: an ISBN13 number string like "978-0321751041"
- - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\d{3})\\d{11})$ with any non digit characters mixed in
- - ssn: a U.S. social security number following the regex ^\\d{3}[- ]?\\d{2}[- ]?\\d{4}$
- - hexcolor: an hexadecimal color code like "#FFFFFF" following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
- - rgbcolor: an RGB color code like rgb like "rgb(255,255,255)"
- - byte: base64 encoded binary data
- - password: any kind of string
- - date: a date string like "2006-01-02" as defined by full-date in RFC3339
- - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format
- - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339.
+ - hostname: a valid representation for an Internet host
+ name, as defined by RFC 1034, section 3.1 [RFC1034]. -
+ ipv4: an IPv4 IP as parsed by Golang net.ParseIP - ipv6:
+ an IPv6 IP as parsed by Golang net.ParseIP - cidr: a CIDR
+ as parsed by Golang net.ParseCIDR - mac: a MAC address
+ as parsed by Golang net.ParseMAC - uuid: an UUID that
+ allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid3: an UUID3 that allows uppercase defined by the
+ regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid4: an UUID4 that allows uppercase defined by the
+ regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - uuid5: an UUID5 that allows uppercase defined by the
+ regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - isbn: an ISBN10 or ISBN13 number string like \"0321751043\"
+ or \"978-0321751041\" - isbn10: an ISBN10 number string
+ like \"0321751043\" - isbn13: an ISBN13 number string
+ like \"978-0321751041\" - creditcard: a credit card number
+ defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\\\d{3})\\\\d{11})$
+ with any non digit characters mixed in - ssn: a U.S. social
+ security number following the regex ^\\\\d{3}[- ]?\\\\d{2}[-
+ ]?\\\\d{4}$ - hexcolor: an hexadecimal color code like
+ \"#FFFFFF\" following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
+ - rgbcolor: an RGB color code like rgb like \"rgb(255,255,255)\"
+ - byte: base64 encoded binary data - password: any kind
+ of string - date: a date string like \"2006-01-02\" as
+ defined by full-date in RFC3339 - duration: a duration
+ string like \"22 ns\" as parsed by Golang time.ParseDuration
+ or compatible with Scala duration format - datetime: a
+ date time string like \"2014-12-15T19:30:20.000Z\" as
+ defined by date-time in RFC3339."
type: string
id:
type: string
@@ -1126,8 +1173,7 @@ spec:
description: True if the spec is generated from a Kamelet
type: boolean
interceptors:
- description: |-
- Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
+ description: Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
uses to pre/post process sources
items:
type: string
@@ -1137,9 +1183,8 @@ spec:
to interpret this source code
type: string
loader:
- description: |-
- Loader is an optional id of the org.apache.camel.k.RoutesLoader that will
- interpret this source at runtime
+ description: Loader is an optional id of the org.apache.camel.k.RoutesLoader
+ that will interpret this source at runtime
type: string
name:
description: the name of the specification
@@ -1169,9 +1214,8 @@ spec:
x-kubernetes-preserve-unknown-fields: true
types:
additionalProperties:
- description: |-
- EventTypeSpec represents a specification for an event type.
- Deprecated: In favor of using DataTypeSpec.
+ description: 'EventTypeSpec represents a specification for an event
+ type. Deprecated: In favor of using DataTypeSpec.'
properties:
mediaType:
description: media type as expected for HTTP media types (ie,
@@ -1186,9 +1230,9 @@ spec:
description:
type: string
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value. These
+ types are supported: bool, int64, float64, string, []interface{},
+ map[string]interface{} and nil.'
x-kubernetes-preserve-unknown-fields: true
externalDocs:
description: ExternalDocumentation allows referencing an
@@ -1214,49 +1258,61 @@ spec:
type: string
enum:
items:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value.
+ These types are supported: bool, int64, float64,
+ string, []interface{}, map[string]interface{}
+ and nil.'
x-kubernetes-preserve-unknown-fields: true
type: array
example:
- description: |-
- JSON represents any valid JSON value.
- These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ description: 'JSON represents any valid JSON value.
+ These types are supported: bool, int64, float64,
+ string, []interface{}, map[string]interface{} and
+ nil.'
x-kubernetes-preserve-unknown-fields: true
exclusiveMaximum:
type: boolean
exclusiveMinimum:
type: boolean
format:
- description: |-
- format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:
-
-
- - bsonobjectid: a bson object ID, i.e. a 24 characters hex string
- - uri: an URI as parsed by Golang net/url.ParseRequestURI
- - email: an email address as parsed by Golang net/mail.ParseAddress
- - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034].
+ description: "format is an OpenAPI v3 format string.
+ Unknown formats are ignored. The following formats
+ are validated: \n - bsonobjectid: a bson object
+ ID, i.e. a 24 characters hex string - uri: an URI
+ as parsed by Golang net/url.ParseRequestURI - email:
+ an email address as parsed by Golang net/mail.ParseAddress
+ - hostname: a valid representation for an Internet
+ host name, as defined by RFC 1034, section 3.1 [RFC1034].
- ipv4: an IPv4 IP as parsed by Golang net.ParseIP
- ipv6: an IPv6 IP as parsed by Golang net.ParseIP
- cidr: a CIDR as parsed by Golang net.ParseCIDR
- mac: a MAC address as parsed by Golang net.ParseMAC
- - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
- - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
- - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041"
- - isbn10: an ISBN10 number string like "0321751043"
- - isbn13: an ISBN13 number string like "978-0321751041"
- - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\d{3})\\d{11})$ with any non digit characters mixed in
- - ssn: a U.S. social security number following the regex ^\\d{3}[- ]?\\d{2}[- ]?\\d{4}$
- - hexcolor: an hexadecimal color code like "#FFFFFF" following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
- - rgbcolor: an RGB color code like rgb like "rgb(255,255,255)"
- - byte: base64 encoded binary data
- - password: any kind of string
- - date: a date string like "2006-01-02" as defined by full-date in RFC3339
- - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format
- - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339.
+ - uuid: an UUID that allows uppercase defined by
+ the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid3: an UUID3 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
+ - uuid4: an UUID4 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - uuid5: an UUID5 that allows uppercase defined
+ by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
+ - isbn: an ISBN10 or ISBN13 number string like \"0321751043\"
+ or \"978-0321751041\" - isbn10: an ISBN10 number
+ string like \"0321751043\" - isbn13: an ISBN13 number
+ string like \"978-0321751041\" - creditcard: a credit
+ card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\\\d{3})\\\\d{11})$
+ with any non digit characters mixed in - ssn: a
+ U.S. social security number following the regex
+ ^\\\\d{3}[- ]?\\\\d{2}[- ]?\\\\d{4}$ - hexcolor:
+ an hexadecimal color code like \"#FFFFFF\" following
+ the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ -
+ rgbcolor: an RGB color code like rgb like \"rgb(255,255,255)\"
+ - byte: base64 encoded binary data - password: any
+ kind of string - date: a date string like \"2006-01-02\"
+ as defined by full-date in RFC3339 - duration: a
+ duration string like \"22 ns\" as parsed by Golang
+ time.ParseDuration or compatible with Scala duration
+ format - datetime: a date time string like \"2014-12-15T19:30:20.000Z\"
+ as defined by date-time in RFC3339."
type: string
id:
type: string
@@ -1315,9 +1371,8 @@ spec:
type: string
type: object
type: object
- description: |-
- data specification types for the events consumed/produced by the Kamelet
- Deprecated: In favor of using DataTypes
+ description: 'data specification types for the events consumed/produced
+ by the Kamelet Deprecated: In favor of using DataTypes'
type: object
type: object
status:
@@ -1384,3 +1439,9 @@ spec:
storage: false
subresources:
status: {}
+status:
+ acceptedNames:
+ kind: ""
+ plural: ""
+ conditions: []
+ storedVersions: []
diff --git a/pkg/resources/config/crd/bases/camel.apache.org_pipes.yaml b/pkg/resources/config/crd/bases/camel.apache.org_pipes.yaml
index 85b93bf7e0..a003be4b72 100644
--- a/pkg/resources/config/crd/bases/camel.apache.org_pipes.yaml
+++ b/pkg/resources/config/crd/bases/camel.apache.org_pipes.yaml
@@ -15,12 +15,14 @@
# limitations under the License.
# ---------------------------------------------------------------------------
+
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
- controller-gen.kubebuilder.io/version: v0.15.0
+ controller-gen.kubebuilder.io/version: v0.6.1
+ creationTimestamp: null
name: pipes.camel.apache.org
spec:
group: camel.apache.org
@@ -51,19 +53,14 @@ spec:
description: Pipe is the Schema for the Pipe API.
properties:
apiVersion:
- description: |-
- APIVersion defines the versioned schema of this representation of an object.
- Servers should convert recognized schemas to the latest internal value, and
- may reject unrecognized values.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+ description: 'APIVersion defines the versioned schema of this representation
+ of an object. Servers should convert recognized schemas to the latest
+ internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: |-
- Kind is a string value representing the REST resource this object represents.
- Servers may infer this from the endpoint the client submits requests to.
- Cannot be updated.
- In CamelCase.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ description: 'Kind is a string value representing the REST resource this
+ object represents. Servers may infer this from the endpoint the client
+ submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
@@ -76,17 +73,15 @@ spec:
type: object
x-kubernetes-preserve-unknown-fields: true
integration:
- description: |-
- Integration is an optional integration used to specify custom parameters
- Deprecated don't use this. Use trait annotations if you need to change any cluster configuration.
+ description: Integration is an optional integration used to specify
+ custom parameters Deprecated don't use this. Use trait annotations
+ if you need to change any cluster configuration.
properties:
configuration:
- description: |-
- Deprecated:
- Use camel trait (camel.properties) to manage properties
- Use mount trait (mount.configs) to manage configs
- Use mount trait (mount.resources) to manage resources
- Use mount trait (mount.volumes) to manage volumes
+ description: 'Deprecated: Use camel trait (camel.properties) to
+ manage properties Use mount trait (mount.configs) to manage
+ configs Use mount trait (mount.resources) to manage resources
+ Use mount trait (mount.volumes) to manage volumes'
items:
description: ConfigurationSpec represents a generic configuration
specification.
@@ -127,43 +122,35 @@ spec:
description: API version of the referent.
type: string
fieldPath:
- description: |-
- If referring to a piece of an object instead of an entire object, this string
- should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
- For example, if the object reference is to a container within a pod, this would take on a value like:
- "spec.containers{name}" (where "name" refers to the name of the container that triggered
- the event) or if no container name is specified "spec.containers[2]" (container with
- index 2 in this pod). This syntax is chosen only to have some well-defined way of
- referencing a part of an object.
- TODO: this design is not final and this field is subject to change in the future.
+ description: 'If referring to a piece of an object instead
+ of an entire object, this string should contain a valid
+ JSON/Go field access statement, such as desiredState.manifest.containers[2].
+ For example, if the object reference is to a container within
+ a pod, this would take on a value like: "spec.containers{name}"
+ (where "name" refers to the name of the container that triggered
+ the event) or if no container name is specified "spec.containers[2]"
+ (container with index 2 in this pod). This syntax is chosen
+ only to have some well-defined way of referencing a part
+ of an object. TODO: this design is not final and this field
+ is subject to change in the future.'
type: string
kind:
- description: |-
- Kind of the referent.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ 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: 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'
type: string
namespace:
- description: |-
- Namespace of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
+ description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type: string
resourceVersion:
- description: |-
- Specific resourceVersion to which this reference is made, if any.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
+ description: 'Specific resourceVersion to which this reference
+ is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
type: string
uid:
- description: |-
- UID of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
+ description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
type: string
type: object
- x-kubernetes-map-type: atomic
profile:
description: the profile needed to run this Integration
type: string
@@ -204,8 +191,7 @@ spec:
description: True if the spec is generated from a Kamelet
type: boolean
interceptors:
- description: |-
- Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
+ description: Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
uses to pre/post process sources
items:
type: string
@@ -215,9 +201,8 @@ spec:
to interpret this source code
type: string
loader:
- description: |-
- Loader is an optional id of the org.apache.camel.k.RoutesLoader that will
- interpret this source at runtime
+ description: Loader is an optional id of the org.apache.camel.k.RoutesLoader
+ that will interpret this source at runtime
type: string
name:
description: the name of the specification
@@ -261,35 +246,39 @@ spec:
want to run within a pod.
properties:
args:
- description: |-
- Arguments to the entrypoint.
- The container image's CMD is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Arguments to the entrypoint. The container
+ image''s CMD is used if this is not provided.
+ Variable references $(VAR_NAME) are expanded using
+ the container''s environment. If a variable cannot
+ be resolved, the reference in the input string
+ will be unchanged. Double $$ are reduced to a
+ single $, which allows for escaping the $(VAR_NAME)
+ syntax: i.e. "$$(VAR_NAME)" will produce the string
+ literal "$(VAR_NAME)". Escaped references will
+ never be expanded, regardless of whether the variable
+ exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
command:
- description: |-
- Entrypoint array. Not executed within a shell.
- The container image's ENTRYPOINT is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Entrypoint array. Not executed within
+ a shell. The container image''s ENTRYPOINT is
+ used if this is not provided. Variable references
+ $(VAR_NAME) are expanded using the container''s
+ environment. If a variable cannot be resolved,
+ the reference in the input string will be unchanged.
+ Double $$ are reduced to a single $, which allows
+ for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)"
+ will produce the string literal "$(VAR_NAME)".
+ Escaped references will never be expanded, regardless
+ of whether the variable exists or not. Cannot
+ be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
env:
- description: |-
- List of environment variables to set in the container.
- Cannot be updated.
+ description: List of environment variables to set
+ in the container. Cannot be updated.
items:
description: EnvVar represents an environment
variable present in a Container.
@@ -299,16 +288,18 @@ spec:
Must be a C_IDENTIFIER.
type: string
value:
- description: |-
- Variable references $(VAR_NAME) are expanded
- using the previously defined environment variables in the container and
- any service environment variables. If a variable cannot be resolved,
- the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
- "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
- Escaped references will never be expanded, regardless of whether the variable
- exists or not.
- Defaults to "".
+ description: 'Variable references $(VAR_NAME)
+ are expanded using the previously defined
+ environment variables in the container and
+ any service environment variables. If a
+ variable cannot be resolved, the reference
+ in the input string will be unchanged. Double
+ $$ are reduced to a single $, which allows
+ for escaping the $(VAR_NAME) syntax: i.e.
+ "$$(VAR_NAME)" will produce the string literal
+ "$(VAR_NAME)". Escaped references will never
+ be expanded, regardless of whether the variable
+ exists or not. Defaults to "".'
type: string
valueFrom:
description: Source for the environment variable's
@@ -321,10 +312,10 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
+ description: 'Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
@@ -333,11 +324,12 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
fieldRef:
- description: |-
- Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`,
- spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ description: 'Selects a field of the pod:
+ supports metadata.name, metadata.namespace,
+ `metadata.labels['''']`, `metadata.annotations['''']`,
+ spec.nodeName, spec.serviceAccountName,
+ status.hostIP, status.podIP, status.podIPs.'
properties:
apiVersion:
description: Version of the schema
@@ -351,11 +343,13 @@ spec:
required:
- fieldPath
type: object
- x-kubernetes-map-type: atomic
resourceFieldRef:
- description: |-
- Selects a resource of the container: only resources limits and requests
- (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
+ description: 'Selects a resource of the
+ container: only resources limits and
+ requests (limits.cpu, limits.memory,
+ limits.ephemeral-storage, requests.cpu,
+ requests.memory and requests.ephemeral-storage)
+ are currently supported.'
properties:
containerName:
description: 'Container name: required
@@ -377,7 +371,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret
in the pod's namespace
@@ -388,10 +381,10 @@ spec:
secret key.
type: string
name:
- description: |-
- Name of the referent.
+ description: 'Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret
@@ -400,20 +393,21 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
required:
- name
type: object
type: array
envFrom:
- description: |-
- List of sources to populate environment variables in the container.
- The keys defined within a source must be a C_IDENTIFIER. All invalid keys
- will be reported as an event when the container is starting. When a key exists in multiple
- sources, the value associated with the last source will take precedence.
- Values defined by an Env with a duplicate key will take precedence.
- Cannot be updated.
+ description: List of sources to populate environment
+ variables in the container. The keys defined within
+ a source must be a C_IDENTIFIER. All invalid keys
+ will be reported as an event when the container
+ is starting. When a key exists in multiple sources,
+ the value associated with the last source will
+ take precedence. Values defined by an Env with
+ a duplicate key will take precedence. Cannot be
+ updated.
items:
description: EnvFromSource represents the source
of a set of ConfigMaps
@@ -422,17 +416,16 @@ spec:
description: The ConfigMap to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
prefix:
description: An optional identifier to prepend
to each key in the ConfigMap. Must be a
@@ -442,57 +435,59 @@ spec:
description: The Secret to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret
must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
image:
- description: |-
- Container image name.
- More info: https://kubernetes.io/docs/concepts/containers/images
- This field is optional to allow higher level config management to default or override
- container images in workload controllers like Deployments and StatefulSets.
+ description: 'Container image name. More info: https://kubernetes.io/docs/concepts/containers/images
+ This field is optional to allow higher level config
+ management to default or override container images
+ in workload controllers like Deployments and StatefulSets.'
type: string
imagePullPolicy:
- description: |-
- Image pull policy.
- One of Always, Never, IfNotPresent.
- Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
+ description: 'Image pull policy. One of Always,
+ Never, IfNotPresent. Defaults to Always if :latest
+ tag is specified, or IfNotPresent otherwise. Cannot
+ be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
- description: |-
- Actions that the management system should take in response to container lifecycle events.
- Cannot be updated.
+ description: Actions that the management system
+ should take in response to container lifecycle
+ events. Cannot be updated.
properties:
postStart:
- description: |-
- PostStart is called immediately after a container is created. If the handler fails,
- the container is terminated and restarted according to its restart policy.
- Other management of the container blocks until the hook completes.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PostStart is called immediately
+ after a container is created. If the handler
+ fails, the container is terminated and restarted
+ according to its restart policy. Other management
+ of the container blocks until the hook completes.
+ More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to
take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command
+ line to execute inside the container,
+ the working directory for the command is
+ root ('/') in the container's filesystem.
+ The command is simply exec'd, it is
+ not run inside a shell, so traditional
+ shell instructions ('|', etc) won't
+ work. To use a shell, you need to
+ explicitly call out to that shell.
+ Exit status of 0 is treated as live/healthy
+ and non-zero is unhealthy.
items:
type: string
type: array
@@ -502,9 +497,10 @@ spec:
request to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to,
+ defaults to the pod IP. You probably
+ want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
description: Custom headers to set in
@@ -516,9 +512,11 @@ spec:
probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field
+ name. This will be canonicalized
+ upon output, so case-variant
+ names will be understood as
+ the same header.
type: string
value:
description: The header field
@@ -537,15 +535,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -564,10 +561,12 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT
+ supported as a LifecycleHandler and kept
+ for the backward compatibility. There
+ are no validation of this field and lifecycle
+ hooks will fail in runtime when tcp handler
+ is specified.
properties:
host:
description: 'Optional: Host name to
@@ -577,38 +576,47 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
preStop:
- description: |-
- PreStop is called immediately before a container is terminated due to an
- API request or management event such as liveness/startup probe failure,
- preemption, resource contention, etc. The handler is not called if the
- container crashes or exits. The Pod's termination grace period countdown begins before the
- PreStop hook is executed. Regardless of the outcome of the handler, the
- container will eventually terminate within the Pod's termination grace
- period (unless delayed by finalizers). Other management of the container blocks until the hook completes
- or until the termination grace period is reached.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PreStop is called immediately
+ before a container is terminated due to an
+ API request or management event such as liveness/startup
+ probe failure, preemption, resource contention,
+ etc. The handler is not called if the container
+ crashes or exits. The Pod''s termination grace
+ period countdown begins before the PreStop
+ hook is executed. Regardless of the outcome
+ of the handler, the container will eventually
+ terminate within the Pod''s termination grace
+ period (unless delayed by finalizers). Other
+ management of the container blocks until the
+ hook completes or until the termination grace
+ period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to
take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command
+ line to execute inside the container,
+ the working directory for the command is
+ root ('/') in the container's filesystem.
+ The command is simply exec'd, it is
+ not run inside a shell, so traditional
+ shell instructions ('|', etc) won't
+ work. To use a shell, you need to
+ explicitly call out to that shell.
+ Exit status of 0 is treated as live/healthy
+ and non-zero is unhealthy.
items:
type: string
type: array
@@ -618,9 +626,10 @@ spec:
request to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to,
+ defaults to the pod IP. You probably
+ want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
description: Custom headers to set in
@@ -632,9 +641,11 @@ spec:
probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field
+ name. This will be canonicalized
+ upon output, so case-variant
+ names will be understood as
+ the same header.
type: string
value:
description: The header field
@@ -653,15 +664,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -680,10 +690,12 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT
+ supported as a LifecycleHandler and kept
+ for the backward compatibility. There
+ are no validation of this field and lifecycle
+ hooks will fail in runtime when tcp handler
+ is specified.
properties:
host:
description: 'Optional: Host name to
@@ -693,10 +705,10 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
@@ -704,30 +716,33 @@ spec:
type: object
type: object
livenessProbe:
- description: |-
- Periodic probe of container liveness.
+ 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
+ Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -740,12 +755,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -755,8 +769,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -767,9 +781,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -787,35 +802,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -830,59 +845,63 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
name:
- description: |-
- Name of the container specified as a DNS_LABEL.
- Each container in a pod must have a unique name (DNS_LABEL).
- Cannot be updated.
+ description: Name of the container specified as
+ a DNS_LABEL. Each container in a pod must have
+ a unique name (DNS_LABEL). Cannot be updated.
type: string
ports:
- description: |-
- List of ports to expose from the container. Not specifying a port here
- DOES NOT prevent that port from being exposed. Any port which is
- listening on the default "0.0.0.0" address inside a container will be
- accessible from the network.
- Modifying this array with strategic merge patch may corrupt the data.
- For more information See https://github.com/kubernetes/kubernetes/issues/108255.
+ description: List of ports to expose from the container.
+ Not specifying a port here DOES NOT prevent that
+ port from being exposed. Any port which is listening
+ on the default "0.0.0.0" address inside a container
+ will be accessible from the network. Modifying
+ this array with strategic merge patch may corrupt
+ the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255.
Cannot be updated.
items:
description: ContainerPort represents a network
port in a single container.
properties:
containerPort:
- description: |-
- Number of port to expose on the pod's IP address.
- This must be a valid port number, 0 < x < 65536.
+ description: Number of port to expose on the
+ pod's IP address. This must be a valid port
+ number, 0 < x < 65536.
format: int32
type: integer
hostIP:
@@ -890,24 +909,24 @@ spec:
port to.
type: string
hostPort:
- description: |-
- Number of port to expose on the host.
- If specified, this must be a valid port number, 0 < x < 65536.
- If HostNetwork is specified, this must match ContainerPort.
+ description: Number of port to expose on the
+ host. If specified, this must be a valid
+ port number, 0 < x < 65536. If HostNetwork
+ is specified, this must match ContainerPort.
Most containers do not need this.
format: int32
type: integer
name:
- description: |-
- If specified, this must be an IANA_SVC_NAME and unique within the pod. Each
- named port in a pod must have a unique name. Name for the port that can be
- referred to by services.
+ description: If specified, this must be an
+ IANA_SVC_NAME and unique within the pod.
+ Each named port in a pod must have a unique
+ name. Name for the port that can be referred
+ to by services.
type: string
protocol:
default: TCP
- description: |-
- Protocol for port. Must be UDP, TCP, or SCTP.
- Defaults to "TCP".
+ description: Protocol for port. Must be UDP,
+ TCP, or SCTP. Defaults to "TCP".
type: string
required:
- containerPort
@@ -918,30 +937,34 @@ spec:
- protocol
x-kubernetes-list-type: map
readinessProbe:
- description: |-
- Periodic probe of container service readiness.
- Container will be removed from service endpoints if the probe fails.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Periodic probe of container service
+ readiness. Container will be removed from service
+ endpoints if the probe fails. Cannot be updated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -954,12 +977,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -969,8 +991,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -981,9 +1003,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -1001,35 +1024,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -1044,33 +1067,38 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
@@ -1081,14 +1109,14 @@ spec:
resource resize policy for the container.
properties:
resourceName:
- description: |-
- Name of the resource to which this resource resize policy applies.
- Supported values: cpu, memory.
+ description: 'Name of the resource to which
+ this resource resize policy applies. Supported
+ values: cpu, memory.'
type: string
restartPolicy:
- description: |-
- Restart policy to apply when specified resource is resized.
- If not specified, it defaults to NotRequired.
+ description: Restart policy to apply when
+ specified resource is resized. If not specified,
+ it defaults to NotRequired.
type: string
required:
- resourceName
@@ -1097,31 +1125,26 @@ spec:
type: array
x-kubernetes-list-type: atomic
resources:
- description: |-
- Compute Resources required by this container.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Compute Resources required by this
+ container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
properties:
claims:
- description: |-
- Claims lists the names of resources, defined in spec.resourceClaims,
- that are used by this container.
-
-
- This is an alpha field and requires enabling the
- DynamicResourceAllocation feature gate.
-
-
- This field is immutable. It can only be set for containers.
+ description: "Claims lists the names of resources,
+ defined in spec.resourceClaims, that are used
+ by this container. \n This is an alpha field
+ and requires enabling the DynamicResourceAllocation
+ feature gate. \n This field is immutable.
+ It can only be set for containers."
items:
description: ResourceClaim references one
entry in PodSpec.ResourceClaims.
properties:
name:
- description: |-
- Name must match the name of one entry in pod.spec.resourceClaims of
- the Pod where this field is used. It makes that resource available
- inside a container.
+ description: Name must match the name
+ of one entry in pod.spec.resourceClaims
+ of the Pod where this field is used.
+ It makes that resource available inside
+ a container.
type: string
required:
- name
@@ -1137,9 +1160,8 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Limits describes the maximum amount of compute resources allowed.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Limits describes the maximum amount
+ of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -1148,52 +1170,61 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Requests describes the minimum amount of compute resources required.
- If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
- otherwise to an implementation-defined value. Requests cannot exceed Limits.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Requests describes the minimum
+ amount of compute resources required. If Requests
+ is omitted for a container, it defaults to
+ Limits if that is explicitly specified, otherwise
+ to an implementation-defined value. Requests
+ cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
restartPolicy:
- description: |-
- RestartPolicy defines the restart behavior of individual containers in a pod.
- This field may only be set for init containers, and the only allowed value is "Always".
- For non-init containers or when this field is not specified,
- the restart behavior is defined by the Pod's restart policy and the container type.
- Setting the RestartPolicy as "Always" for the init container will have the following effect:
- this init container will be continually restarted on
- exit until all regular containers have terminated. Once all regular
- containers have completed, all init containers with restartPolicy "Always"
- will be shut down. This lifecycle differs from normal init containers and
- is often referred to as a "sidecar" container. Although this init
- container still starts in the init container sequence, it does not wait
- for the container to complete before proceeding to the next init
- container. Instead, the next init container starts immediately after this
- init container is started, or after any startupProbe has successfully
- completed.
+ description: 'RestartPolicy defines the restart
+ behavior of individual containers in a pod. This
+ field may only be set for init containers, and
+ the only allowed value is "Always". For non-init
+ containers or when this field is not specified,
+ the restart behavior is defined by the Pod''s
+ restart policy and the container type. Setting
+ the RestartPolicy as "Always" for the init container
+ will have the following effect: this init container
+ will be continually restarted on exit until all
+ regular containers have terminated. Once all regular
+ containers have completed, all init containers
+ with restartPolicy "Always" will be shut down.
+ This lifecycle differs from normal init containers
+ and is often referred to as a "sidecar" container.
+ Although this init container still starts in the
+ init container sequence, it does not wait for
+ the container to complete before proceeding to
+ the next init container. Instead, the next init
+ container starts immediately after this init container
+ is started, or after any startupProbe has successfully
+ completed.'
type: string
securityContext:
- description: |-
- SecurityContext defines the security options the container should be run with.
- If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
- More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
+ description: 'SecurityContext defines the security
+ options the container should be run with. If set,
+ the fields of SecurityContext override the equivalent
+ fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
properties:
allowPrivilegeEscalation:
- description: |-
- AllowPrivilegeEscalation controls whether a process can gain more
- privileges than its parent process. This bool directly controls if
- the no_new_privs flag will be set on the container process.
- AllowPrivilegeEscalation is true always when the container is:
- 1) run as Privileged
- 2) has CAP_SYS_ADMIN
- Note that this field cannot be set when spec.os.name is windows.
+ description: 'AllowPrivilegeEscalation controls
+ whether a process can gain more privileges
+ than its parent process. This bool directly
+ controls if the no_new_privs flag will be
+ set on the container process. AllowPrivilegeEscalation
+ is true always when the container is: 1) run
+ as Privileged 2) has CAP_SYS_ADMIN Note that
+ this field cannot be set when spec.os.name
+ is windows.'
type: boolean
capabilities:
- description: |-
- The capabilities to add/drop when running containers.
- Defaults to the default set of capabilities granted by the container runtime.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The capabilities to add/drop when
+ running containers. Defaults to the default
+ set of capabilities granted by the container
+ runtime. Note that this field cannot be set
+ when spec.os.name is windows.
properties:
add:
description: Added capabilities
@@ -1211,60 +1242,69 @@ spec:
type: array
type: object
privileged:
- description: |-
- Run container in privileged mode.
- Processes in privileged containers are essentially equivalent to root on the host.
- Defaults to false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Run container in privileged mode.
+ Processes in privileged containers are essentially
+ equivalent to root on the host. Defaults to
+ false. Note that this field cannot be set
+ when spec.os.name is windows.
type: boolean
procMount:
- description: |-
- procMount denotes the type of proc mount to use for the containers.
- The default is DefaultProcMount which uses the container runtime defaults for
- readonly paths and masked paths.
- This requires the ProcMountType feature flag to be enabled.
- Note that this field cannot be set when spec.os.name is windows.
+ description: procMount denotes the type of proc
+ mount to use for the containers. The default
+ is DefaultProcMount which uses the container
+ runtime defaults for readonly paths and masked
+ paths. This requires the ProcMountType feature
+ flag to be enabled. Note that this field cannot
+ be set when spec.os.name is windows.
type: string
readOnlyRootFilesystem:
- description: |-
- Whether this container has a read-only root filesystem.
- Default is false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Whether this container has a read-only
+ root filesystem. Default is false. Note that
+ this field cannot be set when spec.os.name
+ is windows.
type: boolean
runAsGroup:
- description: |-
- The GID to run the entrypoint of the container process.
- Uses runtime default if unset.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The GID to run the entrypoint of
+ the container process. Uses runtime default
+ if unset. May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is windows.
format: int64
type: integer
runAsNonRoot:
- description: |-
- Indicates that the container must run as a non-root user.
- If true, the Kubelet will validate the image at runtime to ensure that it
- does not run as UID 0 (root) and fail to start the container if it does.
- If unset or false, no such validation will be performed.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: Indicates that the container must
+ run as a non-root user. If true, the Kubelet
+ will validate the image at runtime to ensure
+ that it does not run as UID 0 (root) and fail
+ to start the container if it does. If unset
+ or false, no such validation will be performed.
+ May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence.
type: boolean
runAsUser:
- description: |-
- The UID to run the entrypoint of the container process.
- Defaults to user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The UID to run the entrypoint of
+ the container process. Defaults to user specified
+ in image metadata if unspecified. May also
+ be set in PodSecurityContext. If set in both
+ SecurityContext and PodSecurityContext, the
+ value specified in SecurityContext takes precedence.
+ Note that this field cannot be set when spec.os.name
+ is windows.
format: int64
type: integer
seLinuxOptions:
- description: |-
- The SELinux context to be applied to the container.
- If unspecified, the container runtime will allocate a random SELinux context for each
- container. May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The SELinux context to be applied
+ to the container. If unspecified, the container
+ runtime will allocate a random SELinux context
+ for each container. May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is windows.
properties:
level:
description: Level is SELinux level label
@@ -1284,93 +1324,112 @@ spec:
type: string
type: object
seccompProfile:
- description: |-
- The seccomp options to use by this container. If seccomp options are
- provided at both the pod & container level, the container options
- override the pod options.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The seccomp options to use by this
+ container. If seccomp options are provided
+ at both the pod & container level, the container
+ options override the pod options. Note that
+ this field cannot be set when spec.os.name
+ is windows.
properties:
localhostProfile:
- description: |-
- localhostProfile indicates a profile defined in a file on the node should be used.
- The profile must be preconfigured on the node to work.
- Must be a descending path, relative to the kubelet's configured seccomp profile location.
- Must be set if type is "Localhost". Must NOT be set for any other type.
+ description: localhostProfile indicates
+ a profile defined in a file on the node
+ should be used. The profile must be preconfigured
+ on the node to work. Must be a descending
+ path, relative to the kubelet's configured
+ seccomp profile location. Must be set
+ if type is "Localhost". Must NOT be set
+ for any other type.
type: string
type:
- description: |-
- type indicates which kind of seccomp profile will be applied.
- Valid options are:
-
-
- Localhost - a profile defined in a file on the node should be used.
- RuntimeDefault - the container runtime default profile should be used.
- Unconfined - no profile should be applied.
+ description: "type indicates which kind
+ of seccomp profile will be applied. Valid
+ options are: \n Localhost - a profile
+ defined in a file on the node should be
+ used. RuntimeDefault - the container runtime
+ default profile should be used. Unconfined
+ - no profile should be applied."
type: string
required:
- type
type: object
windowsOptions:
- description: |-
- The Windows specific settings applied to all containers.
- If unspecified, the options from the PodSecurityContext will be used.
- If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is linux.
+ description: The Windows specific settings applied
+ to all containers. If unspecified, the options
+ from the PodSecurityContext will be used.
+ If set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is linux.
properties:
gmsaCredentialSpec:
- description: |-
- GMSACredentialSpec is where the GMSA admission webhook
- (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
- GMSA credential spec named by the GMSACredentialSpecName field.
+ description: GMSACredentialSpec is where
+ the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa)
+ inlines the contents of the GMSA credential
+ spec named by the GMSACredentialSpecName
+ field.
type: string
gmsaCredentialSpecName:
description: GMSACredentialSpecName is the
name of the GMSA credential spec to use.
type: string
hostProcess:
- description: |-
- HostProcess determines if a container should be run as a 'Host Process' container.
- All of a Pod's containers must have the same effective HostProcess value
- (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
- In addition, if HostProcess is true then HostNetwork must also be set to true.
+ description: HostProcess determines if a
+ container should be run as a 'Host Process'
+ container. All of a Pod's containers must
+ have the same effective HostProcess value
+ (it is not allowed to have a mix of HostProcess
+ containers and non-HostProcess containers).
+ In addition, if HostProcess is true then
+ HostNetwork must also be set to true.
type: boolean
runAsUserName:
- description: |-
- The UserName in Windows to run the entrypoint of the container process.
- Defaults to the user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: The UserName in Windows to
+ run the entrypoint of the container process.
+ Defaults to the user specified in image
+ metadata if unspecified. May also be set
+ in PodSecurityContext. If set in both
+ SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext
+ takes precedence.
type: string
type: object
type: object
startupProbe:
- description: |-
- StartupProbe indicates that the Pod has successfully initialized.
- If specified, no other probes are executed until this completes successfully.
- If this probe fails, the Pod will be restarted, just as if the livenessProbe failed.
- This can be used to provide different probe parameters at the beginning of a Pod's lifecycle,
- when it might take a long time to load data or warm a cache, than during steady-state operation.
- This cannot be updated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'StartupProbe indicates that the Pod
+ has successfully initialized. If specified, no
+ other probes are executed until this completes
+ successfully. If this probe fails, the Pod will
+ be restarted, just as if the livenessProbe failed.
+ This can be used to provide different probe parameters
+ at the beginning of a Pod''s lifecycle, when it
+ might take a long time to load data or warm a
+ cache, than during steady-state operation. This
+ cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -1383,12 +1442,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -1398,8 +1456,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -1410,9 +1468,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -1430,35 +1489,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -1473,76 +1532,87 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
stdin:
- description: |-
- Whether this container should allocate a buffer for stdin in the container runtime. If this
- is not set, reads from stdin in the container will always result in EOF.
- Default is false.
+ description: Whether this container should allocate
+ a buffer for stdin in the container runtime. If
+ this is not set, reads from stdin in the container
+ will always result in EOF. Default is false.
type: boolean
stdinOnce:
- description: |-
- Whether the container runtime should close the stdin channel after it has been opened by
- a single attach. When stdin is true the stdin stream will remain open across multiple attach
- sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
- first client attaches to stdin, and then remains open and accepts data until the client disconnects,
- at which time stdin is closed and remains closed until the container is restarted. If this
- flag is false, a container processes that reads from stdin will never receive an EOF.
- Default is false
+ description: Whether the container runtime should
+ close the stdin channel after it has been opened
+ by a single attach. When stdin is true the stdin
+ stream will remain open across multiple attach
+ sessions. If stdinOnce is set to true, stdin is
+ opened on container start, is empty until the
+ first client attaches to stdin, and then remains
+ open and accepts data until the client disconnects,
+ at which time stdin is closed and remains closed
+ until the container is restarted. If this flag
+ is false, a container processes that reads from
+ stdin will never receive an EOF. Default is false
type: boolean
terminationMessagePath:
- description: |-
- Optional: Path at which the file to which the container's termination message
- will be written is mounted into the container's filesystem.
- Message written is intended to be brief final status, such as an assertion failure message.
- Will be truncated by the node if greater than 4096 bytes. The total message length across
- all containers will be limited to 12kb.
- Defaults to /dev/termination-log.
- Cannot be updated.
+ description: 'Optional: Path at which the file to
+ which the container''s termination message will
+ be written is mounted into the container''s filesystem.
+ Message written is intended to be brief final
+ status, such as an assertion failure message.
+ Will be truncated by the node if greater than
+ 4096 bytes. The total message length across all
+ containers will be limited to 12kb. Defaults to
+ /dev/termination-log. Cannot be updated.'
type: string
terminationMessagePolicy:
- description: |-
- Indicate how the termination message should be populated. File will use the contents of
- terminationMessagePath to populate the container status message on both success and failure.
- FallbackToLogsOnError will use the last chunk of container log output if the termination
- message file is empty and the container exited with an error.
- The log output is limited to 2048 bytes or 80 lines, whichever is smaller.
- Defaults to File.
- Cannot be updated.
+ description: Indicate how the termination message
+ should be populated. File will use the contents
+ of terminationMessagePath to populate the container
+ status message on both success and failure. FallbackToLogsOnError
+ will use the last chunk of container log output
+ if the termination message file is empty and the
+ container exited with an error. The log output
+ is limited to 2048 bytes or 80 lines, whichever
+ is smaller. Defaults to File. Cannot be updated.
type: string
tty:
- description: |-
- Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
- Default is false.
+ description: Whether this container should allocate
+ a TTY for itself, also requires 'stdin' to be
+ true. Default is false.
type: boolean
volumeDevices:
description: volumeDevices is the list of block
@@ -1566,45 +1636,46 @@ spec:
type: object
type: array
volumeMounts:
- description: |-
- Pod volumes to mount into the container's filesystem.
- Cannot be updated.
+ description: Pod volumes to mount into the container's
+ filesystem. Cannot be updated.
items:
description: VolumeMount describes a mounting
of a Volume within a container.
properties:
mountPath:
- description: |-
- Path within the container at which the volume should be mounted. Must
+ description: Path within the container at
+ which the volume should be mounted. Must
not contain ':'.
type: string
mountPropagation:
- description: |-
- mountPropagation determines how mounts are propagated from the host
- to container and the other way around.
- When not set, MountPropagationNone is used.
- This field is beta in 1.10.
+ description: mountPropagation determines how
+ mounts are propagated from the host to container
+ and the other way around. When not set,
+ MountPropagationNone is used. This field
+ is beta in 1.10.
type: string
name:
description: This must match the Name of a
Volume.
type: string
readOnly:
- description: |-
- Mounted read-only if true, read-write otherwise (false or unspecified).
- Defaults to false.
+ description: Mounted read-only if true, read-write
+ otherwise (false or unspecified). Defaults
+ to false.
type: boolean
subPath:
- description: |-
- Path within the volume from which the container's volume should be mounted.
+ description: Path within the volume from which
+ the container's volume should be mounted.
Defaults to "" (volume's root).
type: string
subPathExpr:
- description: |-
- Expanded path within the volume from which the container's volume should be mounted.
- Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.
- Defaults to "" (volume's root).
- SubPathExpr and SubPath are mutually exclusive.
+ description: Expanded path within the volume
+ from which the container's volume should
+ be mounted. Behaves similarly to SubPath
+ but environment variable references $(VAR_NAME)
+ are expanded using the container's environment.
+ Defaults to "" (volume's root). SubPathExpr
+ and SubPath are mutually exclusive.
type: string
required:
- mountPath
@@ -1612,11 +1683,10 @@ spec:
type: object
type: array
workingDir:
- description: |-
- Container's working directory.
- If not specified, the container runtime's default will be used, which
- might be configured in the container image.
- Cannot be updated.
+ description: Container's working directory. If not
+ specified, the container runtime's default will
+ be used, which might be configured in the container
+ image. Cannot be updated.
type: string
required:
- name
@@ -1628,47 +1698,51 @@ spec:
ephemeralContainers:
description: EphemeralContainers
items:
- description: |-
- An EphemeralContainer is a temporary container that you may add to an existing Pod for
- user-initiated activities such as debugging. Ephemeral containers have no resource or
- scheduling guarantees, and they will not be restarted when they exit or when a Pod is
- removed or restarted. The kubelet may evict a Pod if an ephemeral container causes the
- Pod to exceed its resource allocation.
-
-
- To add an ephemeral container, use the ephemeralcontainers subresource of an existing
- Pod. Ephemeral containers may not be removed or restarted.
+ description: "An EphemeralContainer is a temporary container
+ that you may add to an existing Pod for user-initiated
+ activities such as debugging. Ephemeral containers
+ have no resource or scheduling guarantees, and they
+ will not be restarted when they exit or when a Pod
+ is removed or restarted. The kubelet may evict a Pod
+ if an ephemeral container causes the Pod to exceed
+ its resource allocation. \n To add an ephemeral container,
+ use the ephemeralcontainers subresource of an existing
+ Pod. Ephemeral containers may not be removed or restarted."
properties:
args:
- description: |-
- Arguments to the entrypoint.
- The image's CMD is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Arguments to the entrypoint. The image''s
+ CMD is used if this is not provided. Variable
+ references $(VAR_NAME) are expanded using the
+ container''s environment. If a variable cannot
+ be resolved, the reference in the input string
+ will be unchanged. Double $$ are reduced to a
+ single $, which allows for escaping the $(VAR_NAME)
+ syntax: i.e. "$$(VAR_NAME)" will produce the string
+ literal "$(VAR_NAME)". Escaped references will
+ never be expanded, regardless of whether the variable
+ exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
command:
- description: |-
- Entrypoint array. Not executed within a shell.
- The image's ENTRYPOINT is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Entrypoint array. Not executed within
+ a shell. The image''s ENTRYPOINT is used if this
+ is not provided. Variable references $(VAR_NAME)
+ are expanded using the container''s environment.
+ If a variable cannot be resolved, the reference
+ in the input string will be unchanged. Double
+ $$ are reduced to a single $, which allows for
+ escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)"
+ will produce the string literal "$(VAR_NAME)".
+ Escaped references will never be expanded, regardless
+ of whether the variable exists or not. Cannot
+ be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
env:
- description: |-
- List of environment variables to set in the container.
- Cannot be updated.
+ description: List of environment variables to set
+ in the container. Cannot be updated.
items:
description: EnvVar represents an environment
variable present in a Container.
@@ -1678,16 +1752,18 @@ spec:
Must be a C_IDENTIFIER.
type: string
value:
- description: |-
- Variable references $(VAR_NAME) are expanded
- using the previously defined environment variables in the container and
- any service environment variables. If a variable cannot be resolved,
- the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
- "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
- Escaped references will never be expanded, regardless of whether the variable
- exists or not.
- Defaults to "".
+ description: 'Variable references $(VAR_NAME)
+ are expanded using the previously defined
+ environment variables in the container and
+ any service environment variables. If a
+ variable cannot be resolved, the reference
+ in the input string will be unchanged. Double
+ $$ are reduced to a single $, which allows
+ for escaping the $(VAR_NAME) syntax: i.e.
+ "$$(VAR_NAME)" will produce the string literal
+ "$(VAR_NAME)". Escaped references will never
+ be expanded, regardless of whether the variable
+ exists or not. Defaults to "".'
type: string
valueFrom:
description: Source for the environment variable's
@@ -1700,10 +1776,10 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
+ description: 'Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
@@ -1712,11 +1788,12 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
fieldRef:
- description: |-
- Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`,
- spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ description: 'Selects a field of the pod:
+ supports metadata.name, metadata.namespace,
+ `metadata.labels['''']`, `metadata.annotations['''']`,
+ spec.nodeName, spec.serviceAccountName,
+ status.hostIP, status.podIP, status.podIPs.'
properties:
apiVersion:
description: Version of the schema
@@ -1730,11 +1807,13 @@ spec:
required:
- fieldPath
type: object
- x-kubernetes-map-type: atomic
resourceFieldRef:
- description: |-
- Selects a resource of the container: only resources limits and requests
- (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
+ description: 'Selects a resource of the
+ container: only resources limits and
+ requests (limits.cpu, limits.memory,
+ limits.ephemeral-storage, requests.cpu,
+ requests.memory and requests.ephemeral-storage)
+ are currently supported.'
properties:
containerName:
description: 'Container name: required
@@ -1756,7 +1835,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret
in the pod's namespace
@@ -1767,10 +1845,10 @@ spec:
secret key.
type: string
name:
- description: |-
- Name of the referent.
+ description: 'Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret
@@ -1779,20 +1857,21 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
required:
- name
type: object
type: array
envFrom:
- description: |-
- List of sources to populate environment variables in the container.
- The keys defined within a source must be a C_IDENTIFIER. All invalid keys
- will be reported as an event when the container is starting. When a key exists in multiple
- sources, the value associated with the last source will take precedence.
- Values defined by an Env with a duplicate key will take precedence.
- Cannot be updated.
+ description: List of sources to populate environment
+ variables in the container. The keys defined within
+ a source must be a C_IDENTIFIER. All invalid keys
+ will be reported as an event when the container
+ is starting. When a key exists in multiple sources,
+ the value associated with the last source will
+ take precedence. Values defined by an Env with
+ a duplicate key will take precedence. Cannot be
+ updated.
items:
description: EnvFromSource represents the source
of a set of ConfigMaps
@@ -1801,17 +1880,16 @@ spec:
description: The ConfigMap to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
prefix:
description: An optional identifier to prepend
to each key in the ConfigMap. Must be a
@@ -1821,54 +1899,55 @@ spec:
description: The Secret to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret
must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
image:
- description: |-
- Container image name.
- More info: https://kubernetes.io/docs/concepts/containers/images
+ description: 'Container image name. More info: https://kubernetes.io/docs/concepts/containers/images'
type: string
imagePullPolicy:
- description: |-
- Image pull policy.
- One of Always, Never, IfNotPresent.
- Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
+ description: 'Image pull policy. One of Always,
+ Never, IfNotPresent. Defaults to Always if :latest
+ tag is specified, or IfNotPresent otherwise. Cannot
+ be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
description: Lifecycle is not allowed for ephemeral
containers.
properties:
postStart:
- description: |-
- PostStart is called immediately after a container is created. If the handler fails,
- the container is terminated and restarted according to its restart policy.
- Other management of the container blocks until the hook completes.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PostStart is called immediately
+ after a container is created. If the handler
+ fails, the container is terminated and restarted
+ according to its restart policy. Other management
+ of the container blocks until the hook completes.
+ More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to
take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command
+ line to execute inside the container,
+ the working directory for the command is
+ root ('/') in the container's filesystem.
+ The command is simply exec'd, it is
+ not run inside a shell, so traditional
+ shell instructions ('|', etc) won't
+ work. To use a shell, you need to
+ explicitly call out to that shell.
+ Exit status of 0 is treated as live/healthy
+ and non-zero is unhealthy.
items:
type: string
type: array
@@ -1878,9 +1957,10 @@ spec:
request to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to,
+ defaults to the pod IP. You probably
+ want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
description: Custom headers to set in
@@ -1892,9 +1972,11 @@ spec:
probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field
+ name. This will be canonicalized
+ upon output, so case-variant
+ names will be understood as
+ the same header.
type: string
value:
description: The header field
@@ -1913,15 +1995,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -1940,10 +2021,12 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT
+ supported as a LifecycleHandler and kept
+ for the backward compatibility. There
+ are no validation of this field and lifecycle
+ hooks will fail in runtime when tcp handler
+ is specified.
properties:
host:
description: 'Optional: Host name to
@@ -1953,38 +2036,47 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
preStop:
- description: |-
- PreStop is called immediately before a container is terminated due to an
- API request or management event such as liveness/startup probe failure,
- preemption, resource contention, etc. The handler is not called if the
- container crashes or exits. The Pod's termination grace period countdown begins before the
- PreStop hook is executed. Regardless of the outcome of the handler, the
- container will eventually terminate within the Pod's termination grace
- period (unless delayed by finalizers). Other management of the container blocks until the hook completes
- or until the termination grace period is reached.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PreStop is called immediately
+ before a container is terminated due to an
+ API request or management event such as liveness/startup
+ probe failure, preemption, resource contention,
+ etc. The handler is not called if the container
+ crashes or exits. The Pod''s termination grace
+ period countdown begins before the PreStop
+ hook is executed. Regardless of the outcome
+ of the handler, the container will eventually
+ terminate within the Pod''s termination grace
+ period (unless delayed by finalizers). Other
+ management of the container blocks until the
+ hook completes or until the termination grace
+ period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to
take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command
+ line to execute inside the container,
+ the working directory for the command is
+ root ('/') in the container's filesystem.
+ The command is simply exec'd, it is
+ not run inside a shell, so traditional
+ shell instructions ('|', etc) won't
+ work. To use a shell, you need to
+ explicitly call out to that shell.
+ Exit status of 0 is treated as live/healthy
+ and non-zero is unhealthy.
items:
type: string
type: array
@@ -1994,9 +2086,10 @@ spec:
request to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to,
+ defaults to the pod IP. You probably
+ want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
description: Custom headers to set in
@@ -2008,9 +2101,11 @@ spec:
probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field
+ name. This will be canonicalized
+ upon output, so case-variant
+ names will be understood as
+ the same header.
type: string
value:
description: The header field
@@ -2029,15 +2124,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -2056,10 +2150,12 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT
+ supported as a LifecycleHandler and kept
+ for the backward compatibility. There
+ are no validation of this field and lifecycle
+ hooks will fail in runtime when tcp handler
+ is specified.
properties:
host:
description: 'Optional: Host name to
@@ -2069,10 +2165,10 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
@@ -2087,20 +2183,25 @@ spec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -2113,12 +2214,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -2128,8 +2228,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -2140,9 +2240,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -2160,35 +2261,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -2203,40 +2304,46 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
name:
- description: |-
- Name of the ephemeral container specified as a DNS_LABEL.
- This name must be unique among all containers, init containers and ephemeral containers.
+ description: Name of the ephemeral container specified
+ as a DNS_LABEL. This name must be unique among
+ all containers, init containers and ephemeral
+ containers.
type: string
ports:
description: Ports are not allowed for ephemeral
@@ -2246,9 +2353,9 @@ spec:
port in a single container.
properties:
containerPort:
- description: |-
- Number of port to expose on the pod's IP address.
- This must be a valid port number, 0 < x < 65536.
+ description: Number of port to expose on the
+ pod's IP address. This must be a valid port
+ number, 0 < x < 65536.
format: int32
type: integer
hostIP:
@@ -2256,24 +2363,24 @@ spec:
port to.
type: string
hostPort:
- description: |-
- Number of port to expose on the host.
- If specified, this must be a valid port number, 0 < x < 65536.
- If HostNetwork is specified, this must match ContainerPort.
+ description: Number of port to expose on the
+ host. If specified, this must be a valid
+ port number, 0 < x < 65536. If HostNetwork
+ is specified, this must match ContainerPort.
Most containers do not need this.
format: int32
type: integer
name:
- description: |-
- If specified, this must be an IANA_SVC_NAME and unique within the pod. Each
- named port in a pod must have a unique name. Name for the port that can be
- referred to by services.
+ description: If specified, this must be an
+ IANA_SVC_NAME and unique within the pod.
+ Each named port in a pod must have a unique
+ name. Name for the port that can be referred
+ to by services.
type: string
protocol:
default: TCP
- description: |-
- Protocol for port. Must be UDP, TCP, or SCTP.
- Defaults to "TCP".
+ description: Protocol for port. Must be UDP,
+ TCP, or SCTP. Defaults to "TCP".
type: string
required:
- containerPort
@@ -2291,20 +2398,25 @@ spec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -2317,12 +2429,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -2332,8 +2443,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -2344,9 +2455,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -2364,35 +2476,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -2407,33 +2519,38 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
@@ -2444,14 +2561,14 @@ spec:
resource resize policy for the container.
properties:
resourceName:
- description: |-
- Name of the resource to which this resource resize policy applies.
- Supported values: cpu, memory.
+ description: 'Name of the resource to which
+ this resource resize policy applies. Supported
+ values: cpu, memory.'
type: string
restartPolicy:
- description: |-
- Restart policy to apply when specified resource is resized.
- If not specified, it defaults to NotRequired.
+ description: Restart policy to apply when
+ specified resource is resized. If not specified,
+ it defaults to NotRequired.
type: string
required:
- resourceName
@@ -2460,30 +2577,27 @@ spec:
type: array
x-kubernetes-list-type: atomic
resources:
- description: |-
- Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources
+ description: Resources are not allowed for ephemeral
+ containers. Ephemeral containers use spare resources
already allocated to the pod.
properties:
claims:
- description: |-
- Claims lists the names of resources, defined in spec.resourceClaims,
- that are used by this container.
-
-
- This is an alpha field and requires enabling the
- DynamicResourceAllocation feature gate.
-
-
- This field is immutable. It can only be set for containers.
+ description: "Claims lists the names of resources,
+ defined in spec.resourceClaims, that are used
+ by this container. \n This is an alpha field
+ and requires enabling the DynamicResourceAllocation
+ feature gate. \n This field is immutable.
+ It can only be set for containers."
items:
description: ResourceClaim references one
entry in PodSpec.ResourceClaims.
properties:
name:
- description: |-
- Name must match the name of one entry in pod.spec.resourceClaims of
- the Pod where this field is used. It makes that resource available
- inside a container.
+ description: Name must match the name
+ of one entry in pod.spec.resourceClaims
+ of the Pod where this field is used.
+ It makes that resource available inside
+ a container.
type: string
required:
- name
@@ -2499,9 +2613,8 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Limits describes the maximum amount of compute resources allowed.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Limits describes the maximum amount
+ of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -2510,40 +2623,43 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Requests describes the minimum amount of compute resources required.
- If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
- otherwise to an implementation-defined value. Requests cannot exceed Limits.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Requests describes the minimum
+ amount of compute resources required. If Requests
+ is omitted for a container, it defaults to
+ Limits if that is explicitly specified, otherwise
+ to an implementation-defined value. Requests
+ cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
restartPolicy:
- description: |-
- Restart policy for the container to manage the restart behavior of each
- container within a pod.
- This may only be set for init containers. You cannot set this field on
- ephemeral containers.
+ description: Restart policy for the container to
+ manage the restart behavior of each container
+ within a pod. This may only be set for init containers.
+ You cannot set this field on ephemeral containers.
type: string
securityContext:
- description: |-
- Optional: SecurityContext defines the security options the ephemeral container should be run with.
- If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
+ description: 'Optional: SecurityContext defines
+ the security options the ephemeral container should
+ be run with. If set, the fields of SecurityContext
+ override the equivalent fields of PodSecurityContext.'
properties:
allowPrivilegeEscalation:
- description: |-
- AllowPrivilegeEscalation controls whether a process can gain more
- privileges than its parent process. This bool directly controls if
- the no_new_privs flag will be set on the container process.
- AllowPrivilegeEscalation is true always when the container is:
- 1) run as Privileged
- 2) has CAP_SYS_ADMIN
- Note that this field cannot be set when spec.os.name is windows.
+ description: 'AllowPrivilegeEscalation controls
+ whether a process can gain more privileges
+ than its parent process. This bool directly
+ controls if the no_new_privs flag will be
+ set on the container process. AllowPrivilegeEscalation
+ is true always when the container is: 1) run
+ as Privileged 2) has CAP_SYS_ADMIN Note that
+ this field cannot be set when spec.os.name
+ is windows.'
type: boolean
capabilities:
- description: |-
- The capabilities to add/drop when running containers.
- Defaults to the default set of capabilities granted by the container runtime.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The capabilities to add/drop when
+ running containers. Defaults to the default
+ set of capabilities granted by the container
+ runtime. Note that this field cannot be set
+ when spec.os.name is windows.
properties:
add:
description: Added capabilities
@@ -2561,60 +2677,69 @@ spec:
type: array
type: object
privileged:
- description: |-
- Run container in privileged mode.
- Processes in privileged containers are essentially equivalent to root on the host.
- Defaults to false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Run container in privileged mode.
+ Processes in privileged containers are essentially
+ equivalent to root on the host. Defaults to
+ false. Note that this field cannot be set
+ when spec.os.name is windows.
type: boolean
procMount:
- description: |-
- procMount denotes the type of proc mount to use for the containers.
- The default is DefaultProcMount which uses the container runtime defaults for
- readonly paths and masked paths.
- This requires the ProcMountType feature flag to be enabled.
- Note that this field cannot be set when spec.os.name is windows.
+ description: procMount denotes the type of proc
+ mount to use for the containers. The default
+ is DefaultProcMount which uses the container
+ runtime defaults for readonly paths and masked
+ paths. This requires the ProcMountType feature
+ flag to be enabled. Note that this field cannot
+ be set when spec.os.name is windows.
type: string
readOnlyRootFilesystem:
- description: |-
- Whether this container has a read-only root filesystem.
- Default is false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Whether this container has a read-only
+ root filesystem. Default is false. Note that
+ this field cannot be set when spec.os.name
+ is windows.
type: boolean
runAsGroup:
- description: |-
- The GID to run the entrypoint of the container process.
- Uses runtime default if unset.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The GID to run the entrypoint of
+ the container process. Uses runtime default
+ if unset. May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is windows.
format: int64
type: integer
runAsNonRoot:
- description: |-
- Indicates that the container must run as a non-root user.
- If true, the Kubelet will validate the image at runtime to ensure that it
- does not run as UID 0 (root) and fail to start the container if it does.
- If unset or false, no such validation will be performed.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: Indicates that the container must
+ run as a non-root user. If true, the Kubelet
+ will validate the image at runtime to ensure
+ that it does not run as UID 0 (root) and fail
+ to start the container if it does. If unset
+ or false, no such validation will be performed.
+ May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence.
type: boolean
runAsUser:
- description: |-
- The UID to run the entrypoint of the container process.
- Defaults to user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The UID to run the entrypoint of
+ the container process. Defaults to user specified
+ in image metadata if unspecified. May also
+ be set in PodSecurityContext. If set in both
+ SecurityContext and PodSecurityContext, the
+ value specified in SecurityContext takes precedence.
+ Note that this field cannot be set when spec.os.name
+ is windows.
format: int64
type: integer
seLinuxOptions:
- description: |-
- The SELinux context to be applied to the container.
- If unspecified, the container runtime will allocate a random SELinux context for each
- container. May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The SELinux context to be applied
+ to the container. If unspecified, the container
+ runtime will allocate a random SELinux context
+ for each container. May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is windows.
properties:
level:
description: Level is SELinux level label
@@ -2634,62 +2759,74 @@ spec:
type: string
type: object
seccompProfile:
- description: |-
- The seccomp options to use by this container. If seccomp options are
- provided at both the pod & container level, the container options
- override the pod options.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The seccomp options to use by this
+ container. If seccomp options are provided
+ at both the pod & container level, the container
+ options override the pod options. Note that
+ this field cannot be set when spec.os.name
+ is windows.
properties:
localhostProfile:
- description: |-
- localhostProfile indicates a profile defined in a file on the node should be used.
- The profile must be preconfigured on the node to work.
- Must be a descending path, relative to the kubelet's configured seccomp profile location.
- Must be set if type is "Localhost". Must NOT be set for any other type.
+ description: localhostProfile indicates
+ a profile defined in a file on the node
+ should be used. The profile must be preconfigured
+ on the node to work. Must be a descending
+ path, relative to the kubelet's configured
+ seccomp profile location. Must be set
+ if type is "Localhost". Must NOT be set
+ for any other type.
type: string
type:
- description: |-
- type indicates which kind of seccomp profile will be applied.
- Valid options are:
-
-
- Localhost - a profile defined in a file on the node should be used.
- RuntimeDefault - the container runtime default profile should be used.
- Unconfined - no profile should be applied.
+ description: "type indicates which kind
+ of seccomp profile will be applied. Valid
+ options are: \n Localhost - a profile
+ defined in a file on the node should be
+ used. RuntimeDefault - the container runtime
+ default profile should be used. Unconfined
+ - no profile should be applied."
type: string
required:
- type
type: object
windowsOptions:
- description: |-
- The Windows specific settings applied to all containers.
- If unspecified, the options from the PodSecurityContext will be used.
- If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is linux.
+ description: The Windows specific settings applied
+ to all containers. If unspecified, the options
+ from the PodSecurityContext will be used.
+ If set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is linux.
properties:
gmsaCredentialSpec:
- description: |-
- GMSACredentialSpec is where the GMSA admission webhook
- (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
- GMSA credential spec named by the GMSACredentialSpecName field.
+ description: GMSACredentialSpec is where
+ the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa)
+ inlines the contents of the GMSA credential
+ spec named by the GMSACredentialSpecName
+ field.
type: string
gmsaCredentialSpecName:
description: GMSACredentialSpecName is the
name of the GMSA credential spec to use.
type: string
hostProcess:
- description: |-
- HostProcess determines if a container should be run as a 'Host Process' container.
- All of a Pod's containers must have the same effective HostProcess value
- (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
- In addition, if HostProcess is true then HostNetwork must also be set to true.
+ description: HostProcess determines if a
+ container should be run as a 'Host Process'
+ container. All of a Pod's containers must
+ have the same effective HostProcess value
+ (it is not allowed to have a mix of HostProcess
+ containers and non-HostProcess containers).
+ In addition, if HostProcess is true then
+ HostNetwork must also be set to true.
type: boolean
runAsUserName:
- description: |-
- The UserName in Windows to run the entrypoint of the container process.
- Defaults to the user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: The UserName in Windows to
+ run the entrypoint of the container process.
+ Defaults to the user specified in image
+ metadata if unspecified. May also be set
+ in PodSecurityContext. If set in both
+ SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext
+ takes precedence.
type: string
type: object
type: object
@@ -2701,20 +2838,25 @@ spec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -2727,12 +2869,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -2742,8 +2883,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -2754,9 +2895,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -2774,35 +2916,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -2817,86 +2959,98 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
stdin:
- description: |-
- Whether this container should allocate a buffer for stdin in the container runtime. If this
- is not set, reads from stdin in the container will always result in EOF.
- Default is false.
+ description: Whether this container should allocate
+ a buffer for stdin in the container runtime. If
+ this is not set, reads from stdin in the container
+ will always result in EOF. Default is false.
type: boolean
stdinOnce:
- description: |-
- Whether the container runtime should close the stdin channel after it has been opened by
- a single attach. When stdin is true the stdin stream will remain open across multiple attach
- sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
- first client attaches to stdin, and then remains open and accepts data until the client disconnects,
- at which time stdin is closed and remains closed until the container is restarted. If this
- flag is false, a container processes that reads from stdin will never receive an EOF.
- Default is false
+ description: Whether the container runtime should
+ close the stdin channel after it has been opened
+ by a single attach. When stdin is true the stdin
+ stream will remain open across multiple attach
+ sessions. If stdinOnce is set to true, stdin is
+ opened on container start, is empty until the
+ first client attaches to stdin, and then remains
+ open and accepts data until the client disconnects,
+ at which time stdin is closed and remains closed
+ until the container is restarted. If this flag
+ is false, a container processes that reads from
+ stdin will never receive an EOF. Default is false
type: boolean
targetContainerName:
- description: |-
- If set, the name of the container from PodSpec that this ephemeral container targets.
- The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container.
- If not set then the ephemeral container uses the namespaces configured in the Pod spec.
-
-
- The container runtime must implement support for this feature. If the runtime does not
- support namespace targeting then the result of setting this field is undefined.
+ description: "If set, the name of the container
+ from PodSpec that this ephemeral container targets.
+ The ephemeral container will be run in the namespaces
+ (IPC, PID, etc) of this container. If not set
+ then the ephemeral container uses the namespaces
+ configured in the Pod spec. \n The container runtime
+ must implement support for this feature. If the
+ runtime does not support namespace targeting then
+ the result of setting this field is undefined."
type: string
terminationMessagePath:
- description: |-
- Optional: Path at which the file to which the container's termination message
- will be written is mounted into the container's filesystem.
- Message written is intended to be brief final status, such as an assertion failure message.
- Will be truncated by the node if greater than 4096 bytes. The total message length across
- all containers will be limited to 12kb.
- Defaults to /dev/termination-log.
- Cannot be updated.
+ description: 'Optional: Path at which the file to
+ which the container''s termination message will
+ be written is mounted into the container''s filesystem.
+ Message written is intended to be brief final
+ status, such as an assertion failure message.
+ Will be truncated by the node if greater than
+ 4096 bytes. The total message length across all
+ containers will be limited to 12kb. Defaults to
+ /dev/termination-log. Cannot be updated.'
type: string
terminationMessagePolicy:
- description: |-
- Indicate how the termination message should be populated. File will use the contents of
- terminationMessagePath to populate the container status message on both success and failure.
- FallbackToLogsOnError will use the last chunk of container log output if the termination
- message file is empty and the container exited with an error.
- The log output is limited to 2048 bytes or 80 lines, whichever is smaller.
- Defaults to File.
- Cannot be updated.
+ description: Indicate how the termination message
+ should be populated. File will use the contents
+ of terminationMessagePath to populate the container
+ status message on both success and failure. FallbackToLogsOnError
+ will use the last chunk of container log output
+ if the termination message file is empty and the
+ container exited with an error. The log output
+ is limited to 2048 bytes or 80 lines, whichever
+ is smaller. Defaults to File. Cannot be updated.
type: string
tty:
- description: |-
- Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
- Default is false.
+ description: Whether this container should allocate
+ a TTY for itself, also requires 'stdin' to be
+ true. Default is false.
type: boolean
volumeDevices:
description: volumeDevices is the list of block
@@ -2920,45 +3074,47 @@ spec:
type: object
type: array
volumeMounts:
- description: |-
- Pod volumes to mount into the container's filesystem. Subpath mounts are not allowed for ephemeral containers.
- Cannot be updated.
+ description: Pod volumes to mount into the container's
+ filesystem. Subpath mounts are not allowed for
+ ephemeral containers. Cannot be updated.
items:
description: VolumeMount describes a mounting
of a Volume within a container.
properties:
mountPath:
- description: |-
- Path within the container at which the volume should be mounted. Must
+ description: Path within the container at
+ which the volume should be mounted. Must
not contain ':'.
type: string
mountPropagation:
- description: |-
- mountPropagation determines how mounts are propagated from the host
- to container and the other way around.
- When not set, MountPropagationNone is used.
- This field is beta in 1.10.
+ description: mountPropagation determines how
+ mounts are propagated from the host to container
+ and the other way around. When not set,
+ MountPropagationNone is used. This field
+ is beta in 1.10.
type: string
name:
description: This must match the Name of a
Volume.
type: string
readOnly:
- description: |-
- Mounted read-only if true, read-write otherwise (false or unspecified).
- Defaults to false.
+ description: Mounted read-only if true, read-write
+ otherwise (false or unspecified). Defaults
+ to false.
type: boolean
subPath:
- description: |-
- Path within the volume from which the container's volume should be mounted.
+ description: Path within the volume from which
+ the container's volume should be mounted.
Defaults to "" (volume's root).
type: string
subPathExpr:
- description: |-
- Expanded path within the volume from which the container's volume should be mounted.
- Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.
- Defaults to "" (volume's root).
- SubPathExpr and SubPath are mutually exclusive.
+ description: Expanded path within the volume
+ from which the container's volume should
+ be mounted. Behaves similarly to SubPath
+ but environment variable references $(VAR_NAME)
+ are expanded using the container's environment.
+ Defaults to "" (volume's root). SubPathExpr
+ and SubPath are mutually exclusive.
type: string
required:
- mountPath
@@ -2966,11 +3122,10 @@ spec:
type: object
type: array
workingDir:
- description: |-
- Container's working directory.
- If not specified, the container runtime's default will be used, which
- might be configured in the container image.
- Cannot be updated.
+ description: Container's working directory. If not
+ specified, the container runtime's default will
+ be used, which might be configured in the container
+ image. Cannot be updated.
type: string
required:
- name
@@ -2983,35 +3138,39 @@ spec:
want to run within a pod.
properties:
args:
- description: |-
- Arguments to the entrypoint.
- The container image's CMD is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Arguments to the entrypoint. The container
+ image''s CMD is used if this is not provided.
+ Variable references $(VAR_NAME) are expanded using
+ the container''s environment. If a variable cannot
+ be resolved, the reference in the input string
+ will be unchanged. Double $$ are reduced to a
+ single $, which allows for escaping the $(VAR_NAME)
+ syntax: i.e. "$$(VAR_NAME)" will produce the string
+ literal "$(VAR_NAME)". Escaped references will
+ never be expanded, regardless of whether the variable
+ exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
command:
- description: |-
- Entrypoint array. Not executed within a shell.
- The container image's ENTRYPOINT is used if this is not provided.
- Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
- cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
- produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
- of whether the variable exists or not. Cannot be updated.
- More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+ description: 'Entrypoint array. Not executed within
+ a shell. The container image''s ENTRYPOINT is
+ used if this is not provided. Variable references
+ $(VAR_NAME) are expanded using the container''s
+ environment. If a variable cannot be resolved,
+ the reference in the input string will be unchanged.
+ Double $$ are reduced to a single $, which allows
+ for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)"
+ will produce the string literal "$(VAR_NAME)".
+ Escaped references will never be expanded, regardless
+ of whether the variable exists or not. Cannot
+ be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell'
items:
type: string
type: array
env:
- description: |-
- List of environment variables to set in the container.
- Cannot be updated.
+ description: List of environment variables to set
+ in the container. Cannot be updated.
items:
description: EnvVar represents an environment
variable present in a Container.
@@ -3021,16 +3180,18 @@ spec:
Must be a C_IDENTIFIER.
type: string
value:
- description: |-
- Variable references $(VAR_NAME) are expanded
- using the previously defined environment variables in the container and
- any service environment variables. If a variable cannot be resolved,
- the reference in the input string will be unchanged. Double $$ are reduced
- to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
- "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
- Escaped references will never be expanded, regardless of whether the variable
- exists or not.
- Defaults to "".
+ description: 'Variable references $(VAR_NAME)
+ are expanded using the previously defined
+ environment variables in the container and
+ any service environment variables. If a
+ variable cannot be resolved, the reference
+ in the input string will be unchanged. Double
+ $$ are reduced to a single $, which allows
+ for escaping the $(VAR_NAME) syntax: i.e.
+ "$$(VAR_NAME)" will produce the string literal
+ "$(VAR_NAME)". Escaped references will never
+ be expanded, regardless of whether the variable
+ exists or not. Defaults to "".'
type: string
valueFrom:
description: Source for the environment variable's
@@ -3043,10 +3204,10 @@ spec:
description: The key to select.
type: string
name:
- description: |-
- Name of the referent.
+ description: 'Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
@@ -3055,11 +3216,12 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
fieldRef:
- description: |-
- Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`,
- spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ description: 'Selects a field of the pod:
+ supports metadata.name, metadata.namespace,
+ `metadata.labels['''']`, `metadata.annotations['''']`,
+ spec.nodeName, spec.serviceAccountName,
+ status.hostIP, status.podIP, status.podIPs.'
properties:
apiVersion:
description: Version of the schema
@@ -3073,11 +3235,13 @@ spec:
required:
- fieldPath
type: object
- x-kubernetes-map-type: atomic
resourceFieldRef:
- description: |-
- Selects a resource of the container: only resources limits and requests
- (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
+ description: 'Selects a resource of the
+ container: only resources limits and
+ requests (limits.cpu, limits.memory,
+ limits.ephemeral-storage, requests.cpu,
+ requests.memory and requests.ephemeral-storage)
+ are currently supported.'
properties:
containerName:
description: 'Container name: required
@@ -3099,7 +3263,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret
in the pod's namespace
@@ -3110,10 +3273,10 @@ spec:
secret key.
type: string
name:
- description: |-
- Name of the referent.
+ description: 'Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret
@@ -3122,20 +3285,21 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
required:
- name
type: object
type: array
envFrom:
- description: |-
- List of sources to populate environment variables in the container.
- The keys defined within a source must be a C_IDENTIFIER. All invalid keys
- will be reported as an event when the container is starting. When a key exists in multiple
- sources, the value associated with the last source will take precedence.
- Values defined by an Env with a duplicate key will take precedence.
- Cannot be updated.
+ description: List of sources to populate environment
+ variables in the container. The keys defined within
+ a source must be a C_IDENTIFIER. All invalid keys
+ will be reported as an event when the container
+ is starting. When a key exists in multiple sources,
+ the value associated with the last source will
+ take precedence. Values defined by an Env with
+ a duplicate key will take precedence. Cannot be
+ updated.
items:
description: EnvFromSource represents the source
of a set of ConfigMaps
@@ -3144,17 +3308,16 @@ spec:
description: The ConfigMap to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap
must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
prefix:
description: An optional identifier to prepend
to each key in the ConfigMap. Must be a
@@ -3164,57 +3327,59 @@ spec:
description: The Secret to select from
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: Specify whether the Secret
must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
image:
- description: |-
- Container image name.
- More info: https://kubernetes.io/docs/concepts/containers/images
- This field is optional to allow higher level config management to default or override
- container images in workload controllers like Deployments and StatefulSets.
+ description: 'Container image name. More info: https://kubernetes.io/docs/concepts/containers/images
+ This field is optional to allow higher level config
+ management to default or override container images
+ in workload controllers like Deployments and StatefulSets.'
type: string
imagePullPolicy:
- description: |-
- Image pull policy.
- One of Always, Never, IfNotPresent.
- Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
+ description: 'Image pull policy. One of Always,
+ Never, IfNotPresent. Defaults to Always if :latest
+ tag is specified, or IfNotPresent otherwise. Cannot
+ be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
- description: |-
- Actions that the management system should take in response to container lifecycle events.
- Cannot be updated.
+ description: Actions that the management system
+ should take in response to container lifecycle
+ events. Cannot be updated.
properties:
postStart:
- description: |-
- PostStart is called immediately after a container is created. If the handler fails,
- the container is terminated and restarted according to its restart policy.
- Other management of the container blocks until the hook completes.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PostStart is called immediately
+ after a container is created. If the handler
+ fails, the container is terminated and restarted
+ according to its restart policy. Other management
+ of the container blocks until the hook completes.
+ More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to
take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command
+ line to execute inside the container,
+ the working directory for the command is
+ root ('/') in the container's filesystem.
+ The command is simply exec'd, it is
+ not run inside a shell, so traditional
+ shell instructions ('|', etc) won't
+ work. To use a shell, you need to
+ explicitly call out to that shell.
+ Exit status of 0 is treated as live/healthy
+ and non-zero is unhealthy.
items:
type: string
type: array
@@ -3224,9 +3389,10 @@ spec:
request to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to,
+ defaults to the pod IP. You probably
+ want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
description: Custom headers to set in
@@ -3238,9 +3404,11 @@ spec:
probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field
+ name. This will be canonicalized
+ upon output, so case-variant
+ names will be understood as
+ the same header.
type: string
value:
description: The header field
@@ -3259,15 +3427,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -3286,10 +3453,12 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT
+ supported as a LifecycleHandler and kept
+ for the backward compatibility. There
+ are no validation of this field and lifecycle
+ hooks will fail in runtime when tcp handler
+ is specified.
properties:
host:
description: 'Optional: Host name to
@@ -3299,38 +3468,47 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
preStop:
- description: |-
- PreStop is called immediately before a container is terminated due to an
- API request or management event such as liveness/startup probe failure,
- preemption, resource contention, etc. The handler is not called if the
- container crashes or exits. The Pod's termination grace period countdown begins before the
- PreStop hook is executed. Regardless of the outcome of the handler, the
- container will eventually terminate within the Pod's termination grace
- period (unless delayed by finalizers). Other management of the container blocks until the hook completes
- or until the termination grace period is reached.
- More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+ description: 'PreStop is called immediately
+ before a container is terminated due to an
+ API request or management event such as liveness/startup
+ probe failure, preemption, resource contention,
+ etc. The handler is not called if the container
+ crashes or exits. The Pod''s termination grace
+ period countdown begins before the PreStop
+ hook is executed. Regardless of the outcome
+ of the handler, the container will eventually
+ terminate within the Pod''s termination grace
+ period (unless delayed by finalizers). Other
+ management of the container blocks until the
+ hook completes or until the termination grace
+ period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks'
properties:
exec:
description: Exec specifies the action to
take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command
+ line to execute inside the container,
+ the working directory for the command is
+ root ('/') in the container's filesystem.
+ The command is simply exec'd, it is
+ not run inside a shell, so traditional
+ shell instructions ('|', etc) won't
+ work. To use a shell, you need to
+ explicitly call out to that shell.
+ Exit status of 0 is treated as live/healthy
+ and non-zero is unhealthy.
items:
type: string
type: array
@@ -3340,9 +3518,10 @@ spec:
request to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
- "Host" in httpHeaders instead.
+ description: Host name to connect to,
+ defaults to the pod IP. You probably
+ want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
description: Custom headers to set in
@@ -3354,9 +3533,11 @@ spec:
probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field
+ name. This will be canonicalized
+ upon output, so case-variant
+ names will be understood as
+ the same header.
type: string
value:
description: The header field
@@ -3375,15 +3556,14 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
@@ -3402,10 +3582,12 @@ spec:
- seconds
type: object
tcpSocket:
- description: |-
- Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
- for the backward compatibility. There are no validation of this field and
- lifecycle hooks will fail in runtime when tcp handler is specified.
+ description: Deprecated. TCPSocket is NOT
+ supported as a LifecycleHandler and kept
+ for the backward compatibility. There
+ are no validation of this field and lifecycle
+ hooks will fail in runtime when tcp handler
+ is specified.
properties:
host:
description: 'Optional: Host name to
@@ -3415,10 +3597,10 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number
+ must be in the range 1 to 65535. Name
+ must be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
@@ -3426,30 +3608,33 @@ spec:
type: object
type: object
livenessProbe:
- description: |-
- Periodic probe of container liveness.
+ 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
+ Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -3462,12 +3647,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -3477,8 +3661,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -3489,9 +3673,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -3509,35 +3694,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -3552,59 +3737,63 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
name:
- description: |-
- Name of the container specified as a DNS_LABEL.
- Each container in a pod must have a unique name (DNS_LABEL).
- Cannot be updated.
+ description: Name of the container specified as
+ a DNS_LABEL. Each container in a pod must have
+ a unique name (DNS_LABEL). Cannot be updated.
type: string
ports:
- description: |-
- List of ports to expose from the container. Not specifying a port here
- DOES NOT prevent that port from being exposed. Any port which is
- listening on the default "0.0.0.0" address inside a container will be
- accessible from the network.
- Modifying this array with strategic merge patch may corrupt the data.
- For more information See https://github.com/kubernetes/kubernetes/issues/108255.
+ description: List of ports to expose from the container.
+ Not specifying a port here DOES NOT prevent that
+ port from being exposed. Any port which is listening
+ on the default "0.0.0.0" address inside a container
+ will be accessible from the network. Modifying
+ this array with strategic merge patch may corrupt
+ the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255.
Cannot be updated.
items:
description: ContainerPort represents a network
port in a single container.
properties:
containerPort:
- description: |-
- Number of port to expose on the pod's IP address.
- This must be a valid port number, 0 < x < 65536.
+ description: Number of port to expose on the
+ pod's IP address. This must be a valid port
+ number, 0 < x < 65536.
format: int32
type: integer
hostIP:
@@ -3612,24 +3801,24 @@ spec:
port to.
type: string
hostPort:
- description: |-
- Number of port to expose on the host.
- If specified, this must be a valid port number, 0 < x < 65536.
- If HostNetwork is specified, this must match ContainerPort.
+ description: Number of port to expose on the
+ host. If specified, this must be a valid
+ port number, 0 < x < 65536. If HostNetwork
+ is specified, this must match ContainerPort.
Most containers do not need this.
format: int32
type: integer
name:
- description: |-
- If specified, this must be an IANA_SVC_NAME and unique within the pod. Each
- named port in a pod must have a unique name. Name for the port that can be
- referred to by services.
+ description: If specified, this must be an
+ IANA_SVC_NAME and unique within the pod.
+ Each named port in a pod must have a unique
+ name. Name for the port that can be referred
+ to by services.
type: string
protocol:
default: TCP
- description: |-
- Protocol for port. Must be UDP, TCP, or SCTP.
- Defaults to "TCP".
+ description: Protocol for port. Must be UDP,
+ TCP, or SCTP. Defaults to "TCP".
type: string
required:
- containerPort
@@ -3640,30 +3829,34 @@ spec:
- protocol
x-kubernetes-list-type: map
readinessProbe:
- description: |-
- Periodic probe of container service readiness.
- Container will be removed from service endpoints if the probe fails.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Periodic probe of container service
+ readiness. Container will be removed from service
+ endpoints if the probe fails. Cannot be updated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -3676,12 +3869,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -3691,8 +3883,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -3703,9 +3895,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -3723,35 +3916,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -3766,33 +3959,38 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
@@ -3803,14 +4001,14 @@ spec:
resource resize policy for the container.
properties:
resourceName:
- description: |-
- Name of the resource to which this resource resize policy applies.
- Supported values: cpu, memory.
+ description: 'Name of the resource to which
+ this resource resize policy applies. Supported
+ values: cpu, memory.'
type: string
restartPolicy:
- description: |-
- Restart policy to apply when specified resource is resized.
- If not specified, it defaults to NotRequired.
+ description: Restart policy to apply when
+ specified resource is resized. If not specified,
+ it defaults to NotRequired.
type: string
required:
- resourceName
@@ -3819,31 +4017,26 @@ spec:
type: array
x-kubernetes-list-type: atomic
resources:
- description: |-
- Compute Resources required by this container.
- Cannot be updated.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Compute Resources required by this
+ container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
properties:
claims:
- description: |-
- Claims lists the names of resources, defined in spec.resourceClaims,
- that are used by this container.
-
-
- This is an alpha field and requires enabling the
- DynamicResourceAllocation feature gate.
-
-
- This field is immutable. It can only be set for containers.
+ description: "Claims lists the names of resources,
+ defined in spec.resourceClaims, that are used
+ by this container. \n This is an alpha field
+ and requires enabling the DynamicResourceAllocation
+ feature gate. \n This field is immutable.
+ It can only be set for containers."
items:
description: ResourceClaim references one
entry in PodSpec.ResourceClaims.
properties:
name:
- description: |-
- Name must match the name of one entry in pod.spec.resourceClaims of
- the Pod where this field is used. It makes that resource available
- inside a container.
+ description: Name must match the name
+ of one entry in pod.spec.resourceClaims
+ of the Pod where this field is used.
+ It makes that resource available inside
+ a container.
type: string
required:
- name
@@ -3859,9 +4052,8 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Limits describes the maximum amount of compute resources allowed.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Limits describes the maximum amount
+ of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -3870,52 +4062,61 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Requests describes the minimum amount of compute resources required.
- If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
- otherwise to an implementation-defined value. Requests cannot exceed Limits.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Requests describes the minimum
+ amount of compute resources required. If Requests
+ is omitted for a container, it defaults to
+ Limits if that is explicitly specified, otherwise
+ to an implementation-defined value. Requests
+ cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
restartPolicy:
- description: |-
- RestartPolicy defines the restart behavior of individual containers in a pod.
- This field may only be set for init containers, and the only allowed value is "Always".
- For non-init containers or when this field is not specified,
- the restart behavior is defined by the Pod's restart policy and the container type.
- Setting the RestartPolicy as "Always" for the init container will have the following effect:
- this init container will be continually restarted on
- exit until all regular containers have terminated. Once all regular
- containers have completed, all init containers with restartPolicy "Always"
- will be shut down. This lifecycle differs from normal init containers and
- is often referred to as a "sidecar" container. Although this init
- container still starts in the init container sequence, it does not wait
- for the container to complete before proceeding to the next init
- container. Instead, the next init container starts immediately after this
- init container is started, or after any startupProbe has successfully
- completed.
+ description: 'RestartPolicy defines the restart
+ behavior of individual containers in a pod. This
+ field may only be set for init containers, and
+ the only allowed value is "Always". For non-init
+ containers or when this field is not specified,
+ the restart behavior is defined by the Pod''s
+ restart policy and the container type. Setting
+ the RestartPolicy as "Always" for the init container
+ will have the following effect: this init container
+ will be continually restarted on exit until all
+ regular containers have terminated. Once all regular
+ containers have completed, all init containers
+ with restartPolicy "Always" will be shut down.
+ This lifecycle differs from normal init containers
+ and is often referred to as a "sidecar" container.
+ Although this init container still starts in the
+ init container sequence, it does not wait for
+ the container to complete before proceeding to
+ the next init container. Instead, the next init
+ container starts immediately after this init container
+ is started, or after any startupProbe has successfully
+ completed.'
type: string
securityContext:
- description: |-
- SecurityContext defines the security options the container should be run with.
- If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
- More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
+ description: 'SecurityContext defines the security
+ options the container should be run with. If set,
+ the fields of SecurityContext override the equivalent
+ fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
properties:
allowPrivilegeEscalation:
- description: |-
- AllowPrivilegeEscalation controls whether a process can gain more
- privileges than its parent process. This bool directly controls if
- the no_new_privs flag will be set on the container process.
- AllowPrivilegeEscalation is true always when the container is:
- 1) run as Privileged
- 2) has CAP_SYS_ADMIN
- Note that this field cannot be set when spec.os.name is windows.
+ description: 'AllowPrivilegeEscalation controls
+ whether a process can gain more privileges
+ than its parent process. This bool directly
+ controls if the no_new_privs flag will be
+ set on the container process. AllowPrivilegeEscalation
+ is true always when the container is: 1) run
+ as Privileged 2) has CAP_SYS_ADMIN Note that
+ this field cannot be set when spec.os.name
+ is windows.'
type: boolean
capabilities:
- description: |-
- The capabilities to add/drop when running containers.
- Defaults to the default set of capabilities granted by the container runtime.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The capabilities to add/drop when
+ running containers. Defaults to the default
+ set of capabilities granted by the container
+ runtime. Note that this field cannot be set
+ when spec.os.name is windows.
properties:
add:
description: Added capabilities
@@ -3933,60 +4134,69 @@ spec:
type: array
type: object
privileged:
- description: |-
- Run container in privileged mode.
- Processes in privileged containers are essentially equivalent to root on the host.
- Defaults to false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Run container in privileged mode.
+ Processes in privileged containers are essentially
+ equivalent to root on the host. Defaults to
+ false. Note that this field cannot be set
+ when spec.os.name is windows.
type: boolean
procMount:
- description: |-
- procMount denotes the type of proc mount to use for the containers.
- The default is DefaultProcMount which uses the container runtime defaults for
- readonly paths and masked paths.
- This requires the ProcMountType feature flag to be enabled.
- Note that this field cannot be set when spec.os.name is windows.
+ description: procMount denotes the type of proc
+ mount to use for the containers. The default
+ is DefaultProcMount which uses the container
+ runtime defaults for readonly paths and masked
+ paths. This requires the ProcMountType feature
+ flag to be enabled. Note that this field cannot
+ be set when spec.os.name is windows.
type: string
readOnlyRootFilesystem:
- description: |-
- Whether this container has a read-only root filesystem.
- Default is false.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Whether this container has a read-only
+ root filesystem. Default is false. Note that
+ this field cannot be set when spec.os.name
+ is windows.
type: boolean
runAsGroup:
- description: |-
- The GID to run the entrypoint of the container process.
- Uses runtime default if unset.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The GID to run the entrypoint of
+ the container process. Uses runtime default
+ if unset. May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is windows.
format: int64
type: integer
runAsNonRoot:
- description: |-
- Indicates that the container must run as a non-root user.
- If true, the Kubelet will validate the image at runtime to ensure that it
- does not run as UID 0 (root) and fail to start the container if it does.
- If unset or false, no such validation will be performed.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: Indicates that the container must
+ run as a non-root user. If true, the Kubelet
+ will validate the image at runtime to ensure
+ that it does not run as UID 0 (root) and fail
+ to start the container if it does. If unset
+ or false, no such validation will be performed.
+ May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence.
type: boolean
runAsUser:
- description: |-
- The UID to run the entrypoint of the container process.
- Defaults to user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The UID to run the entrypoint of
+ the container process. Defaults to user specified
+ in image metadata if unspecified. May also
+ be set in PodSecurityContext. If set in both
+ SecurityContext and PodSecurityContext, the
+ value specified in SecurityContext takes precedence.
+ Note that this field cannot be set when spec.os.name
+ is windows.
format: int64
type: integer
seLinuxOptions:
- description: |-
- The SELinux context to be applied to the container.
- If unspecified, the container runtime will allocate a random SELinux context for each
- container. May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The SELinux context to be applied
+ to the container. If unspecified, the container
+ runtime will allocate a random SELinux context
+ for each container. May also be set in PodSecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is windows.
properties:
level:
description: Level is SELinux level label
@@ -4006,93 +4216,112 @@ spec:
type: string
type: object
seccompProfile:
- description: |-
- The seccomp options to use by this container. If seccomp options are
- provided at both the pod & container level, the container options
- override the pod options.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The seccomp options to use by this
+ container. If seccomp options are provided
+ at both the pod & container level, the container
+ options override the pod options. Note that
+ this field cannot be set when spec.os.name
+ is windows.
properties:
localhostProfile:
- description: |-
- localhostProfile indicates a profile defined in a file on the node should be used.
- The profile must be preconfigured on the node to work.
- Must be a descending path, relative to the kubelet's configured seccomp profile location.
- Must be set if type is "Localhost". Must NOT be set for any other type.
+ description: localhostProfile indicates
+ a profile defined in a file on the node
+ should be used. The profile must be preconfigured
+ on the node to work. Must be a descending
+ path, relative to the kubelet's configured
+ seccomp profile location. Must be set
+ if type is "Localhost". Must NOT be set
+ for any other type.
type: string
type:
- description: |-
- type indicates which kind of seccomp profile will be applied.
- Valid options are:
-
-
- Localhost - a profile defined in a file on the node should be used.
- RuntimeDefault - the container runtime default profile should be used.
- Unconfined - no profile should be applied.
+ description: "type indicates which kind
+ of seccomp profile will be applied. Valid
+ options are: \n Localhost - a profile
+ defined in a file on the node should be
+ used. RuntimeDefault - the container runtime
+ default profile should be used. Unconfined
+ - no profile should be applied."
type: string
required:
- type
type: object
windowsOptions:
- description: |-
- The Windows specific settings applied to all containers.
- If unspecified, the options from the PodSecurityContext will be used.
- If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is linux.
+ description: The Windows specific settings applied
+ to all containers. If unspecified, the options
+ from the PodSecurityContext will be used.
+ If set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence. Note that this field cannot be
+ set when spec.os.name is linux.
properties:
gmsaCredentialSpec:
- description: |-
- GMSACredentialSpec is where the GMSA admission webhook
- (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
- GMSA credential spec named by the GMSACredentialSpecName field.
+ description: GMSACredentialSpec is where
+ the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa)
+ inlines the contents of the GMSA credential
+ spec named by the GMSACredentialSpecName
+ field.
type: string
gmsaCredentialSpecName:
description: GMSACredentialSpecName is the
name of the GMSA credential spec to use.
type: string
hostProcess:
- description: |-
- HostProcess determines if a container should be run as a 'Host Process' container.
- All of a Pod's containers must have the same effective HostProcess value
- (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
- In addition, if HostProcess is true then HostNetwork must also be set to true.
+ description: HostProcess determines if a
+ container should be run as a 'Host Process'
+ container. All of a Pod's containers must
+ have the same effective HostProcess value
+ (it is not allowed to have a mix of HostProcess
+ containers and non-HostProcess containers).
+ In addition, if HostProcess is true then
+ HostNetwork must also be set to true.
type: boolean
runAsUserName:
- description: |-
- The UserName in Windows to run the entrypoint of the container process.
- Defaults to the user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: The UserName in Windows to
+ run the entrypoint of the container process.
+ Defaults to the user specified in image
+ metadata if unspecified. May also be set
+ in PodSecurityContext. If set in both
+ SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext
+ takes precedence.
type: string
type: object
type: object
startupProbe:
- description: |-
- StartupProbe indicates that the Pod has successfully initialized.
- If specified, no other probes are executed until this completes successfully.
- If this probe fails, the Pod will be restarted, just as if the livenessProbe failed.
- This can be used to provide different probe parameters at the beginning of a Pod's lifecycle,
- when it might take a long time to load data or warm a cache, than during steady-state operation.
- This cannot be updated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'StartupProbe indicates that the Pod
+ has successfully initialized. If specified, no
+ other probes are executed until this completes
+ successfully. If this probe fails, the Pod will
+ be restarted, just as if the livenessProbe failed.
+ This can be used to provide different probe parameters
+ at the beginning of a Pod''s lifecycle, when it
+ might take a long time to load data or warm a
+ cache, than during steady-state operation. This
+ cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: Exec specifies the action to take.
properties:
command:
- description: |-
- Command is the command line to execute inside the container, the working directory for the
- command is root ('/') in the container's filesystem. The command is simply exec'd, it is
- not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
- a shell, you need to explicitly call out to that shell.
- Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+ description: Command is the command line
+ to execute inside the container, the working
+ directory for the command is root ('/')
+ in the container's filesystem. The command
+ is simply exec'd, it is not run inside
+ a shell, so traditional shell instructions
+ ('|', etc) won't work. To use a shell,
+ you need to explicitly call out to that
+ shell. Exit status of 0 is treated as
+ live/healthy and non-zero is unhealthy.
items:
type: string
type: array
type: object
failureThreshold:
- description: |-
- Minimum consecutive failures for the probe to be considered failed after having succeeded.
- Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for
+ the probe to be considered failed after having
+ succeeded. Defaults to 3. Minimum value is
+ 1.
format: int32
type: integer
grpc:
@@ -4105,12 +4334,11 @@ spec:
format: int32
type: integer
service:
- description: |-
- Service is the name of the service to place in the gRPC HealthCheckRequest
+ description: "Service is the name of the
+ service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-
-
- If this is not specified, the default behavior is defined by gRPC.
+ \n If this is not specified, the default
+ behavior is defined by gRPC."
type: string
required:
- port
@@ -4120,8 +4348,8 @@ spec:
to perform.
properties:
host:
- description: |-
- Host name to connect to, defaults to the pod IP. You probably want to set
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
"Host" in httpHeaders instead.
type: string
httpHeaders:
@@ -4132,9 +4360,10 @@ spec:
header to be used in HTTP probes
properties:
name:
- description: |-
- The header field name.
- This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ description: The header field name.
+ This will be canonicalized upon
+ output, so case-variant names will
+ be understood as the same header.
type: string
value:
description: The header field value
@@ -4152,35 +4381,35 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Name or number of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Name or number of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
scheme:
- description: |-
- Scheme to use for connecting to the host.
- Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: |-
- Number of seconds after the container has started before liveness probes are initiated.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after the container
+ has started before liveness probes are initiated.
+ More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
periodSeconds:
- description: |-
- How often (in seconds) to perform the probe.
- Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform
+ the probe. Default to 10 seconds. Minimum
+ value is 1.
format: int32
type: integer
successThreshold:
- description: |-
- Minimum consecutive successes for the probe to be considered successful after having failed.
- Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+ description: Minimum consecutive successes for
+ the probe to be considered successful after
+ having failed. Defaults to 1. Must be 1 for
+ liveness and startup. Minimum value is 1.
format: int32
type: integer
tcpSocket:
@@ -4195,76 +4424,87 @@ spec:
anyOf:
- type: integer
- type: string
- description: |-
- Number or name of the port to access on the container.
- Number must be in the range 1 to 65535.
- Name must be an IANA_SVC_NAME.
+ description: Number or name of the port
+ to access on the container. Number must
+ be in the range 1 to 65535. Name must
+ be an IANA_SVC_NAME.
x-kubernetes-int-or-string: true
required:
- port
type: object
terminationGracePeriodSeconds:
- description: |-
- Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
- The grace period is the duration in seconds after the processes running in the pod are sent
- a termination signal and the time when the processes are forcibly halted with a kill signal.
- Set this value longer than the expected cleanup time for your process.
- If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
- value overrides the value provided by the pod spec.
- Value must be non-negative integer. The value zero indicates stop immediately via
- the kill signal (no opportunity to shut down).
- This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
- Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+ description: Optional duration in seconds the
+ pod needs to terminate gracefully upon probe
+ failure. The grace period is the duration
+ in seconds after the processes running in
+ the pod are sent a termination signal and
+ the time when the processes are forcibly halted
+ with a kill signal. Set this value longer
+ than the expected cleanup time for your process.
+ If this value is nil, the pod's terminationGracePeriodSeconds
+ will be used. Otherwise, this value overrides
+ the value provided by the pod spec. Value
+ must be non-negative integer. The value zero
+ indicates stop immediately via the kill signal
+ (no opportunity to shut down). This is a beta
+ field and requires enabling ProbeTerminationGracePeriod
+ feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds
+ is used if unset.
format: int64
type: integer
timeoutSeconds:
- description: |-
- Number of seconds after which the probe times out.
- Defaults to 1 second. Minimum value is 1.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+ description: 'Number of seconds after which
+ the probe times out. Defaults to 1 second.
+ Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
format: int32
type: integer
type: object
stdin:
- description: |-
- Whether this container should allocate a buffer for stdin in the container runtime. If this
- is not set, reads from stdin in the container will always result in EOF.
- Default is false.
+ description: Whether this container should allocate
+ a buffer for stdin in the container runtime. If
+ this is not set, reads from stdin in the container
+ will always result in EOF. Default is false.
type: boolean
stdinOnce:
- description: |-
- Whether the container runtime should close the stdin channel after it has been opened by
- a single attach. When stdin is true the stdin stream will remain open across multiple attach
- sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
- first client attaches to stdin, and then remains open and accepts data until the client disconnects,
- at which time stdin is closed and remains closed until the container is restarted. If this
- flag is false, a container processes that reads from stdin will never receive an EOF.
- Default is false
+ description: Whether the container runtime should
+ close the stdin channel after it has been opened
+ by a single attach. When stdin is true the stdin
+ stream will remain open across multiple attach
+ sessions. If stdinOnce is set to true, stdin is
+ opened on container start, is empty until the
+ first client attaches to stdin, and then remains
+ open and accepts data until the client disconnects,
+ at which time stdin is closed and remains closed
+ until the container is restarted. If this flag
+ is false, a container processes that reads from
+ stdin will never receive an EOF. Default is false
type: boolean
terminationMessagePath:
- description: |-
- Optional: Path at which the file to which the container's termination message
- will be written is mounted into the container's filesystem.
- Message written is intended to be brief final status, such as an assertion failure message.
- Will be truncated by the node if greater than 4096 bytes. The total message length across
- all containers will be limited to 12kb.
- Defaults to /dev/termination-log.
- Cannot be updated.
+ description: 'Optional: Path at which the file to
+ which the container''s termination message will
+ be written is mounted into the container''s filesystem.
+ Message written is intended to be brief final
+ status, such as an assertion failure message.
+ Will be truncated by the node if greater than
+ 4096 bytes. The total message length across all
+ containers will be limited to 12kb. Defaults to
+ /dev/termination-log. Cannot be updated.'
type: string
terminationMessagePolicy:
- description: |-
- Indicate how the termination message should be populated. File will use the contents of
- terminationMessagePath to populate the container status message on both success and failure.
- FallbackToLogsOnError will use the last chunk of container log output if the termination
- message file is empty and the container exited with an error.
- The log output is limited to 2048 bytes or 80 lines, whichever is smaller.
- Defaults to File.
- Cannot be updated.
+ description: Indicate how the termination message
+ should be populated. File will use the contents
+ of terminationMessagePath to populate the container
+ status message on both success and failure. FallbackToLogsOnError
+ will use the last chunk of container log output
+ if the termination message file is empty and the
+ container exited with an error. The log output
+ is limited to 2048 bytes or 80 lines, whichever
+ is smaller. Defaults to File. Cannot be updated.
type: string
tty:
- description: |-
- Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
- Default is false.
+ description: Whether this container should allocate
+ a TTY for itself, also requires 'stdin' to be
+ true. Default is false.
type: boolean
volumeDevices:
description: volumeDevices is the list of block
@@ -4288,45 +4528,46 @@ spec:
type: object
type: array
volumeMounts:
- description: |-
- Pod volumes to mount into the container's filesystem.
- Cannot be updated.
+ description: Pod volumes to mount into the container's
+ filesystem. Cannot be updated.
items:
description: VolumeMount describes a mounting
of a Volume within a container.
properties:
mountPath:
- description: |-
- Path within the container at which the volume should be mounted. Must
+ description: Path within the container at
+ which the volume should be mounted. Must
not contain ':'.
type: string
mountPropagation:
- description: |-
- mountPropagation determines how mounts are propagated from the host
- to container and the other way around.
- When not set, MountPropagationNone is used.
- This field is beta in 1.10.
+ description: mountPropagation determines how
+ mounts are propagated from the host to container
+ and the other way around. When not set,
+ MountPropagationNone is used. This field
+ is beta in 1.10.
type: string
name:
description: This must match the Name of a
Volume.
type: string
readOnly:
- description: |-
- Mounted read-only if true, read-write otherwise (false or unspecified).
- Defaults to false.
+ description: Mounted read-only if true, read-write
+ otherwise (false or unspecified). Defaults
+ to false.
type: boolean
subPath:
- description: |-
- Path within the volume from which the container's volume should be mounted.
+ description: Path within the volume from which
+ the container's volume should be mounted.
Defaults to "" (volume's root).
type: string
subPathExpr:
- description: |-
- Expanded path within the volume from which the container's volume should be mounted.
- Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.
- Defaults to "" (volume's root).
- SubPathExpr and SubPath are mutually exclusive.
+ description: Expanded path within the volume
+ from which the container's volume should
+ be mounted. Behaves similarly to SubPath
+ but environment variable references $(VAR_NAME)
+ are expanded using the container's environment.
+ Defaults to "" (volume's root). SubPathExpr
+ and SubPath are mutually exclusive.
type: string
required:
- mountPath
@@ -4334,11 +4575,10 @@ spec:
type: object
type: array
workingDir:
- description: |-
- Container's working directory.
- If not specified, the container runtime's default will be used, which
- might be configured in the container image.
- Cannot be updated.
+ description: Container's working directory. If not
+ specified, the container runtime's default will
+ be used, which might be configured in the container
+ image. Cannot be updated.
type: string
required:
- name
@@ -4356,68 +4596,69 @@ spec:
description: 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.
- Note that this field cannot be set when spec.os.name is windows.
+ description: "A special supplemental group that applies
+ to all containers in a pod. Some volume types allow
+ the Kubelet to change the ownership of that volume
+ to be owned by the pod: \n 1. The owning GID will
+ be the FSGroup 2. The setgid bit is set (new files
+ created in the volume will be owned by FSGroup)
+ 3. The permission bits are OR'd with rw-rw---- \n
+ If unset, the Kubelet will not modify the ownership
+ and permissions of any volume. Note that this field
+ cannot be set when spec.os.name is windows."
format: int64
type: integer
fsGroupChangePolicy:
- description: |-
- fsGroupChangePolicy defines behavior of changing ownership and permission of the volume
- before being exposed inside Pod. This field will only apply to
- volume types which support fsGroup based ownership(and permissions).
- It will have no effect on ephemeral volume types such as: secret, configmaps
- and emptydir.
- Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used.
- Note that this field cannot be set when spec.os.name is windows.
+ description: 'fsGroupChangePolicy defines behavior
+ of changing ownership and permission of the volume
+ before being exposed inside Pod. This field will
+ only apply to volume types which support fsGroup
+ based ownership(and permissions). It will have no
+ effect on ephemeral volume types such as: secret,
+ configmaps and emptydir. Valid values are "OnRootMismatch"
+ and "Always". If not specified, "Always" is used.
+ Note that this field cannot be set when spec.os.name
+ is windows.'
type: string
runAsGroup:
- description: |-
- The GID to run the entrypoint of the container process.
- Uses runtime default if unset.
- May also be set in SecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence
- for that container.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The GID to run the entrypoint of the
+ container process. Uses runtime default if unset.
+ May also be set in SecurityContext. If set in both
+ SecurityContext and PodSecurityContext, the value
+ specified in SecurityContext takes precedence for
+ that container. Note that this field cannot be set
+ when spec.os.name is windows.
format: int64
type: integer
runAsNonRoot:
- description: |-
- Indicates that the container must run as a non-root user.
- If true, the Kubelet will validate the image at runtime to ensure that it
- does not run as UID 0 (root) and fail to start the container if it does.
- If unset or false, no such validation will be performed.
- May also be set in SecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: Indicates that the container must run
+ as a non-root user. If true, the Kubelet will validate
+ the image at runtime to ensure that it does not
+ run as UID 0 (root) and fail to start the container
+ if it does. If unset or false, no such validation
+ will be performed. May also be set in SecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence.
type: boolean
runAsUser:
- description: |-
- The UID to run the entrypoint of the container process.
- Defaults to user specified in image metadata if unspecified.
- May also be set in SecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence
- for that container.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The UID to run the entrypoint of the
+ container process. Defaults to user specified in
+ image metadata if unspecified. May also be set in
+ SecurityContext. If set in both SecurityContext
+ and PodSecurityContext, the value specified in SecurityContext
+ takes precedence for that container. Note that this
+ field cannot be set when spec.os.name is windows.
format: int64
type: integer
seLinuxOptions:
- description: |-
- The SELinux context to be applied to all containers.
- If unspecified, the container runtime will allocate a random SELinux context for each
- container. May also be set in SecurityContext. If set in
- both SecurityContext and PodSecurityContext, the value specified in SecurityContext
- takes precedence for that container.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The SELinux context to be applied to
+ all containers. If unspecified, the container runtime
+ will allocate a random SELinux context for each
+ container. May also be set in SecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence
+ for that container. Note that this field cannot
+ be set when spec.os.name is windows.
properties:
level:
description: Level is SELinux level label that
@@ -4437,48 +4678,52 @@ spec:
type: string
type: object
seccompProfile:
- description: |-
- The seccomp options to use by the containers in this pod.
- Note that this field cannot be set when spec.os.name is windows.
+ description: The seccomp options to use by the containers
+ in this pod. Note that this field cannot be set
+ when spec.os.name is windows.
properties:
localhostProfile:
- description: |-
- localhostProfile indicates a profile defined in a file on the node should be used.
- The profile must be preconfigured on the node to work.
- Must be a descending path, relative to the kubelet's configured seccomp profile location.
- Must be set if type is "Localhost". Must NOT be set for any other type.
+ description: localhostProfile indicates a profile
+ defined in a file on the node should be used.
+ The profile must be preconfigured on the node
+ to work. Must be a descending path, relative
+ to the kubelet's configured seccomp profile
+ location. Must be set if type is "Localhost".
+ Must NOT be set for any other type.
type: string
type:
- description: |-
- type indicates which kind of seccomp profile will be applied.
- Valid options are:
-
-
- Localhost - a profile defined in a file on the node should be used.
- RuntimeDefault - the container runtime default profile should be used.
- Unconfined - no profile should be applied.
+ description: "type indicates which kind of seccomp
+ profile will be applied. Valid options are:
+ \n Localhost - a profile defined in a file on
+ the node should be used. RuntimeDefault - the
+ container runtime default profile should be
+ used. Unconfined - no profile should be applied."
type: string
required:
- type
type: object
supplementalGroups:
- description: |-
- A list of groups applied to the first process run in each container, in addition
- to the container's primary GID, the fsGroup (if specified), and group memberships
- defined in the container image for the uid of the container process. If unspecified,
- no additional groups are added to any container. Note that group memberships
- defined in the container image for the uid of the container process are still effective,
- even if they are not included in this list.
- Note that this field cannot be set when spec.os.name is windows.
+ description: A list of groups applied to the first
+ process run in each container, in addition to the
+ container's primary GID, the fsGroup (if specified),
+ and group memberships defined in the container image
+ for the uid of the container process. If unspecified,
+ no additional groups are added to any container.
+ Note that group memberships defined in the container
+ image for the uid of the container process are still
+ effective, even if they are not included in this
+ list. Note that this field cannot be set when spec.os.name
+ is windows.
items:
format: int64
type: integer
type: array
sysctls:
- description: |-
- Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported
- sysctls (by the container runtime) might fail to launch.
- Note that this field cannot be set when spec.os.name is windows.
+ description: Sysctls hold a list of namespaced sysctls
+ used for the pod. Pods with unsupported sysctls
+ (by the container runtime) might fail to launch.
+ Note that this field cannot be set when spec.os.name
+ is windows.
items:
description: Sysctl defines a kernel parameter to
be set
@@ -4495,35 +4740,42 @@ spec:
type: object
type: array
windowsOptions:
- description: |-
- The Windows specific settings applied to all containers.
- If unspecified, the options within a container's SecurityContext will be used.
- If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- Note that this field cannot be set when spec.os.name is linux.
+ description: The Windows specific settings applied
+ to all containers. If unspecified, the options within
+ a container's SecurityContext will be used. If set
+ in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence.
+ Note that this field cannot be set when spec.os.name
+ is linux.
properties:
gmsaCredentialSpec:
- description: |-
- GMSACredentialSpec is where the GMSA admission webhook
- (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
- GMSA credential spec named by the GMSACredentialSpecName field.
+ description: GMSACredentialSpec is where the GMSA
+ admission webhook (https://github.com/kubernetes-sigs/windows-gmsa)
+ inlines the contents of the GMSA credential
+ spec named by the GMSACredentialSpecName field.
type: string
gmsaCredentialSpecName:
description: GMSACredentialSpecName is the name
of the GMSA credential spec to use.
type: string
hostProcess:
- description: |-
- HostProcess determines if a container should be run as a 'Host Process' container.
- All of a Pod's containers must have the same effective HostProcess value
- (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
- In addition, if HostProcess is true then HostNetwork must also be set to true.
+ description: HostProcess determines if a container
+ should be run as a 'Host Process' container.
+ All of a Pod's containers must have the same
+ effective HostProcess value (it is not allowed
+ to have a mix of HostProcess containers and
+ non-HostProcess containers). In addition, if
+ HostProcess is true then HostNetwork must also
+ be set to true.
type: boolean
runAsUserName:
- description: |-
- The UserName in Windows to run the entrypoint of the container process.
- Defaults to the user specified in image metadata if unspecified.
- May also be set in PodSecurityContext. If set in both SecurityContext and
- PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: The UserName in Windows to run the
+ entrypoint of the container process. Defaults
+ to the user specified in image metadata if unspecified.
+ May also be set in PodSecurityContext. If set
+ in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes
+ precedence.
type: string
type: object
type: object
@@ -4538,34 +4790,38 @@ spec:
to spread matching pods among the given topology.
properties:
labelSelector:
- description: |-
- LabelSelector is used to find matching pods.
- Pods that match this label selector are counted to determine the number of pods
- in their corresponding topology domain.
+ description: LabelSelector is used to find matching
+ pods. Pods that match this label selector are
+ counted to determine the number of pods in their
+ corresponding topology domain.
properties:
matchExpressions:
description: matchExpressions is a list of label
selector requirements. The requirements are
ANDed.
items:
- description: |-
- A label selector requirement is a selector that contains values, a key, and an operator that
- relates the key and values.
+ description: A label selector requirement
+ is a selector that contains values, a key,
+ and an operator that relates the key and
+ values.
properties:
key:
description: key is the label key that
the selector applies to.
type: string
operator:
- description: |-
- operator represents a key's relationship to a set of values.
- Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents a key's
+ relationship to a set of values. Valid
+ operators are In, NotIn, Exists and
+ DoesNotExist.
type: string
values:
- description: |-
- values is an array of string values. If the operator is In or NotIn,
- the values array must be non-empty. If the operator is Exists or DoesNotExist,
- the values array must be empty. This array is replaced during a strategic
+ description: values is an array of string
+ values. If the operator is In or NotIn,
+ the values array must be non-empty.
+ If the operator is Exists or DoesNotExist,
+ the values array must be empty. This
+ array is replaced during a strategic
merge patch.
items:
type: string
@@ -4578,134 +4834,146 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: |-
- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions, whose key field is "key", the
- operator is "In", and the values array contains only "value". The requirements are ANDed.
+ description: matchLabels is a map of {key,value}
+ pairs. A single {key,value} in the matchLabels
+ map is equivalent to an element of matchExpressions,
+ whose key field is "key", the operator is
+ "In", and the values array contains only "value".
+ The requirements are ANDed.
type: object
type: object
- x-kubernetes-map-type: atomic
matchLabelKeys:
- description: |-
- MatchLabelKeys is a set of pod label keys to select the pods over which
- spreading will be calculated. The keys are used to lookup values from the
- incoming pod labels, those key-value labels are ANDed with labelSelector
- to select the group of existing pods over which spreading will be calculated
- for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.
- MatchLabelKeys cannot be set when LabelSelector isn't set.
- Keys that don't exist in the incoming pod labels will
- be ignored. A null or empty list means only match against labelSelector.
-
-
- This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).
+ description: "MatchLabelKeys is a set of pod label
+ keys to select the pods over which spreading will
+ be calculated. The keys are used to lookup values
+ from the incoming pod labels, those key-value
+ labels are ANDed with labelSelector to select
+ the group of existing pods over which spreading
+ will be calculated for the incoming pod. The same
+ key is forbidden to exist in both MatchLabelKeys
+ and LabelSelector. MatchLabelKeys cannot be set
+ when LabelSelector isn't set. Keys that don't
+ exist in the incoming pod labels will be ignored.
+ A null or empty list means only match against
+ labelSelector. \n This is a beta field and requires
+ the MatchLabelKeysInPodTopologySpread feature
+ gate to be enabled (enabled by default)."
items:
type: string
type: array
x-kubernetes-list-type: atomic
maxSkew:
- description: |-
- MaxSkew describes the degree to which pods may be unevenly distributed.
- When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference
- between the number of matching pods in the target topology and the global minimum.
- The global minimum is the minimum number of matching pods in an eligible domain
- or zero if the number of eligible domains is less than MinDomains.
- For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same
- labelSelector spread as 2/2/1:
- In this case, the global minimum is 1.
- | zone1 | zone2 | zone3 |
- | P P | P P | P |
- - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2;
- scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2)
- violate MaxSkew(1).
- - if MaxSkew is 2, incoming pod can be scheduled onto any zone.
- When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence
- to topologies that satisfy it.
- It's a required field. Default value is 1 and 0 is not allowed.
+ description: 'MaxSkew describes the degree to which
+ pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`,
+ it is the maximum permitted difference between
+ the number of matching pods in the target topology
+ and the global minimum. The global minimum is
+ the minimum number of matching pods in an eligible
+ domain or zero if the number of eligible domains
+ is less than MinDomains. For example, in a 3-zone
+ cluster, MaxSkew is set to 1, and pods with the
+ same labelSelector spread as 2/2/1: In this case,
+ the global minimum is 1. | zone1 | zone2 | zone3
+ | | P P | P P | P | - if MaxSkew is 1,
+ incoming pod can only be scheduled to zone3 to
+ become 2/2/2; scheduling it onto zone1(zone2)
+ would make the ActualSkew(3-1) on zone1(zone2)
+ violate MaxSkew(1). - if MaxSkew is 2, incoming
+ pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`,
+ it is used to give higher precedence to topologies
+ that satisfy it. It''s a required field. Default
+ value is 1 and 0 is not allowed.'
format: int32
type: integer
minDomains:
- description: |-
- MinDomains indicates a minimum number of eligible domains.
- When the number of eligible domains with matching topology keys is less than minDomains,
- Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed.
- And when the number of eligible domains with matching topology keys equals or greater than minDomains,
- this value has no effect on scheduling.
- As a result, when the number of eligible domains is less than minDomains,
- scheduler won't schedule more than maxSkew Pods to those domains.
- If value is nil, the constraint behaves as if MinDomains is equal to 1.
- Valid values are integers greater than 0.
- When value is not nil, WhenUnsatisfiable must be DoNotSchedule.
-
-
- For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same
- labelSelector spread as 2/2/2:
- | zone1 | zone2 | zone3 |
- | P P | P P | P P |
- The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0.
- In this situation, new pod with the same labelSelector cannot be scheduled,
- because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones,
- it will violate MaxSkew.
-
-
- This is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default).
+ description: "MinDomains indicates a minimum number
+ of eligible domains. When the number of eligible
+ domains with matching topology keys is less than
+ minDomains, Pod Topology Spread treats \"global
+ minimum\" as 0, and then the calculation of Skew
+ is performed. And when the number of eligible
+ domains with matching topology keys equals or
+ greater than minDomains, this value has no effect
+ on scheduling. As a result, when the number of
+ eligible domains is less than minDomains, scheduler
+ won't schedule more than maxSkew Pods to those
+ domains. If value is nil, the constraint behaves
+ as if MinDomains is equal to 1. Valid values are
+ integers greater than 0. When value is not nil,
+ WhenUnsatisfiable must be DoNotSchedule. \n For
+ example, in a 3-zone cluster, MaxSkew is set to
+ 2, MinDomains is set to 5 and pods with the same
+ labelSelector spread as 2/2/2: | zone1 | zone2
+ | zone3 | | P P | P P | P P | The number
+ of domains is less than 5(MinDomains), so \"global
+ minimum\" is treated as 0. In this situation,
+ new pod with the same labelSelector cannot be
+ scheduled, because computed skew will be 3(3 -
+ 0) if new Pod is scheduled to any of the three
+ zones, it will violate MaxSkew. \n This is a beta
+ field and requires the MinDomainsInPodTopologySpread
+ feature gate to be enabled (enabled by default)."
format: int32
type: integer
nodeAffinityPolicy:
- description: |-
- NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector
- when calculating pod topology spread skew. Options are:
- - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations.
- - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.
-
-
- If this value is nil, the behavior is equivalent to the Honor policy.
- This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
+ description: "NodeAffinityPolicy indicates how we
+ will treat Pod's nodeAffinity/nodeSelector when
+ calculating pod topology spread skew. Options
+ are: - Honor: only nodes matching nodeAffinity/nodeSelector
+ are included in the calculations. - Ignore: nodeAffinity/nodeSelector
+ are ignored. All nodes are included in the calculations.
+ \n If this value is nil, the behavior is equivalent
+ to the Honor policy. This is a beta-level feature
+ default enabled by the NodeInclusionPolicyInPodTopologySpread
+ feature flag."
type: string
nodeTaintsPolicy:
- description: |-
- NodeTaintsPolicy indicates how we will treat node taints when calculating
- pod topology spread skew. Options are:
- - Honor: nodes without taints, along with tainted nodes for which the incoming pod
- has a toleration, are included.
- - Ignore: node taints are ignored. All nodes are included.
-
-
- If this value is nil, the behavior is equivalent to the Ignore policy.
- This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
+ description: "NodeTaintsPolicy indicates how we
+ will treat node taints when calculating pod topology
+ spread skew. Options are: - Honor: nodes without
+ taints, along with tainted nodes for which the
+ incoming pod has a toleration, are included. -
+ Ignore: node taints are ignored. All nodes are
+ included. \n If this value is nil, the behavior
+ is equivalent to the Ignore policy. This is a
+ beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread
+ feature flag."
type: string
topologyKey:
- description: |-
- TopologyKey is the key of node labels. Nodes that have a label with this key
- and identical values are considered to be in the same topology.
- We consider each as a "bucket", and try to put balanced number
- of pods into each bucket.
- We define a domain as a particular instance of a topology.
- Also, we define an eligible domain as a domain whose nodes meet the requirements of
- nodeAffinityPolicy and nodeTaintsPolicy.
- e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology.
- And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology.
- It's a required field.
+ description: TopologyKey is the key of node labels.
+ Nodes that have a label with this key and identical
+ values are considered to be in the same topology.
+ We consider each as a "bucket", and
+ try to put balanced number of pods into each bucket.
+ We define a domain as a particular instance of
+ a topology. Also, we define an eligible domain
+ as a domain whose nodes meet the requirements
+ of nodeAffinityPolicy and nodeTaintsPolicy. e.g.
+ If TopologyKey is "kubernetes.io/hostname", each
+ Node is a domain of that topology. And, if TopologyKey
+ is "topology.kubernetes.io/zone", each zone is
+ a domain of that topology. It's a required field.
type: string
whenUnsatisfiable:
- description: |-
- WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy
- the spread constraint.
- - DoNotSchedule (default) tells the scheduler not to schedule it.
- - ScheduleAnyway tells the scheduler to schedule the pod in any location,
- but giving higher precedence to topologies that would help reduce the
- skew.
- A constraint is considered "Unsatisfiable" for an incoming pod
- if and only if every possible node assignment for that pod would violate
- "MaxSkew" on some topology.
- For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same
- labelSelector spread as 3/1/1:
- | zone1 | zone2 | zone3 |
- | P P P | P | P |
- If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled
- to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies
- MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler
- won't make it *more* imbalanced.
- It's a required field.
+ description: 'WhenUnsatisfiable indicates how to
+ deal with a pod if it doesn''t satisfy the spread
+ constraint. - DoNotSchedule (default) tells the
+ scheduler not to schedule it. - ScheduleAnyway
+ tells the scheduler to schedule the pod in any
+ location, but giving higher precedence to topologies
+ that would help reduce the skew. A constraint
+ is considered "Unsatisfiable" for an incoming
+ pod if and only if every possible node assignment
+ for that pod would violate "MaxSkew" on some topology.
+ For example, in a 3-zone cluster, MaxSkew is set
+ to 1, and pods with the same labelSelector spread
+ as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P |
+ If WhenUnsatisfiable is set to DoNotSchedule,
+ incoming pod can only be scheduled to zone2(zone3)
+ to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3)
+ satisfies MaxSkew(1). In other words, the cluster
+ can still be imbalanced, but scheduler won''t
+ make it *more* imbalanced. It''s a required field.'
type: string
required:
- maxSkew
@@ -4720,36 +4988,40 @@ spec:
that may be accessed by any container in the pod.
properties:
awsElasticBlockStore:
- description: |-
- awsElasticBlockStore represents an AWS Disk resource that is attached to a
- kubelet's host machine and then exposed to the pod.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ description: 'awsElasticBlockStore represents an
+ AWS Disk resource that is attached to a kubelet''s
+ host machine and then exposed to the pod. More
+ info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
properties:
fsType:
- description: |-
- fsType is the filesystem type of the volume that you want to mount.
- Tip: Ensure that the filesystem type is supported by the host operating system.
- Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
- TODO: how do we prevent errors in the filesystem from compromising the machine
+ description: 'fsType is the filesystem type
+ of the volume that you want to mount. Tip:
+ Ensure that the filesystem type is supported
+ by the host operating system. Examples: "ext4",
+ "xfs", "ntfs". Implicitly inferred to be "ext4"
+ if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
partition:
- description: |-
- partition is the partition in the volume that you want to mount.
- If omitted, the default is to mount by volume name.
- Examples: For volume /dev/sda1, you specify the partition as "1".
- Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
+ description: 'partition is the partition in
+ the volume that you want to mount. If omitted,
+ the default is to mount by volume name. Examples:
+ For volume /dev/sda1, you specify the partition
+ as "1". Similarly, the volume partition for
+ /dev/sda is "0" (or you can leave the property
+ empty).'
format: int32
type: integer
readOnly:
- description: |-
- readOnly value true will force the readOnly setting in VolumeMounts.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ description: 'readOnly value true will force
+ the readOnly setting in VolumeMounts. More
+ info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
type: boolean
volumeID:
- description: |-
- volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume).
- More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ description: 'volumeID is unique ID of the persistent
+ disk resource in AWS (Amazon EBS volume).
+ More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
type: string
required:
- volumeID
@@ -4771,10 +5043,11 @@ spec:
in the blob storage
type: string
fsType:
- description: |-
- fsType is Filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: fsType is Filesystem type to mount.
+ Must be a filesystem type supported by the
+ host operating system. Ex. "ext4", "xfs",
+ "ntfs". Implicitly inferred to be "ext4" if
+ unspecified.
type: string
kind:
description: 'kind expected values are Shared:
@@ -4784,9 +5057,9 @@ spec:
set). defaults to shared'
type: string
readOnly:
- description: |-
- readOnly Defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: readOnly Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
required:
- diskName
@@ -4798,9 +5071,9 @@ spec:
pod.
properties:
readOnly:
- description: |-
- readOnly defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: readOnly defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
secretName:
description: secretName is the name of secret
@@ -4819,9 +5092,9 @@ spec:
the host that shares a pod's lifetime
properties:
monitors:
- description: |-
- monitors is Required: Monitors is a collection of Ceph monitors
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ description: 'monitors is Required: Monitors
+ is a collection of Ceph monitors More info:
+ https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
items:
type: string
type: array
@@ -4831,72 +5104,68 @@ spec:
default is /'
type: string
readOnly:
- description: |-
- readOnly is Optional: Defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ description: 'readOnly is Optional: Defaults
+ to false (read/write). ReadOnly here will
+ force the ReadOnly setting in VolumeMounts.
+ More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
type: boolean
secretFile:
- description: |-
- secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ description: 'secretFile is Optional: SecretFile
+ is the path to key ring for User, default
+ is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
type: string
secretRef:
- description: |-
- secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty.
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ description: 'secretRef is Optional: SecretRef
+ is reference to the authentication secret
+ for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
user:
- description: |-
- user is optional: User is the rados user name, default is admin
- More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ description: 'user is optional: User is the
+ rados user name, default is admin More info:
+ https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
type: string
required:
- monitors
type: object
cinder:
- description: |-
- cinder represents a cinder volume attached and mounted on kubelets host machine.
- More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ description: 'cinder represents a cinder volume
+ attached and mounted on kubelets host machine.
+ More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
properties:
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ description: 'fsType is the filesystem type
+ to mount. Must be a filesystem type supported
+ by the host operating system. Examples: "ext4",
+ "xfs", "ntfs". Implicitly inferred to be "ext4"
+ if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
type: string
readOnly:
- description: |-
- readOnly defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
- More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ description: 'readOnly defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
type: boolean
secretRef:
- description: |-
- secretRef is optional: points to a secret object containing parameters used to connect
- to OpenStack.
+ description: 'secretRef is optional: points
+ to a secret object containing parameters used
+ to connect to OpenStack.'
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
volumeID:
- description: |-
- volumeID used to identify the volume in cinder.
- More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ description: 'volumeID used to identify the
+ volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
type: string
required:
- volumeID
@@ -4906,25 +5175,31 @@ spec:
should populate this volume
properties:
defaultMode:
- description: |-
- defaultMode is optional: mode bits used to set permissions on created files by default.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- Defaults to 0644.
- Directories within the path are not affected by this setting.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'defaultMode is optional: mode
+ bits used to set permissions on created files
+ by default. Must be an octal value between
+ 0000 and 0777 or a decimal value between 0
+ and 511. YAML accepts both octal and decimal
+ values, JSON requires decimal values for mode
+ bits. Defaults to 0644. Directories within
+ the path are not affected by this setting.
+ This might be in conflict with other options
+ that affect the file mode, like fsGroup, and
+ the result can be other mode bits set.'
format: int32
type: integer
items:
- description: |-
- items if unspecified, each key-value pair in the Data field of the referenced
- ConfigMap will be projected into the volume as a file whose name is the
- key and content is the value. If specified, the listed keys will be
- projected into the specified paths, and unlisted keys will not be
- present. If a key is specified which is not present in the ConfigMap,
- the volume setup will error unless it is marked optional. Paths must be
- relative and may not contain the '..' path or start with '..'.
+ description: items if unspecified, each key-value
+ pair in the Data field of the referenced ConfigMap
+ will be projected into the volume as a file
+ whose name is the key and content is the value.
+ If specified, the listed keys will be projected
+ into the specified paths, and unlisted keys
+ will not be present. If a key is specified
+ which is not present in the ConfigMap, the
+ volume setup will error unless it is marked
+ optional. Paths must be relative and may not
+ contain the '..' path or start with '..'.
items:
description: Maps a string key to a path within
a volume.
@@ -4933,21 +5208,26 @@ spec:
description: key is the key to project.
type: string
mode:
- description: |-
- mode is Optional: mode bits used to set permissions on this file.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'mode is Optional: mode bits
+ used to set permissions on this file.
+ Must be an octal value between 0000
+ and 0777 or a decimal value between
+ 0 and 511. YAML accepts both octal and
+ decimal values, JSON requires decimal
+ values for mode bits. If not specified,
+ the volume defaultMode will be used.
+ This might be in conflict with other
+ options that affect the file mode, like
+ fsGroup, and the result can be other
+ mode bits set.'
format: int32
type: integer
path:
- description: |-
- path is the relative path of the file to map the key to.
- May not be an absolute path.
- May not contain the path element '..'.
- May not start with the string '..'.
+ description: path is the relative path
+ of the file to map the key to. May not
+ be an absolute path. May not contain
+ the path element '..'. May not start
+ with the string '..'.
type: string
required:
- key
@@ -4955,60 +5235,62 @@ spec:
type: object
type: array
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: optional specify whether the ConfigMap
or its keys must be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
csi:
description: csi (Container Storage Interface) represents
ephemeral storage that is handled by certain external
CSI drivers (Beta feature).
properties:
driver:
- description: |-
- driver is the name of the CSI driver that handles this volume.
- Consult with your admin for the correct name as registered in the cluster.
+ description: driver is the name of the CSI driver
+ that handles this volume. Consult with your
+ admin for the correct name as registered in
+ the cluster.
type: string
fsType:
- description: |-
- fsType to mount. Ex. "ext4", "xfs", "ntfs".
- If not provided, the empty value is passed to the associated CSI driver
- which will determine the default filesystem to apply.
+ description: fsType to mount. Ex. "ext4", "xfs",
+ "ntfs". If not provided, the empty value is
+ passed to the associated CSI driver which
+ will determine the default filesystem to apply.
type: string
nodePublishSecretRef:
- description: |-
- nodePublishSecretRef is a reference to the secret object containing
- sensitive information to pass to the CSI driver to complete the CSI
- NodePublishVolume and NodeUnpublishVolume calls.
- This field is optional, and may be empty if no secret is required. If the
- secret object contains more than one secret, all secret references are passed.
+ description: nodePublishSecretRef is a reference
+ to the secret object containing sensitive
+ information to pass to the CSI driver to complete
+ the CSI NodePublishVolume and NodeUnpublishVolume
+ calls. This field is optional, and may be
+ empty if no secret is required. If the secret
+ object contains more than one secret, all
+ secret references are passed.
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
readOnly:
- description: |-
- readOnly specifies a read-only configuration for the volume.
- Defaults to false (read/write).
+ description: readOnly specifies a read-only
+ configuration for the volume. Defaults to
+ false (read/write).
type: boolean
volumeAttributes:
additionalProperties:
type: string
- description: |-
- volumeAttributes stores driver-specific properties that are passed to the CSI
- driver. Consult your driver's documentation for supported values.
+ description: volumeAttributes stores driver-specific
+ properties that are passed to the CSI driver.
+ Consult your driver's documentation for supported
+ values.
type: object
required:
- driver
@@ -5018,15 +5300,18 @@ spec:
about the pod that should populate this volume
properties:
defaultMode:
- description: |-
- Optional: mode bits to use on created files by default. Must be a
- Optional: mode bits used to set permissions on created files by default.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- Defaults to 0644.
- Directories within the path are not affected by this setting.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'Optional: mode bits to use on
+ created files by default. Must be a Optional:
+ mode bits used to set permissions on created
+ files by default. Must be an octal value between
+ 0000 and 0777 or a decimal value between 0
+ and 511. YAML accepts both octal and decimal
+ values, JSON requires decimal values for mode
+ bits. Defaults to 0644. Directories within
+ the path are not affected by this setting.
+ This might be in conflict with other options
+ that affect the file mode, like fsGroup, and
+ the result can be other mode bits set.'
format: int32
type: integer
items:
@@ -5054,15 +5339,19 @@ spec:
required:
- fieldPath
type: object
- x-kubernetes-map-type: atomic
mode:
- description: |-
- Optional: mode bits used to set permissions on this file, must be an octal value
- between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'Optional: mode bits used
+ to set permissions on this file, must
+ be an octal value between 0000 and 0777
+ or a decimal value between 0 and 511.
+ YAML accepts both octal and decimal
+ values, JSON requires decimal values
+ for mode bits. If not specified, the
+ volume defaultMode will be used. This
+ might be in conflict with other options
+ that affect the file mode, like fsGroup,
+ and the result can be other mode bits
+ set.'
format: int32
type: integer
path:
@@ -5074,9 +5363,11 @@ spec:
must not start with ''..'''
type: string
resourceFieldRef:
- description: |-
- Selects a resource of the container: only resources limits and requests
- (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
+ description: 'Selects a resource of the
+ container: only resources limits and
+ requests (limits.cpu, limits.memory,
+ requests.cpu and requests.memory) are
+ currently supported.'
properties:
containerName:
description: 'Container name: required
@@ -5098,132 +5389,134 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
required:
- path
type: object
type: array
type: object
emptyDir:
- description: |-
- emptyDir represents a temporary directory that shares a pod's lifetime.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
+ description: 'emptyDir represents a temporary directory
+ that shares a pod''s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
properties:
medium:
- description: |-
- medium represents what type of storage medium should back this directory.
- The default is "" which means to use the node's default medium.
- Must be an empty string (default) or Memory.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
+ description: 'medium represents what type of
+ storage medium should back this directory.
+ The default is "" which means to use the node''s
+ default medium. Must be an empty string (default)
+ or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
type: string
sizeLimit:
anyOf:
- type: integer
- type: string
- description: |-
- sizeLimit is the total amount of local storage required for this EmptyDir volume.
- The size limit is also applicable for memory medium.
- The maximum usage on memory medium EmptyDir would be the minimum value between
- the SizeLimit specified here and the sum of memory limits of all containers in a pod.
- The default is nil which means that the limit is undefined.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
+ description: 'sizeLimit is the total amount
+ of local storage required for this EmptyDir
+ volume. The size limit is also applicable
+ for memory medium. The maximum usage on memory
+ medium EmptyDir would be the minimum value
+ between the SizeLimit specified here and the
+ sum of memory limits of all containers in
+ a pod. The default is nil which means that
+ the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
type: object
ephemeral:
- description: |-
- ephemeral represents a volume that is handled by a cluster storage driver.
- The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts,
- and deleted when the pod is removed.
-
-
- Use this if:
+ description: "ephemeral represents a volume that
+ is handled by a cluster storage driver. The volume's
+ lifecycle is tied to the pod that defines it -
+ it will be created before the pod starts, and
+ deleted when the pod is removed. \n Use this if:
a) the volume is only needed while the pod runs,
- b) features of normal volumes like restoring from snapshot or capacity
- tracking are needed,
- c) the storage driver is specified through a storage class, and
- d) the storage driver supports dynamic volume provisioning through
- a PersistentVolumeClaim (see EphemeralVolumeSource for more
- information on the connection between this volume type
- and PersistentVolumeClaim).
-
-
- Use PersistentVolumeClaim or one of the vendor-specific
- APIs for volumes that persist for longer than the lifecycle
- of an individual pod.
-
-
- Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to
- be used that way - see the documentation of the driver for
- more information.
-
-
- A pod can use both types of ephemeral volumes and
- persistent volumes at the same time.
+ b) features of normal volumes like restoring from
+ snapshot or capacity tracking are needed, c)
+ the storage driver is specified through a storage
+ class, and d) the storage driver supports dynamic
+ volume provisioning through a PersistentVolumeClaim
+ (see EphemeralVolumeSource for more information
+ on the connection between this volume type and
+ PersistentVolumeClaim). \n Use PersistentVolumeClaim
+ or one of the vendor-specific APIs for volumes
+ that persist for longer than the lifecycle of
+ an individual pod. \n Use CSI for light-weight
+ local ephemeral volumes if the CSI driver is meant
+ to be used that way - see the documentation of
+ the driver for more information. \n A pod can
+ use both types of ephemeral volumes and persistent
+ volumes at the same time."
properties:
volumeClaimTemplate:
- description: |-
- Will be used to create a stand-alone PVC to provision the volume.
- The pod in which this EphemeralVolumeSource is embedded will be the
- owner of the PVC, i.e. the PVC will be deleted together with the
- pod. The name of the PVC will be `-` where
- `` is the name from the `PodSpec.Volumes` array
- entry. Pod validation will reject the pod if the concatenated name
+ description: "Will be used to create a stand-alone
+ PVC to provision the volume. The pod in which
+ this EphemeralVolumeSource is embedded will
+ be the owner of the PVC, i.e. the PVC will
+ be deleted together with the pod. The name
+ of the PVC will be `-`
+ where `` is the name from the
+ `PodSpec.Volumes` array entry. Pod validation
+ will reject the pod if the concatenated name
is not valid for a PVC (for example, too long).
-
-
- An existing PVC with that name that is not owned by the pod
- will *not* be used for the pod to avoid using an unrelated
- volume by mistake. Starting the pod is then blocked until
- the unrelated PVC is removed. If such a pre-created PVC is
- meant to be used by the pod, the PVC has to updated with an
- owner reference to the pod once the pod exists. Normally
- this should not be necessary, but it may be useful when
- manually reconstructing a broken cluster.
-
-
- This field is read-only and no changes will be made by Kubernetes
- to the PVC after it has been created.
-
-
- Required, must not be nil.
+ \n An existing PVC with that name that is
+ not owned by the pod will *not* be used for
+ the pod to avoid using an unrelated volume
+ by mistake. Starting the pod is then blocked
+ until the unrelated PVC is removed. If such
+ a pre-created PVC is meant to be used by the
+ pod, the PVC has to updated with an owner
+ reference to the pod once the pod exists.
+ Normally this should not be necessary, but
+ it may be useful when manually reconstructing
+ a broken cluster. \n This field is read-only
+ and no changes will be made by Kubernetes
+ to the PVC after it has been created. \n Required,
+ must not be nil."
properties:
metadata:
- description: |-
- May contain labels and annotations that will be copied into the PVC
- when creating it. No other fields are allowed and will be rejected during
- validation.
+ description: May contain labels and annotations
+ that will be copied into the PVC when
+ creating it. No other fields are allowed
+ and will be rejected during validation.
type: object
spec:
- description: |-
- The specification for the PersistentVolumeClaim. The entire content is
- copied unchanged into the PVC that gets created from this
+ description: The specification for the PersistentVolumeClaim.
+ The entire content is copied unchanged
+ into the PVC that gets created from this
template. The same fields as in a PersistentVolumeClaim
are also valid here.
properties:
accessModes:
- description: |-
- accessModes contains the desired access modes the volume should have.
- More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
+ description: 'accessModes contains the
+ desired access modes the volume should
+ have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
items:
type: string
type: array
dataSource:
- description: |-
- dataSource field can be used to specify either:
- * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
+ description: 'dataSource field can be
+ used to specify either: * An existing
+ VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
* An existing PVC (PersistentVolumeClaim)
- If the provisioner or an external controller can support the specified data source,
- it will create a new volume based on the contents of the specified data source.
- When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,
- and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.
- If the namespace is specified, then dataSourceRef will not be copied to dataSource.
+ If the provisioner or an external
+ controller can support the specified
+ data source, it will create a new
+ volume based on the contents of the
+ specified data source. When the AnyVolumeDataSource
+ feature gate is enabled, dataSource
+ contents will be copied to dataSourceRef,
+ and dataSourceRef contents will be
+ copied to dataSource when dataSourceRef.namespace
+ is not specified. If the namespace
+ is specified, then dataSourceRef will
+ not be copied to dataSource.'
properties:
apiGroup:
- description: |-
- APIGroup is the group for the resource being referenced.
- If APIGroup is not specified, the specified Kind must be in the core API group.
- For any other third-party types, APIGroup is required.
+ description: APIGroup is the group
+ for the resource being referenced.
+ If APIGroup is not specified,
+ the specified Kind must be in
+ the core API group. For any other
+ third-party types, APIGroup is
+ required.
type: string
kind:
description: Kind is the type of
@@ -5237,38 +5530,57 @@ spec:
- kind
- name
type: object
- x-kubernetes-map-type: atomic
dataSourceRef:
- description: |-
- dataSourceRef specifies the object from which to populate the volume with data, if a non-empty
- volume is desired. This may be any object from a non-empty API group (non
- core object) or a PersistentVolumeClaim object.
- When this field is specified, volume binding will only succeed if the type of
- the specified object matches some installed volume populator or dynamic
- provisioner.
- This field will replace the functionality of the dataSource field and as such
- if both fields are non-empty, they must have the same value. For backwards
- compatibility, when namespace isn't specified in dataSourceRef,
- both fields (dataSource and dataSourceRef) will be set to the same
- value automatically if one of them is empty and the other is non-empty.
- When namespace is specified in dataSourceRef,
- dataSource isn't set to the same value and must be empty.
- There are three important differences between dataSource and dataSourceRef:
- * While dataSource only allows two specific types of objects, dataSourceRef
- allows any non-core object, as well as PersistentVolumeClaim objects.
- * While dataSource ignores disallowed values (dropping them), dataSourceRef
- preserves all values, and generates an error if a disallowed value is
- specified.
- * While dataSource only allows local objects, dataSourceRef allows objects
- in any namespaces.
- (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
- (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
+ description: 'dataSourceRef specifies
+ the object from which to populate
+ the volume with data, if a non-empty
+ volume is desired. This may be any
+ object from a non-empty API group
+ (non core object) or a PersistentVolumeClaim
+ object. When this field is specified,
+ volume binding will only succeed if
+ the type of the specified object matches
+ some installed volume populator or
+ dynamic provisioner. This field will
+ replace the functionality of the dataSource
+ field and as such if both fields are
+ non-empty, they must have the same
+ value. For backwards compatibility,
+ when namespace isn''t specified in
+ dataSourceRef, both fields (dataSource
+ and dataSourceRef) will be set to
+ the same value automatically if one
+ of them is empty and the other is
+ non-empty. When namespace is specified
+ in dataSourceRef, dataSource isn''t
+ set to the same value and must be
+ empty. There are three important differences
+ between dataSource and dataSourceRef:
+ * While dataSource only allows two
+ specific types of objects, dataSourceRef allows
+ any non-core object, as well as PersistentVolumeClaim
+ objects. * While dataSource ignores
+ disallowed values (dropping them),
+ dataSourceRef preserves all values,
+ and generates an error if a disallowed
+ value is specified. * While dataSource
+ only allows local objects, dataSourceRef
+ allows objects in any namespaces.
+ (Beta) Using this field requires the
+ AnyVolumeDataSource feature gate to
+ be enabled. (Alpha) Using the namespace
+ field of dataSourceRef requires the
+ CrossNamespaceVolumeDataSource feature
+ gate to be enabled.'
properties:
apiGroup:
- description: |-
- APIGroup is the group for the resource being referenced.
- If APIGroup is not specified, the specified Kind must be in the core API group.
- For any other third-party types, APIGroup is required.
+ description: APIGroup is the group
+ for the resource being referenced.
+ If APIGroup is not specified,
+ the specified Kind must be in
+ the core API group. For any other
+ third-party types, APIGroup is
+ required.
type: string
kind:
description: Kind is the type of
@@ -5279,22 +5591,32 @@ spec:
resource being referenced
type: string
namespace:
- description: |-
- Namespace is the namespace of resource being referenced
- Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.
- (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
+ description: Namespace is the namespace
+ of resource being referenced Note
+ that when a namespace is specified,
+ a gateway.networking.k8s.io/ReferenceGrant
+ object is required in the referent
+ namespace to allow that namespace's
+ owner to accept the reference.
+ See the ReferenceGrant documentation
+ for details. (Alpha) This field
+ requires the CrossNamespaceVolumeDataSource
+ feature gate to be enabled.
type: string
required:
- kind
- name
type: object
resources:
- description: |-
- resources represents the minimum resources the volume should have.
- If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements
- that are lower than previous value but must still be higher than capacity recorded in the
- status field of the claim.
- More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
+ description: 'resources represents the
+ minimum resources the volume should
+ have. If RecoverVolumeExpansionFailure
+ feature is enabled users are allowed
+ to specify resource requirements that
+ are lower than previous value but
+ must still be higher than capacity
+ recorded in the status field of the
+ claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
properties:
limits:
additionalProperties:
@@ -5303,9 +5625,9 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Limits describes the maximum amount of compute resources allowed.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Limits describes the
+ maximum amount of compute resources
+ allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
@@ -5314,11 +5636,15 @@ spec:
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: |-
- Requests describes the minimum amount of compute resources required.
- If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
- otherwise to an implementation-defined value. Requests cannot exceed Limits.
- More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ description: 'Requests describes
+ the minimum amount of compute
+ resources required. If Requests
+ is omitted for a container, it
+ defaults to Limits if that is
+ explicitly specified, otherwise
+ to an implementation-defined value.
+ Requests cannot exceed Limits.
+ More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
type: object
selector:
@@ -5330,9 +5656,11 @@ spec:
a list of label selector requirements.
The requirements are ANDed.
items:
- description: |-
- A label selector requirement is a selector that contains values, a key, and an operator that
- relates the key and values.
+ description: A label selector
+ requirement is a selector that
+ contains values, a key, and
+ an operator that relates the
+ key and values.
properties:
key:
description: key is the label
@@ -5340,16 +5668,23 @@ spec:
to.
type: string
operator:
- description: |-
- operator represents a key's relationship to a set of values.
- Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents
+ a key's relationship to
+ a set of values. Valid operators
+ are In, NotIn, Exists and
+ DoesNotExist.
type: string
values:
- description: |-
- values is an array of string values. If the operator is In or NotIn,
- the values array must be non-empty. If the operator is Exists or DoesNotExist,
- the values array must be empty. This array is replaced during a strategic
- merge patch.
+ description: values is an
+ array of string values.
+ If the operator is In or
+ NotIn, the values array
+ must be non-empty. If the
+ operator is Exists or DoesNotExist,
+ the values array must be
+ empty. This array is replaced
+ during a strategic merge
+ patch.
items:
type: string
type: array
@@ -5361,37 +5696,55 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: |-
- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions, whose key field is "key", the
- operator is "In", and the values array contains only "value". The requirements are ANDed.
+ description: matchLabels is a map
+ of {key,value} pairs. A single
+ {key,value} in the matchLabels
+ map is equivalent to an element
+ of matchExpressions, whose key
+ field is "key", the operator is
+ "In", and the values array contains
+ only "value". The requirements
+ are ANDed.
type: object
type: object
- x-kubernetes-map-type: atomic
storageClassName:
- description: |-
- storageClassName is the name of the StorageClass required by the claim.
- More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
+ description: 'storageClassName is the
+ name of the StorageClass required
+ by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
type: string
volumeAttributesClassName:
- description: |-
- volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.
- If specified, the CSI driver will create or update the volume with the attributes defined
- in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,
- it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass
- will be applied to the claim but it's not allowed to reset this field to empty string once it is set.
- If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass
- will be set by the persistentvolume controller if it exists.
- If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be
- set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource
- exists.
+ description: 'volumeAttributesClassName
+ may be used to set the VolumeAttributesClass
+ used by this claim. If specified,
+ the CSI driver will create or update
+ the volume with the attributes defined
+ in the corresponding VolumeAttributesClass.
+ This has a different purpose than
+ storageClassName, it can be changed
+ after the claim is created. An empty
+ string value means that no VolumeAttributesClass
+ will be applied to the claim but it''s
+ not allowed to reset this field to
+ empty string once it is set. If unspecified
+ and the PersistentVolumeClaim is unbound,
+ the default VolumeAttributesClass
+ will be set by the persistentvolume
+ controller if it exists. If the resource
+ referred to by volumeAttributesClass
+ does not exist, this PersistentVolumeClaim
+ will be set to a Pending state, as
+ reflected by the modifyVolumeStatus
+ field, until such as a resource exists.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass
- (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.
+ (Alpha) Using this field requires
+ the VolumeAttributesClass feature
+ gate to be enabled.'
type: string
volumeMode:
- description: |-
- volumeMode defines what type of volume is required by the claim.
- Value of Filesystem is implied when not included in claim spec.
+ description: volumeMode defines what
+ type of volume is required by the
+ claim. Value of Filesystem is implied
+ when not included in claim spec.
type: string
volumeName:
description: volumeName is the binding
@@ -5409,11 +5762,12 @@ spec:
then exposed to the pod.
properties:
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- TODO: how do we prevent errors in the filesystem from compromising the machine
+ description: 'fsType is the filesystem type
+ to mount. Must be a filesystem type supported
+ by the host operating system. Ex. "ext4",
+ "xfs", "ntfs". Implicitly inferred to be "ext4"
+ if unspecified. TODO: how do we prevent errors
+ in the filesystem from compromising the machine'
type: string
lun:
description: 'lun is Optional: FC target lun
@@ -5421,9 +5775,9 @@ spec:
format: int32
type: integer
readOnly:
- description: |-
- readOnly is Optional: Defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: 'readOnly is Optional: Defaults
+ to false (read/write). ReadOnly here will
+ force the ReadOnly setting in VolumeMounts.'
type: boolean
targetWWNs:
description: 'targetWWNs is Optional: FC target
@@ -5432,27 +5786,29 @@ spec:
type: string
type: array
wwids:
- description: |-
- wwids Optional: FC volume world wide identifiers (wwids)
- Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
+ description: 'wwids Optional: FC volume world
+ wide identifiers (wwids) Either wwids or combination
+ of targetWWNs and lun must be set, but not
+ both simultaneously.'
items:
type: string
type: array
type: object
flexVolume:
- description: |-
- flexVolume represents a generic volume resource that is
- provisioned/attached using an exec based plugin.
+ description: flexVolume represents a generic volume
+ resource that is provisioned/attached using an
+ exec based plugin.
properties:
driver:
description: driver is the name of the driver
to use for this volume.
type: string
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
+ description: fsType is the filesystem type to
+ mount. Must be a filesystem type supported
+ by the host operating system. Ex. "ext4",
+ "xfs", "ntfs". The default filesystem depends
+ on FlexVolume script.
type: string
options:
additionalProperties:
@@ -5461,26 +5817,26 @@ spec:
holds extra command options if any.'
type: object
readOnly:
- description: |-
- readOnly is Optional: defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: 'readOnly is Optional: defaults
+ to false (read/write). ReadOnly here will
+ force the ReadOnly setting in VolumeMounts.'
type: boolean
secretRef:
- description: |-
- secretRef is Optional: secretRef is reference to the secret object containing
- sensitive information to pass to the plugin scripts. This may be
- empty if no secret object is specified. If the secret object
- contains more than one secret, all secrets are passed to the plugin
- scripts.
+ description: 'secretRef is Optional: secretRef
+ is reference to the secret object containing
+ sensitive information to pass to the plugin
+ scripts. This may be empty if no secret object
+ is specified. If the secret object contains
+ more than one secret, all secrets are passed
+ to the plugin scripts.'
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
required:
- driver
type: object
@@ -5490,9 +5846,9 @@ spec:
on the Flocker control service being running
properties:
datasetName:
- description: |-
- datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker
- should be considered as deprecated
+ description: datasetName is Name of the dataset
+ stored as metadata -> name on the dataset
+ for Flocker should be considered as deprecated
type: string
datasetUUID:
description: datasetUUID is the UUID of the
@@ -5501,55 +5857,59 @@ spec:
type: string
type: object
gcePersistentDisk:
- description: |-
- gcePersistentDisk represents a GCE Disk resource that is attached to a
- kubelet's host machine and then exposed to the pod.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ description: 'gcePersistentDisk represents a GCE
+ Disk resource that is attached to a kubelet''s
+ host machine and then exposed to the pod. More
+ info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
properties:
fsType:
- description: |-
- fsType is filesystem type of the volume that you want to mount.
- Tip: Ensure that the filesystem type is supported by the host operating system.
- Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
- TODO: how do we prevent errors in the filesystem from compromising the machine
+ description: 'fsType is filesystem type of the
+ volume that you want to mount. Tip: Ensure
+ that the filesystem type is supported by the
+ host operating system. Examples: "ext4", "xfs",
+ "ntfs". Implicitly inferred to be "ext4" if
+ unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
partition:
- description: |-
- partition is the partition in the volume that you want to mount.
- If omitted, the default is to mount by volume name.
- Examples: For volume /dev/sda1, you specify the partition as "1".
- Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ description: 'partition is the partition in
+ the volume that you want to mount. If omitted,
+ the default is to mount by volume name. Examples:
+ For volume /dev/sda1, you specify the partition
+ as "1". Similarly, the volume partition for
+ /dev/sda is "0" (or you can leave the property
+ empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
format: int32
type: integer
pdName:
- description: |-
- pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ description: 'pdName is unique name of the PD
+ resource in GCE. Used to identify the disk
+ in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
type: string
readOnly:
- description: |-
- readOnly here will force the ReadOnly setting in VolumeMounts.
- Defaults to false.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ description: 'readOnly here will force the ReadOnly
+ setting in VolumeMounts. Defaults to false.
+ More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
type: boolean
required:
- pdName
type: object
gitRepo:
- description: |-
- gitRepo represents a git repository at a particular revision.
- DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an
- EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir
- into the Pod's container.
+ description: 'gitRepo represents a git repository
+ at a particular revision. DEPRECATED: GitRepo
+ is deprecated. To provision a container with a
+ git repo, mount an EmptyDir into an InitContainer
+ that clones the repo using git, then mount the
+ EmptyDir into the Pod''s container.'
properties:
directory:
- description: |-
- directory is the target directory name.
- Must not contain or start with '..'. If '.' is supplied, the volume directory will be the
- git repository. Otherwise, if specified, the volume will contain the git repository in
- the subdirectory with the given name.
+ description: directory is the target directory
+ name. Must not contain or start with '..'. If
+ '.' is supplied, the volume directory will
+ be the git repository. Otherwise, if specified,
+ the volume will contain the git repository
+ in the subdirectory with the given name.
type: string
repository:
description: repository is the URL
@@ -5562,61 +5922,55 @@ spec:
- repository
type: object
glusterfs:
- description: |-
- glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.
- More info: https://examples.k8s.io/volumes/glusterfs/README.md
+ description: 'glusterfs represents a Glusterfs mount
+ on the host that shares a pod''s lifetime. More
+ info: https://examples.k8s.io/volumes/glusterfs/README.md'
properties:
endpoints:
- description: |-
- endpoints is the endpoint name that details Glusterfs topology.
- More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
+ description: 'endpoints is the endpoint name
+ that details Glusterfs topology. More info:
+ https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: string
path:
- description: |-
- path is the Glusterfs volume path.
- More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
+ description: 'path is the Glusterfs volume path.
+ More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: string
readOnly:
- description: |-
- readOnly here will force the Glusterfs volume to be mounted with read-only permissions.
- Defaults to false.
- More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
+ description: 'readOnly here will force the Glusterfs
+ volume to be mounted with read-only permissions.
+ Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: boolean
required:
- endpoints
- path
type: object
hostPath:
- description: |-
- hostPath represents a pre-existing file or directory on the host
- machine that is directly exposed to the container. This is generally
- used for system agents or other privileged things that are allowed
- to see the host machine. Most containers will NOT need this.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
- ---
- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not
- mount host directories as read/write.
+ description: 'hostPath represents a pre-existing
+ file or directory on the host machine that is
+ directly exposed to the container. This is generally
+ used for system agents or other privileged things
+ that are allowed to see the host machine. Most
+ containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
+ --- TODO(jonesdl) We need to restrict who can
+ use host directory mounts and who can/can not
+ mount host directories as read/write.'
properties:
path:
- description: |-
- path of the directory on the host.
- If the path is a symlink, it will follow the link to the real path.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
+ description: 'path of the directory on the host.
+ If the path is a symlink, it will follow the
+ link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
type: string
type:
- description: |-
- type for HostPath Volume
- Defaults to ""
- More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
+ description: 'type for HostPath Volume Defaults
+ to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
type: string
required:
- path
type: object
iscsi:
- description: |-
- iscsi represents an ISCSI Disk resource that is attached to a
- kubelet's host machine and then exposed to the pod.
- More info: https://examples.k8s.io/volumes/iscsi/README.md
+ description: 'iscsi represents an ISCSI Disk resource
+ that is attached to a kubelet''s host machine
+ and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md'
properties:
chapAuthDiscovery:
description: chapAuthDiscovery defines whether
@@ -5627,27 +5981,30 @@ spec:
support iSCSI Session CHAP authentication
type: boolean
fsType:
- description: |-
- fsType is the filesystem type of the volume that you want to mount.
- Tip: Ensure that the filesystem type is supported by the host operating system.
- Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
- TODO: how do we prevent errors in the filesystem from compromising the machine
+ description: 'fsType is the filesystem type
+ of the volume that you want to mount. Tip:
+ Ensure that the filesystem type is supported
+ by the host operating system. Examples: "ext4",
+ "xfs", "ntfs". Implicitly inferred to be "ext4"
+ if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
initiatorName:
- description: |-
- initiatorName is the custom iSCSI Initiator Name.
- If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface
- : will be created for the connection.
+ description: initiatorName is the custom iSCSI
+ Initiator Name. If initiatorName is specified
+ with iscsiInterface simultaneously, new iSCSI
+ interface : will
+ be created for the connection.
type: string
iqn:
description: iqn is the target iSCSI Qualified
Name.
type: string
iscsiInterface:
- description: |-
- iscsiInterface is the interface Name that uses an iSCSI transport.
- Defaults to 'default' (tcp).
+ description: iscsiInterface is the interface
+ Name that uses an iSCSI transport. Defaults
+ to 'default' (tcp).
type: string
lun:
description: lun represents iSCSI Target Lun
@@ -5655,33 +6012,33 @@ spec:
format: int32
type: integer
portals:
- description: |-
- portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port
- is other than default (typically TCP ports 860 and 3260).
+ description: portals is the iSCSI Target Portal
+ List. The portal is either an IP or ip_addr:port
+ if the port is other than default (typically
+ TCP ports 860 and 3260).
items:
type: string
type: array
readOnly:
- description: |-
- readOnly here will force the ReadOnly setting in VolumeMounts.
- Defaults to false.
+ description: readOnly here will force the ReadOnly
+ setting in VolumeMounts. Defaults to false.
type: boolean
secretRef:
description: secretRef is the CHAP Secret for
iSCSI target and initiator authentication
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
targetPortal:
- description: |-
- targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port
- is other than default (typically TCP ports 860 and 3260).
+ description: targetPortal is iSCSI Target Portal.
+ The Portal is either an IP or ip_addr:port
+ if the port is other than default (typically
+ TCP ports 860 and 3260).
type: string
required:
- iqn
@@ -5689,51 +6046,44 @@ spec:
- targetPortal
type: object
name:
- description: |-
- name of the volume.
- Must be a DNS_LABEL and unique within the pod.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ description: 'name of the volume. Must be a DNS_LABEL
+ and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
type: string
nfs:
- description: |-
- nfs represents an NFS mount on the host that shares a pod's lifetime
- More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ description: 'nfs represents an NFS mount on the
+ host that shares a pod''s lifetime More info:
+ https://kubernetes.io/docs/concepts/storage/volumes#nfs'
properties:
path:
- description: |-
- path that is exported by the NFS server.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ description: 'path that is exported by the NFS
+ server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: string
readOnly:
- description: |-
- readOnly here will force the NFS export to be mounted with read-only permissions.
- Defaults to false.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ description: 'readOnly here will force the NFS
+ export to be mounted with read-only permissions.
+ Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: boolean
server:
- description: |-
- server is the hostname or IP address of the NFS server.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ description: 'server is the hostname or IP address
+ of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: string
required:
- path
- server
type: object
persistentVolumeClaim:
- description: |-
- persistentVolumeClaimVolumeSource represents a reference to a
- PersistentVolumeClaim in the same namespace.
- More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
+ description: 'persistentVolumeClaimVolumeSource
+ represents a reference to a PersistentVolumeClaim
+ in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
properties:
claimName:
- description: |-
- claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.
- More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
+ description: 'claimName is the name of a PersistentVolumeClaim
+ in the same namespace as the pod using this
+ volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
type: string
readOnly:
- description: |-
- readOnly Will force the ReadOnly setting in VolumeMounts.
- Default false.
+ description: readOnly Will force the ReadOnly
+ setting in VolumeMounts. Default false.
type: boolean
required:
- claimName
@@ -5744,10 +6094,11 @@ spec:
host machine
properties:
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: fsType is the filesystem type to
+ mount. Must be a filesystem type supported
+ by the host operating system. Ex. "ext4",
+ "xfs", "ntfs". Implicitly inferred to be "ext4"
+ if unspecified.
type: string
pdID:
description: pdID is the ID that identifies
@@ -5761,15 +6112,16 @@ spec:
volume attached and mounted on kubelets host machine
properties:
fsType:
- description: |-
- fSType represents the filesystem type to mount
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
+ description: fSType represents the filesystem
+ type to mount Must be a filesystem type supported
+ by the host operating system. Ex. "ext4",
+ "xfs". Implicitly inferred to be "ext4" if
+ unspecified.
type: string
readOnly:
- description: |-
- readOnly defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: readOnly defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
volumeID:
description: volumeID uniquely identifies a
@@ -5783,13 +6135,16 @@ spec:
secrets, configmaps, and downward API
properties:
defaultMode:
- description: |-
- defaultMode are the mode bits used to set permissions on created files by default.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- Directories within the path are not affected by this setting.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: defaultMode are the mode bits used
+ to set permissions on created files by default.
+ Must be an octal value between 0000 and 0777
+ or a decimal value between 0 and 511. YAML
+ accepts both octal and decimal values, JSON
+ requires decimal values for mode bits. Directories
+ within the path are not affected by this setting.
+ This might be in conflict with other options
+ that affect the file mode, like fsGroup, and
+ the result can be other mode bits set.
format: int32
type: integer
sources:
@@ -5799,30 +6154,31 @@ spec:
along with other supported volume types
properties:
clusterTrustBundle:
- description: |-
- ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field
- of ClusterTrustBundle objects in an auto-updating file.
-
-
- Alpha, gated by the ClusterTrustBundleProjection feature gate.
-
-
- ClusterTrustBundle objects can either be selected by name, or by the
- combination of signer name and a label selector.
-
-
- Kubelet performs aggressive normalization of the PEM contents written
- into the pod filesystem. Esoteric PEM features such as inter-block
- comments and block headers are stripped. Certificates are deduplicated.
- The ordering of certificates within the file is arbitrary, and Kubelet
- may change the order over time.
+ description: "ClusterTrustBundle allows
+ a pod to access the `.spec.trustBundle`
+ field of ClusterTrustBundle objects
+ in an auto-updating file. \n Alpha,
+ gated by the ClusterTrustBundleProjection
+ feature gate. \n ClusterTrustBundle
+ objects can either be selected by name,
+ or by the combination of signer name
+ and a label selector. \n Kubelet performs
+ aggressive normalization of the PEM
+ contents written into the pod filesystem.
+ \ Esoteric PEM features such as inter-block
+ comments and block headers are stripped.
+ \ Certificates are deduplicated. The
+ ordering of certificates within the
+ file is arbitrary, and Kubelet may change
+ the order over time."
properties:
labelSelector:
- description: |-
- Select all ClusterTrustBundles that match this label selector. Only has
- effect if signerName is set. Mutually-exclusive with name. If unset,
- interpreted as "match nothing". If set but empty, interpreted as "match
- everything".
+ description: Select all ClusterTrustBundles
+ that match this label selector. Only
+ has effect if signerName is set. Mutually-exclusive
+ with name. If unset, interpreted
+ as "match nothing". If set but
+ empty, interpreted as "match everything".
properties:
matchExpressions:
description: matchExpressions
@@ -5830,9 +6186,11 @@ spec:
requirements. The requirements
are ANDed.
items:
- description: |-
- A label selector requirement is a selector that contains values, a key, and an operator that
- relates the key and values.
+ description: A label selector
+ requirement is a selector
+ that contains values, a key,
+ and an operator that relates
+ the key and values.
properties:
key:
description: key is the
@@ -5840,16 +6198,23 @@ spec:
applies to.
type: string
operator:
- description: |-
- operator represents a key's relationship to a set of values.
- Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents
+ a key's relationship to
+ a set of values. Valid
+ operators are In, NotIn,
+ Exists and DoesNotExist.
type: string
values:
- description: |-
- values is an array of string values. If the operator is In or NotIn,
- the values array must be non-empty. If the operator is Exists or DoesNotExist,
- the values array must be empty. This array is replaced during a strategic
- merge patch.
+ description: values is an
+ array of string values.
+ If the operator is In
+ or NotIn, the values array
+ must be non-empty. If
+ the operator is Exists
+ or DoesNotExist, the values
+ array must be empty. This
+ array is replaced during
+ a strategic merge patch.
items:
type: string
type: array
@@ -5861,35 +6226,42 @@ spec:
matchLabels:
additionalProperties:
type: string
- description: |-
- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
- map is equivalent to an element of matchExpressions, whose key field is "key", the
- operator is "In", and the values array contains only "value". The requirements are ANDed.
+ description: matchLabels is a
+ map of {key,value} pairs. A
+ single {key,value} in the matchLabels
+ map is equivalent to an element
+ of matchExpressions, whose key
+ field is "key", the operator
+ is "In", and the values array
+ contains only "value". The requirements
+ are ANDed.
type: object
type: object
- x-kubernetes-map-type: atomic
name:
- description: |-
- Select a single ClusterTrustBundle by object name. Mutually-exclusive
+ description: Select a single ClusterTrustBundle
+ by object name. Mutually-exclusive
with signerName and labelSelector.
type: string
optional:
- description: |-
- If true, don't block pod startup if the referenced ClusterTrustBundle(s)
- aren't available. If using name, then the named ClusterTrustBundle is
- allowed not to exist. If using signerName, then the combination of
- signerName and labelSelector is allowed to match zero
- ClusterTrustBundles.
+ description: If true, don't block
+ pod startup if the referenced ClusterTrustBundle(s)
+ aren't available. If using name,
+ then the named ClusterTrustBundle
+ is allowed not to exist. If using
+ signerName, then the combination
+ of signerName and labelSelector
+ is allowed to match zero ClusterTrustBundles.
type: boolean
path:
description: Relative path from the
volume root to write the bundle.
type: string
signerName:
- description: |-
- Select all ClusterTrustBundles that match this signer name.
- Mutually-exclusive with name. The contents of all selected
- ClusterTrustBundles will be unified and deduplicated.
+ description: Select all ClusterTrustBundles
+ that match this signer name. Mutually-exclusive
+ with name. The contents of all
+ selected ClusterTrustBundles will
+ be unified and deduplicated.
type: string
required:
- path
@@ -5899,14 +6271,21 @@ spec:
the configMap data to project
properties:
items:
- description: |-
- items if unspecified, each key-value pair in the Data field of the referenced
- ConfigMap will be projected into the volume as a file whose name is the
- key and content is the value. If specified, the listed keys will be
- projected into the specified paths, and unlisted keys will not be
- present. If a key is specified which is not present in the ConfigMap,
- the volume setup will error unless it is marked optional. Paths must be
- relative and may not contain the '..' path or start with '..'.
+ description: items if unspecified,
+ each key-value pair in the Data
+ field of the referenced ConfigMap
+ will be projected into the volume
+ as a file whose name is the key
+ and content is the value. If specified,
+ the listed keys will be projected
+ into the specified paths, and unlisted
+ keys will not be present. If a key
+ is specified which is not present
+ in the ConfigMap, the volume setup
+ will error unless it is marked optional.
+ Paths must be relative and may not
+ contain the '..' path or start with
+ '..'.
items:
description: Maps a string key to
a path within a volume.
@@ -5916,21 +6295,30 @@ spec:
to project.
type: string
mode:
- description: |-
- mode is Optional: mode bits used to set permissions on this file.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'mode is Optional:
+ mode bits used to set permissions
+ on this file. Must be an octal
+ value between 0000 and 0777
+ or a decimal value between
+ 0 and 511. YAML accepts both
+ octal and decimal values,
+ JSON requires decimal values
+ for mode bits. If not specified,
+ the volume defaultMode will
+ be used. This might be in
+ conflict with other options
+ that affect the file mode,
+ like fsGroup, and the result
+ can be other mode bits set.'
format: int32
type: integer
path:
- description: |-
- path is the relative path of the file to map the key to.
- May not be an absolute path.
- May not contain the path element '..'.
- May not start with the string '..'.
+ description: path is the relative
+ path of the file to map the
+ key to. May not be an absolute
+ path. May not contain the
+ path element '..'. May not
+ start with the string '..'.
type: string
required:
- key
@@ -5938,10 +6326,10 @@ spec:
type: object
type: array
name:
- description: |-
- Name of the referent.
+ description: 'Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: optional specify whether
@@ -5949,7 +6337,6 @@ spec:
defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
downwardAPI:
description: downwardAPI information about
the downwardAPI data to project
@@ -5982,15 +6369,22 @@ spec:
required:
- fieldPath
type: object
- x-kubernetes-map-type: atomic
mode:
- description: |-
- Optional: mode bits used to set permissions on this file, must be an octal value
- between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'Optional: mode
+ bits used to set permissions
+ on this file, must be an octal
+ value between 0000 and 0777
+ or a decimal value between
+ 0 and 511. YAML accepts both
+ octal and decimal values,
+ JSON requires decimal values
+ for mode bits. If not specified,
+ the volume defaultMode will
+ be used. This might be in
+ conflict with other options
+ that affect the file mode,
+ like fsGroup, and the result
+ can be other mode bits set.'
format: int32
type: integer
path:
@@ -6004,9 +6398,12 @@ spec:
start with ''..'''
type: string
resourceFieldRef:
- description: |-
- Selects a resource of the container: only resources limits and requests
- (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
+ description: 'Selects a resource
+ of the container: only resources
+ limits and requests (limits.cpu,
+ limits.memory, requests.cpu
+ and requests.memory) are currently
+ supported.'
properties:
containerName:
description: 'Container
@@ -6030,7 +6427,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
required:
- path
type: object
@@ -6041,14 +6437,21 @@ spec:
the secret data to project
properties:
items:
- description: |-
- items if unspecified, each key-value pair in the Data field of the referenced
- Secret will be projected into the volume as a file whose name is the
- key and content is the value. If specified, the listed keys will be
- projected into the specified paths, and unlisted keys will not be
- present. If a key is specified which is not present in the Secret,
- the volume setup will error unless it is marked optional. Paths must be
- relative and may not contain the '..' path or start with '..'.
+ description: items if unspecified,
+ each key-value pair in the Data
+ field of the referenced Secret will
+ be projected into the volume as
+ a file whose name is the key and
+ content is the value. If specified,
+ the listed keys will be projected
+ into the specified paths, and unlisted
+ keys will not be present. If a key
+ is specified which is not present
+ in the Secret, the volume setup
+ will error unless it is marked optional.
+ Paths must be relative and may not
+ contain the '..' path or start with
+ '..'.
items:
description: Maps a string key to
a path within a volume.
@@ -6058,21 +6461,30 @@ spec:
to project.
type: string
mode:
- description: |-
- mode is Optional: mode bits used to set permissions on this file.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'mode is Optional:
+ mode bits used to set permissions
+ on this file. Must be an octal
+ value between 0000 and 0777
+ or a decimal value between
+ 0 and 511. YAML accepts both
+ octal and decimal values,
+ JSON requires decimal values
+ for mode bits. If not specified,
+ the volume defaultMode will
+ be used. This might be in
+ conflict with other options
+ that affect the file mode,
+ like fsGroup, and the result
+ can be other mode bits set.'
format: int32
type: integer
path:
- description: |-
- path is the relative path of the file to map the key to.
- May not be an absolute path.
- May not contain the path element '..'.
- May not start with the string '..'.
+ description: path is the relative
+ path of the file to map the
+ key to. May not be an absolute
+ path. May not contain the
+ path element '..'. May not
+ start with the string '..'.
type: string
required:
- key
@@ -6080,10 +6492,10 @@ spec:
type: object
type: array
name:
- description: |-
- Name of the referent.
+ description: 'Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
description: optional field specify
@@ -6091,33 +6503,40 @@ spec:
be defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
serviceAccountToken:
description: serviceAccountToken is information
about the serviceAccountToken data to
project
properties:
audience:
- description: |-
- audience is the intended audience of the token. A recipient of a token
- must identify itself with an identifier specified in the audience of the
- token, and otherwise should reject the token. The audience defaults to the
- identifier of the apiserver.
+ description: audience is the intended
+ audience of the token. A recipient
+ of a token must identify itself
+ with an identifier specified in
+ the audience of the token, and otherwise
+ should reject the token. The audience
+ defaults to the identifier of the
+ apiserver.
type: string
expirationSeconds:
- description: |-
- expirationSeconds is the requested duration of validity of the service
- account token. As the token approaches expiration, the kubelet volume
- plugin will proactively rotate the service account token. The kubelet will
- start trying to rotate the token if the token is older than 80 percent of
- its time to live or if the token is older than 24 hours.Defaults to 1 hour
+ description: expirationSeconds is
+ the requested duration of validity
+ of the service account token. As
+ the token approaches expiration,
+ the kubelet volume plugin will proactively
+ rotate the service account token.
+ The kubelet will start trying to
+ rotate the token if the token is
+ older than 80 percent of its time
+ to live or if the token is older
+ than 24 hours.Defaults to 1 hour
and must be at least 10 minutes.
format: int64
type: integer
path:
- description: |-
- path is the path relative to the mount point of the file to project the
- token into.
+ description: path is the path relative
+ to the mount point of the file to
+ project the token into.
type: string
required:
- path
@@ -6130,30 +6549,30 @@ spec:
on the host that shares a pod's lifetime
properties:
group:
- description: |-
- group to map volume access to
- Default is no group
+ description: group to map volume access to Default
+ is no group
type: string
readOnly:
- description: |-
- readOnly here will force the Quobyte volume to be mounted with read-only permissions.
+ description: readOnly here will force the Quobyte
+ volume to be mounted with read-only permissions.
Defaults to false.
type: boolean
registry:
- description: |-
- registry represents a single or multiple Quobyte Registry services
- specified as a string as host:port pair (multiple entries are separated with commas)
- which acts as the central registry for volumes
+ description: registry represents a single or
+ multiple Quobyte Registry services specified
+ as a string as host:port pair (multiple entries
+ are separated with commas) which acts as the
+ central registry for volumes
type: string
tenant:
- description: |-
- tenant owning the given Quobyte volume in the Backend
- Used with dynamically provisioned Quobyte volumes, value is set by the plugin
+ description: tenant owning the given Quobyte
+ volume in the Backend Used with dynamically
+ provisioned Quobyte volumes, value is set
+ by the plugin
type: string
user:
- description: |-
- user to map volume access to
- Defaults to serivceaccount user
+ description: user to map volume access to Defaults
+ to serivceaccount user
type: string
volume:
description: volume is a string that references
@@ -6164,68 +6583,59 @@ spec:
- volume
type: object
rbd:
- description: |-
- rbd represents a Rados Block Device mount on the host that shares a pod's lifetime.
- More info: https://examples.k8s.io/volumes/rbd/README.md
+ description: 'rbd represents a Rados Block Device
+ mount on the host that shares a pod''s lifetime.
+ More info: https://examples.k8s.io/volumes/rbd/README.md'
properties:
fsType:
- description: |-
- fsType is the filesystem type of the volume that you want to mount.
- Tip: Ensure that the filesystem type is supported by the host operating system.
- Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd
- TODO: how do we prevent errors in the filesystem from compromising the machine
+ description: 'fsType is the filesystem type
+ of the volume that you want to mount. Tip:
+ Ensure that the filesystem type is supported
+ by the host operating system. Examples: "ext4",
+ "xfs", "ntfs". Implicitly inferred to be "ext4"
+ if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
image:
- description: |-
- image is the rados image name.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'image is the rados image name.
+ More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
keyring:
- description: |-
- keyring is the path to key ring for RBDUser.
- Default is /etc/ceph/keyring.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'keyring is the path to key ring
+ for RBDUser. Default is /etc/ceph/keyring.
+ More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
monitors:
- description: |-
- monitors is a collection of Ceph monitors.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'monitors is a collection of Ceph
+ monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
items:
type: string
type: array
pool:
- description: |-
- pool is the rados pool name.
- Default is rbd.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'pool is the rados pool name. Default
+ is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
readOnly:
- description: |-
- readOnly here will force the ReadOnly setting in VolumeMounts.
- Defaults to false.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'readOnly here will force the ReadOnly
+ setting in VolumeMounts. Defaults to false.
+ More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: boolean
secretRef:
- description: |-
- secretRef is name of the authentication secret for RBDUser. If provided
- overrides keyring.
- Default is nil.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'secretRef is name of the authentication
+ secret for RBDUser. If provided overrides
+ keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
user:
- description: |-
- user is the rados user name.
- Default is admin.
- More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ description: 'user is the rados user name. Default
+ is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
required:
- image
@@ -6236,11 +6646,10 @@ spec:
volume attached and mounted on Kubernetes nodes.
properties:
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs".
- Default is "xfs".
+ description: fsType is the filesystem type to
+ mount. Must be a filesystem type supported
+ by the host operating system. Ex. "ext4",
+ "xfs", "ntfs". Default is "xfs".
type: string
gateway:
description: gateway is the host address of
@@ -6252,31 +6661,31 @@ spec:
storage.
type: string
readOnly:
- description: |-
- readOnly Defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: readOnly Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
secretRef:
- description: |-
- secretRef references to the secret for ScaleIO user and other
- sensitive information. If this is not provided, Login operation will fail.
+ description: secretRef references to the secret
+ for ScaleIO user and other sensitive information.
+ If this is not provided, Login operation will
+ fail.
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
sslEnabled:
description: sslEnabled Flag enable/disable
SSL communication with Gateway, default false
type: boolean
storageMode:
- description: |-
- storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.
- Default is ThinProvisioned.
+ description: storageMode indicates whether the
+ storage for a volume should be ThickProvisioned
+ or ThinProvisioned. Default is ThinProvisioned.
type: string
storagePool:
description: storagePool is the ScaleIO Storage
@@ -6287,9 +6696,9 @@ spec:
system as configured in ScaleIO.
type: string
volumeName:
- description: |-
- volumeName is the name of a volume already created in the ScaleIO system
- that is associated with this volume source.
+ description: volumeName is the name of a volume
+ already created in the ScaleIO system that
+ is associated with this volume source.
type: string
required:
- gateway
@@ -6297,30 +6706,35 @@ spec:
- system
type: object
secret:
- description: |-
- secret represents a secret that should populate this volume.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
+ description: 'secret represents a secret that should
+ populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
properties:
defaultMode:
- description: |-
- defaultMode is Optional: mode bits used to set permissions on created files by default.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values
- for mode bits. Defaults to 0644.
- Directories within the path are not affected by this setting.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'defaultMode is Optional: mode
+ bits used to set permissions on created files
+ by default. Must be an octal value between
+ 0000 and 0777 or a decimal value between 0
+ and 511. YAML accepts both octal and decimal
+ values, JSON requires decimal values for mode
+ bits. Defaults to 0644. Directories within
+ the path are not affected by this setting.
+ This might be in conflict with other options
+ that affect the file mode, like fsGroup, and
+ the result can be other mode bits set.'
format: int32
type: integer
items:
- description: |-
- items If unspecified, each key-value pair in the Data field of the referenced
- Secret will be projected into the volume as a file whose name is the
- key and content is the value. If specified, the listed keys will be
- projected into the specified paths, and unlisted keys will not be
- present. If a key is specified which is not present in the Secret,
- the volume setup will error unless it is marked optional. Paths must be
- relative and may not contain the '..' path or start with '..'.
+ description: items If unspecified, each key-value
+ pair in the Data field of the referenced Secret
+ will be projected into the volume as a file
+ whose name is the key and content is the value.
+ If specified, the listed keys will be projected
+ into the specified paths, and unlisted keys
+ will not be present. If a key is specified
+ which is not present in the Secret, the volume
+ setup will error unless it is marked optional.
+ Paths must be relative and may not contain
+ the '..' path or start with '..'.
items:
description: Maps a string key to a path within
a volume.
@@ -6329,21 +6743,26 @@ spec:
description: key is the key to project.
type: string
mode:
- description: |-
- mode is Optional: mode bits used to set permissions on this file.
- Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
- YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
- If not specified, the volume defaultMode will be used.
- This might be in conflict with other options that affect the file
- mode, like fsGroup, and the result can be other mode bits set.
+ description: 'mode is Optional: mode bits
+ used to set permissions on this file.
+ Must be an octal value between 0000
+ and 0777 or a decimal value between
+ 0 and 511. YAML accepts both octal and
+ decimal values, JSON requires decimal
+ values for mode bits. If not specified,
+ the volume defaultMode will be used.
+ This might be in conflict with other
+ options that affect the file mode, like
+ fsGroup, and the result can be other
+ mode bits set.'
format: int32
type: integer
path:
- description: |-
- path is the relative path of the file to map the key to.
- May not be an absolute path.
- May not contain the path element '..'.
- May not start with the string '..'.
+ description: path is the relative path
+ of the file to map the key to. May not
+ be an absolute path. May not contain
+ the path element '..'. May not start
+ with the string '..'.
type: string
required:
- key
@@ -6355,9 +6774,9 @@ spec:
the Secret or its keys must be defined
type: boolean
secretName:
- description: |-
- secretName is the name of the secret in the pod's namespace to use.
- More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
+ description: 'secretName is the name of the
+ secret in the pod''s namespace to use. More
+ info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
type: string
type: object
storageos:
@@ -6365,42 +6784,45 @@ spec:
attached and mounted on Kubernetes nodes.
properties:
fsType:
- description: |-
- fsType is the filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: fsType is the filesystem type to
+ mount. Must be a filesystem type supported
+ by the host operating system. Ex. "ext4",
+ "xfs", "ntfs". Implicitly inferred to be "ext4"
+ if unspecified.
type: string
readOnly:
- description: |-
- readOnly defaults to false (read/write). ReadOnly here will force
- the ReadOnly setting in VolumeMounts.
+ description: readOnly defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
secretRef:
- description: |-
- secretRef specifies the secret to use for obtaining the StorageOS API
- credentials. If not specified, default values will be attempted.
+ description: secretRef specifies the secret
+ to use for obtaining the StorageOS API credentials. If
+ not specified, default values will be attempted.
properties:
name:
- description: |-
- Name of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- TODO: Add other useful fields. apiVersion, kind, uid?
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
- x-kubernetes-map-type: atomic
volumeName:
- description: |-
- volumeName is the human-readable name of the StorageOS volume. Volume
- names are only unique within a namespace.
+ description: volumeName is the human-readable
+ name of the StorageOS volume. Volume names
+ are only unique within a namespace.
type: string
volumeNamespace:
- description: |-
- volumeNamespace specifies the scope of the volume within StorageOS. If no
- namespace is specified then the Pod's namespace will be used. This allows the
- Kubernetes name scoping to be mirrored within StorageOS for tighter integration.
- Set VolumeName to any name to override the default behaviour.
- Set to "default" if you are not using namespaces within StorageOS.
- Namespaces that do not pre-exist within StorageOS will be created.
+ description: volumeNamespace specifies the scope
+ of the volume within StorageOS. If no namespace
+ is specified then the Pod's namespace will
+ be used. This allows the Kubernetes name
+ scoping to be mirrored within StorageOS for
+ tighter integration. Set VolumeName to any
+ name to override the default behaviour. Set
+ to "default" if you are not using namespaces
+ within StorageOS. Namespaces that do not pre-exist
+ within StorageOS will be created.
type: string
type: object
vsphereVolume:
@@ -6408,10 +6830,11 @@ spec:
volume attached and mounted on kubelets host machine
properties:
fsType:
- description: |-
- fsType is filesystem type to mount.
- Must be a filesystem type supported by the host operating system.
- Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: fsType is filesystem type to mount.
+ Must be a filesystem type supported by the
+ host operating system. Ex. "ext4", "xfs",
+ "ntfs". Implicitly inferred to be "ext4" if
+ unspecified.
type: string
storagePolicyID:
description: storagePolicyID is the storage
@@ -6462,9 +6885,8 @@ spec:
description: The configuration of Affinity trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6483,9 +6905,9 @@ spec:
integration in the same node (default `false`).
type: boolean
podAffinityLabels:
- description: |-
- Defines a set of pods (namely those matching the label selector, relative to the given namespace) that the
- integration pod(s) should be co-located with.
+ description: Defines a set of pods (namely those matching
+ the label selector, relative to the given namespace)
+ that the integration pod(s) should be co-located with.
items:
type: string
type: array
@@ -6494,9 +6916,10 @@ spec:
integration in the same node (default `false`).
type: boolean
podAntiAffinityLabels:
- description: |-
- Defines a set of pods (namely those matching the label selector, relative to the given namespace) that the
- integration pod(s) should not be co-located with.
+ description: Defines a set of pods (namely those matching
+ the label selector, relative to the given namespace)
+ that the integration pod(s) should not be co-located
+ with.
items:
type: string
type: array
@@ -6511,14 +6934,14 @@ spec:
use for the builder pod.
type: object
baseImage:
- description: |-
- Specify a base image. In order to have the application working properly it must be a container image which has a Java JDK
- installed and ready to use on path (ie `/usr/bin/java`).
+ description: Specify a base image. In order to have the
+ application working properly it must be a container
+ image which has a Java JDK installed and ready to use
+ on path (ie `/usr/bin/java`).
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6529,21 +6952,28 @@ spec:
reuse existing containers (default `true`)
type: boolean
limitCPU:
- description: |-
- When using `pod` strategy, the maximum amount of CPU required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the maximum amount
+ of CPU required by the pod builder. Deprecated: use
+ TasksRequestCPU instead with task name `builder`.'
type: string
limitMemory:
- description: |-
- When using `pod` strategy, the maximum amount of memory required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the maximum amount
+ of memory required by the pod builder. Deprecated: use
+ TasksRequestCPU instead with task name `builder`.'
type: string
mavenProfiles:
- description: |-
- A list of references pointing to configmaps/secrets that contains a maven profile.
- This configmap/secret is a resource of the IntegrationKit created, therefore it needs to be present in the namespace where the operator is going to create the IntegrationKit.
- The content of the maven profile is expected to be a text containing a valid maven profile starting with `` and ending with `` that will be integrated as an inline profile in the POM.
- Syntax: [configmap|secret]:name[/key], where name represents the resource name, key optionally represents the resource key to be filtered (default key value = profile.xml).
+ description: 'A list of references pointing to configmaps/secrets
+ that contains a maven profile. This configmap/secret
+ is a resource of the IntegrationKit created, therefore
+ it needs to be present in the namespace where the operator
+ is going to create the IntegrationKit. The content of
+ the maven profile is expected to be a text containing
+ a valid maven profile starting with `` and
+ ending with `` that will be integrated as
+ an inline profile in the POM. Syntax: [configmap|secret]:name[/key],
+ where name represents the resource name, key optionally
+ represents the resource key to be filtered (default
+ key value = profile.xml).'
items:
type: string
type: array
@@ -6575,14 +7005,14 @@ spec:
type: string
type: array
requestCPU:
- description: |-
- When using `pod` strategy, the minimum amount of CPU required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the minimum amount
+ of CPU required by the pod builder. Deprecated: use
+ TasksRequestCPU instead with task name `builder`.'
type: string
requestMemory:
- description: |-
- When using `pod` strategy, the minimum amount of memory required by the pod builder.
- Deprecated: use TasksRequestCPU instead with task name `builder`.
+ description: 'When using `pod` strategy, the minimum amount
+ of memory required by the pod builder. Deprecated: use
+ TasksRequestCPU instead with task name `builder`.'
type: string
strategy:
description: The strategy to use, either `pod` or `routine`
@@ -6598,10 +7028,11 @@ spec:
type: string
type: array
tasksFilter:
- description: |-
- A list of tasks sorted by the order of execution in a csv format, ie, `,,...`.
- Mind that you must include also the operator tasks (`builder`, `quarkus-native`, `package`, `jib`, `s2i`)
- if you need to execute them. Useful only with `pod` strategy.
+ description: A list of tasks sorted by the order of execution
+ in a csv format, ie, `,,...`.
+ Mind that you must include also the operator tasks (`builder`,
+ `quarkus-native`, `package`, `jib`, `s2i`) if you need
+ to execute them. Useful only with `pod` strategy.
type: string
tasksLimitCPU:
description: A list of limit cpu configuration for the
@@ -6628,18 +7059,17 @@ spec:
type: string
type: array
verbose:
- description: |-
- Enable verbose logging on build components that support it (e.g. Kaniko build pod).
- Deprecated no longer in use
+ description: Enable verbose logging on build components
+ that support it (e.g. Kaniko build pod). Deprecated
+ no longer in use
type: boolean
type: object
camel:
description: The configuration of Camel trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6652,10 +7082,12 @@ spec:
type: string
type: array
runtimeVersion:
- description: |-
- The camel-k-runtime version to use for the integration. It overrides the default version set in the Integration Platform.
- You can use a fixed version (for example "3.2.3") or a semantic version (for example "3.x") which will try to resolve
- to the best matching Catalog existing on the cluster.
+ description: The camel-k-runtime version to use for the
+ integration. It overrides the default version set in
+ the Integration Platform. You can use a fixed version
+ (for example "3.2.3") or a semantic version (for example
+ "3.x") which will try to resolve to the best matching
+ Catalog existing on the cluster.
type: string
type: object
container:
@@ -6685,9 +7117,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6698,10 +7129,14 @@ spec:
kubernetes Service.
type: boolean
image:
- description: |-
- The main container image to use for the Integration. When using this parameter the operator will create a synthetic IntegrationKit which
- won't be able to execute traits requiring CamelCatalog. If the container image you're using is coming from an IntegrationKit, use instead
- Integration `.spec.integrationKit` parameter. If you're moving the Integration across environments, you will also need to create an "external" IntegrationKit.
+ description: The main container image to use for the Integration.
+ When using this parameter the operator will create a
+ synthetic IntegrationKit which won't be able to execute
+ traits requiring CamelCatalog. If the container image
+ you're using is coming from an IntegrationKit, use instead
+ Integration `.spec.integrationKit` parameter. If you're
+ moving the Integration across environments, you will
+ also need to create an "external" IntegrationKit.
type: string
imagePullPolicy:
description: 'The pull policy: Always|Never|IfNotPresent'
@@ -6769,52 +7204,52 @@ spec:
description: The configuration of Cron trait
properties:
activeDeadlineSeconds:
- description: |-
- Specifies the duration in seconds, relative to the start time, that the job
- may be continuously active before it is considered to be failed.
- It defaults to 60s.
+ description: Specifies the duration in seconds, relative
+ to the start time, that the job may be continuously
+ active before it is considered to be failed. It defaults
+ to 60s.
format: int64
type: integer
auto:
- description: |-
- Automatically deploy the integration as CronJob when all routes are
- either starting from a periodic consumer (only `cron`, `timer` and `quartz` are supported) or a passive consumer (e.g. `direct` is a passive consumer).
-
-
- It's required that all periodic consumers have the same period, and it can be expressed as cron schedule (e.g. `1m` can be expressed as `0/1 * * * *`,
- while `35m` or `50s` cannot).
+ description: "Automatically deploy the integration as
+ CronJob when all routes are either starting from a periodic
+ consumer (only `cron`, `timer` and `quartz` are supported)
+ or a passive consumer (e.g. `direct` is a passive consumer).
+ \n It's required that all periodic consumers have the
+ same period, and it can be expressed as cron schedule
+ (e.g. `1m` can be expressed as `0/1 * * * *`, while
+ `35m` or `50s` cannot)."
type: boolean
backoffLimit:
- description: |-
- Specifies the number of retries before marking the job failed.
- It defaults to 2.
+ description: Specifies the number of retries before marking
+ the job failed. It defaults to 2.
format: int32
type: integer
components:
- description: |-
- A comma separated list of the Camel components that need to be customized in order for them to work when the schedule is triggered externally by Kubernetes.
- A specific customizer is activated for each specified component. E.g. for the `timer` component, the `cron-timer` customizer is
- activated (it's present in the `org.apache.camel.k:camel-k-cron` library).
-
-
- Supported components are currently: `cron`, `timer` and `quartz`.
+ description: "A comma separated list of the Camel components
+ that need to be customized in order for them to work
+ when the schedule is triggered externally by Kubernetes.
+ A specific customizer is activated for each specified
+ component. E.g. for the `timer` component, the `cron-timer`
+ customizer is activated (it's present in the `org.apache.camel.k:camel-k-cron`
+ library). \n Supported components are currently: `cron`,
+ `timer` and `quartz`."
type: string
concurrencyPolicy:
- description: |-
- Specifies how to treat concurrent executions of a Job.
- Valid values are:
- - "Allow": allows CronJobs to run concurrently;
- - "Forbid" (default): forbids concurrent runs, skipping next run if previous run hasn't finished yet;
- - "Replace": cancels currently running job and replaces it with a new one
+ description: 'Specifies how to treat concurrent executions
+ of a Job. Valid values are: - "Allow": allows CronJobs
+ to run concurrently; - "Forbid" (default): forbids concurrent
+ runs, skipping next run if previous run hasn''t finished
+ yet; - "Replace": cancels currently running job and
+ replaces it with a new one'
enum:
- Allow
- Forbid
- Replace
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6822,19 +7257,19 @@ spec:
All traits share this common property.
type: boolean
fallback:
- description: |-
- Use the default Camel implementation of the `cron` endpoint (`quartz`) instead of trying to materialize the integration
- as Kubernetes CronJob.
+ description: Use the default Camel implementation of the
+ `cron` endpoint (`quartz`) instead of trying to materialize
+ the integration as Kubernetes CronJob.
type: boolean
schedule:
- description: |-
- The CronJob schedule for the whole integration. If multiple routes are declared, they must have the same schedule for this
- mechanism to work correctly.
+ description: The CronJob schedule for the whole integration.
+ If multiple routes are declared, they must have the
+ same schedule for this mechanism to work correctly.
type: string
startingDeadlineSeconds:
- description: |-
- Optional deadline in seconds for starting the job if it misses scheduled
- time for any reason. Missed jobs executions will be counted as failed ones.
+ description: Optional deadline in seconds for starting
+ the job if it misses scheduled time for any reason. Missed
+ jobs executions will be counted as failed ones.
format: int64
type: integer
timeZone:
@@ -6845,9 +7280,8 @@ spec:
description: The configuration of Dependencies trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6858,9 +7292,8 @@ spec:
description: The configuration of Deployer trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6876,51 +7309,49 @@ spec:
- knative-service
type: string
useSSA:
- description: |-
- Use server-side apply to update the owned resources (default `true`).
- Note that it automatically falls back to client-side patching, if SSA is not available, e.g., on old Kubernetes clusters.
+ description: Use server-side apply to update the owned
+ resources (default `true`). Note that it automatically
+ falls back to client-side patching, if SSA is not available,
+ e.g., on old Kubernetes clusters.
type: boolean
type: object
deployment:
description: The configuration of Deployment trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
description: 'Deprecated: no longer in use.'
type: boolean
progressDeadlineSeconds:
- description: |-
- The maximum time in seconds for the deployment to make progress before it
- is considered to be failed. It defaults to `60s`.
+ description: The maximum time in seconds for the deployment
+ to make progress before it is considered to be failed.
+ It defaults to `60s`.
format: int32
type: integer
rollingUpdateMaxSurge:
anyOf:
- type: integer
- type: string
- description: |-
- The maximum number of pods that can be scheduled above the desired number of
- pods.
- Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
- This can not be 0 if MaxUnavailable is 0.
- Absolute number is calculated from percentage by rounding up.
- Defaults to `25%`.
+ description: 'The maximum number of pods that can be scheduled
+ above the desired number of pods. Value can be an absolute
+ number (ex: 5) or a percentage of desired pods (ex:
+ 10%). This can not be 0 if MaxUnavailable is 0. Absolute
+ number is calculated from percentage by rounding up.
+ Defaults to `25%`.'
x-kubernetes-int-or-string: true
rollingUpdateMaxUnavailable:
anyOf:
- type: integer
- type: string
- description: |-
- The maximum number of pods that can be unavailable during the update.
- Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
- Absolute number is calculated from percentage by rounding down.
- This can not be 0 if MaxSurge is 0.
- Defaults to `25%`.
+ description: 'The maximum number of pods that can be unavailable
+ during the update. Value can be an absolute number (ex:
+ 5) or a percentage of desired pods (ex: 10%). Absolute
+ number is calculated from percentage by rounding down.
+ This can not be 0 if MaxSurge is 0. Defaults to `25%`.'
x-kubernetes-int-or-string: true
strategy:
description: The deployment strategy to use to replace
@@ -6934,9 +7365,8 @@ spec:
description: The configuration of Environment trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
containerMeta:
@@ -6951,11 +7381,12 @@ spec:
and `NO_PROXY` environment variables (default `true`)
type: boolean
vars:
- description: |-
- A list of environment variables to be added to the integration container.
- The syntax is either VAR=VALUE or VAR=[configmap|secret]:name/key, where name represents the resource name,
- and key represents the resource key to be mapped as and environment variable.
- These take precedence over any previously defined environment variables.
+ description: A list of environment variables to be added
+ to the integration container. The syntax is either VAR=VALUE
+ or VAR=[configmap|secret]:name/key, where name represents
+ the resource name, and key represents the resource key
+ to be mapped as and environment variable. These take
+ precedence over any previously defined environment variables.
items:
type: string
type: array
@@ -6964,9 +7395,8 @@ spec:
description: The configuration of Error Handler trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -6981,15 +7411,14 @@ spec:
description: The configuration of GC trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
discoveryCache:
- description: |-
- Discovery client cache to be used, either `disabled`, `disk` or `memory` (default `memory`).
- Deprecated: to be removed from trait configuration.
+ description: 'Discovery client cache to be used, either
+ `disabled`, `disk` or `memory` (default `memory`). Deprecated:
+ to be removed from trait configuration.'
enum:
- disabled
- disk
@@ -7004,9 +7433,8 @@ spec:
description: The configuration of Health trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7128,19 +7556,17 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to the ingress.
- This can be used to set controller specific annotations, e.g., when using the NGINX Ingress controller:
- See https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md
+ description: 'The annotations added to the ingress. This
+ can be used to set controller specific annotations,
+ e.g., when using the NGINX Ingress controller: See https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md'
type: object
auto:
description: To automatically add an ingress whenever
the integration uses an HTTP endpoint consumer.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7150,14 +7576,18 @@ spec:
host:
description: To configure the host exposed by the ingress.
type: string
+ ingressClassName:
+ description: The Ingress class name as defined by the
+ Ingress spec See https://kubernetes.io/docs/concepts/services-networking/ingress/
+ type: string
path:
description: To configure the path exposed by the ingress
(default `/`).
type: string
pathType:
- description: |-
- To configure the path type exposed by the ingress.
- One of `Exact`, `Prefix`, `ImplementationSpecific` (default to `Prefix`).
+ description: To configure the path type exposed by the
+ ingress. One of `Exact`, `Prefix`, `ImplementationSpecific`
+ (default to `Prefix`).
enum:
- Exact
- Prefix
@@ -7182,9 +7612,8 @@ spec:
default).
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7201,23 +7630,25 @@ spec:
description: The configuration of Jolokia trait
properties:
CACert:
- description: |-
- The PEM encoded CA certification file path, used to verify client certificates,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt` for OpenShift).
+ description: The PEM encoded CA certification file path,
+ used to verify client certificates, applicable when
+ `protocol` is `https` and `use-ssl-client-authentication`
+ is `true` (default `/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt`
+ for OpenShift).
type: string
clientPrincipal:
- description: |-
- The principal(s) which must be given in a client certificate to allow access to the Jolokia endpoint,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `clientPrincipal=cn=system:master-proxy`, `cn=hawtio-online.hawtio.svc` and `cn=fuse-console.fuse.svc` for OpenShift).
+ description: The principal(s) which must be given in a
+ client certificate to allow access to the Jolokia endpoint,
+ applicable when `protocol` is `https` and `use-ssl-client-authentication`
+ is `true` (default `clientPrincipal=cn=system:master-proxy`,
+ `cn=hawtio-online.hawtio.svc` and `cn=fuse-console.fuse.svc`
+ for OpenShift).
items:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
discoveryEnabled:
@@ -7228,20 +7659,20 @@ spec:
All traits share this common property.
type: boolean
extendedClientCheck:
- description: |-
- Mandate the client certificate contains a client flag in the extended key usage section,
- applicable when `protocol` is `https` and `use-ssl-client-authentication` is `true`
- (default `true` for OpenShift).
+ description: Mandate the client certificate contains a
+ client flag in the extended key usage section, applicable
+ when `protocol` is `https` and `use-ssl-client-authentication`
+ is `true` (default `true` for OpenShift).
type: boolean
host:
- description: |-
- The Host address to which the Jolokia agent should bind to. If `"\*"` or `"0.0.0.0"` is given,
- the servers binds to every network interface (default `"*"`).
+ description: The Host address to which the Jolokia agent
+ should bind to. If `"\*"` or `"0.0.0.0"` is given, the
+ servers binds to every network interface (default `"*"`).
type: string
options:
- description: |-
- A list of additional Jolokia options as defined
- in https://jolokia.org/reference/html/agents.html#agent-jvm-config[JVM agent configuration options]
+ description: A list of additional Jolokia options as defined
+ in https://jolokia.org/reference/html/agents.html#agent-jvm-config[JVM
+ agent configuration options]
items:
type: string
type: array
@@ -7272,9 +7703,8 @@ spec:
separator)
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
debug:
@@ -7303,9 +7733,9 @@ spec:
type: string
type: array
printCommand:
- description: |-
- Prints the command used the start the JVM in the container logs (default `true`)
- Deprecated: no longer in use.
+ description: 'Prints the command used the start the JVM
+ in the container logs (default `true`) Deprecated: no
+ longer in use.'
type: boolean
type: object
kamelets:
@@ -7316,9 +7746,8 @@ spec:
and their default configuration (enabled by default)
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7351,16 +7780,16 @@ spec:
description: Enable automatic discovery of all trait properties.
type: boolean
channelSinks:
- description: |-
- List of channels used as destination of integration routes.
- Can contain simple channel names or full Camel URIs.
+ description: List of channels used as destination of integration
+ routes. Can contain simple channel names or full Camel
+ URIs.
items:
type: string
type: array
channelSources:
- description: |-
- List of channels used as source of integration routes.
- Can contain simple channel names or full Camel URIs.
+ description: List of channels used as source of integration
+ routes. Can contain simple channel names or full Camel
+ URIs.
items:
type: string
type: array
@@ -7369,9 +7798,8 @@ spec:
configuration in JSON format.
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7379,9 +7807,9 @@ spec:
All traits share this common property.
type: boolean
endpointSinks:
- description: |-
- List of endpoints used as destination of integration routes.
- Can contain simple endpoint names or full Camel URIs.
+ description: List of endpoints used as destination of
+ integration routes. Can contain simple endpoint names
+ or full Camel URIs.
items:
type: string
type: array
@@ -7392,49 +7820,56 @@ spec:
type: string
type: array
eventSinks:
- description: |-
- List of event types that the integration will produce.
- Can contain simple event types or full Camel URIs (to use a specific broker).
+ description: List of event types that the integration
+ will produce. Can contain simple event types or full
+ Camel URIs (to use a specific broker).
items:
type: string
type: array
eventSources:
- description: |-
- List of event types that the integration will be subscribed to.
- Can contain simple event types or full Camel URIs (to use a specific broker different from "default").
+ description: List of event types that the integration
+ will be subscribed to. Can contain simple event types
+ or full Camel URIs (to use a specific broker different
+ from "default").
items:
type: string
type: array
filterEventType:
- description: |-
- Enables the default filtering for the Knative trigger using the event type
- If this is true, the created Knative trigger uses the event type as a filter on the event stream when no other filter criteria is given. (default: true)
+ description: 'Enables the default filtering for the Knative
+ trigger using the event type If this is true, the created
+ Knative trigger uses the event type as a filter on the
+ event stream when no other filter criteria is given.
+ (default: true)'
type: boolean
filterSourceChannels:
- description: |-
- Enables filtering on events based on the header "ce-knativehistory". Since this header has been removed in newer versions of
- Knative, filtering is disabled by default.
+ description: Enables filtering on events based on the
+ header "ce-knativehistory". Since this header has been
+ removed in newer versions of Knative, filtering is disabled
+ by default.
type: boolean
filters:
- description: |-
- Sets filter attributes on the event stream (such as event type, source, subject and so on).
- A list of key-value pairs that represent filter attributes and its values.
- The syntax is KEY=VALUE, e.g., `source="my.source"`.
- Filter attributes get set on the Knative trigger that is being created as part of this integration.
+ description: Sets filter attributes on the event stream
+ (such as event type, source, subject and so on). A list
+ of key-value pairs that represent filter attributes
+ and its values. The syntax is KEY=VALUE, e.g., `source="my.source"`.
+ Filter attributes get set on the Knative trigger that
+ is being created as part of this integration.
items:
type: string
type: array
namespaceLabel:
- description: |-
- Enables the camel-k-operator to set the "bindings.knative.dev/include=true" label to the namespace
- As Knative requires this label to perform injection of K_SINK URL into the service.
- If this is false, the integration pod may start and fail, read the SinkBinding Knative documentation. (default: true)
+ description: 'Enables the camel-k-operator to set the
+ "bindings.knative.dev/include=true" label to the namespace
+ As Knative requires this label to perform injection
+ of K_SINK URL into the service. If this is false, the
+ integration pod may start and fail, read the SinkBinding
+ Knative documentation. (default: true)'
type: boolean
sinkBinding:
- description: |-
- Allows binding the integration to a sink via a Knative SinkBinding resource.
- This can be used when the integration targets a single sink.
- It's enabled by default when the integration targets a single sink
+ description: Allows binding the integration to a sink
+ via a Knative SinkBinding resource. This can be used
+ when the integration targets a single sink. It's enabled
+ by default when the integration targets a single sink
(except when the integration is owned by a Knative source).
type: boolean
type: object
@@ -7444,47 +7879,41 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to route.
- This can be used to set knative service specific annotations
- CLI usage example: -t "knative-service.annotations.'haproxy.router.openshift.io/balance'=true"
+ description: 'The annotations added to route. This can
+ be used to set knative service specific annotations
+ CLI usage example: -t "knative-service.annotations.''haproxy.router.openshift.io/balance''=true"'
type: object
auto:
- description: |-
- Automatically deploy the integration as Knative service when all conditions hold:
-
-
- * Integration is using the Knative profile
- * All routes are either starting from an HTTP based consumer or a passive consumer (e.g. `direct` is a passive consumer)
+ description: "Automatically deploy the integration as
+ Knative service when all conditions hold: \n * Integration
+ is using the Knative profile * All routes are either
+ starting from an HTTP based consumer or a passive consumer
+ (e.g. `direct` is a passive consumer)"
type: boolean
autoscalingMetric:
- description: |-
- Configures the Knative autoscaling metric property (e.g. to set `concurrency` based or `cpu` based autoscaling).
-
-
- Refer to the Knative documentation for more information.
+ description: "Configures the Knative autoscaling metric
+ property (e.g. to set `concurrency` based or `cpu` based
+ autoscaling). \n Refer to the Knative documentation
+ for more information."
type: string
autoscalingTarget:
- description: |-
- Sets the allowed concurrency level or CPU percentage (depending on the autoscaling metric) for each Pod.
-
-
- Refer to the Knative documentation for more information.
+ description: "Sets the allowed concurrency level or CPU
+ percentage (depending on the autoscaling metric) for
+ each Pod. \n Refer to the Knative documentation for
+ more information."
type: integer
class:
- description: |-
- Configures the Knative autoscaling class property (e.g. to set `hpa.autoscaling.knative.dev` or `kpa.autoscaling.knative.dev` autoscaling).
-
-
- Refer to the Knative documentation for more information.
+ description: "Configures the Knative autoscaling class
+ property (e.g. to set `hpa.autoscaling.knative.dev`
+ or `kpa.autoscaling.knative.dev` autoscaling). \n Refer
+ to the Knative documentation for more information."
enum:
- kpa.autoscaling.knative.dev
- hpa.autoscaling.knative.dev
type: string
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7492,43 +7921,38 @@ spec:
All traits share this common property.
type: boolean
maxScale:
- description: |-
- An upper bound for the number of Pods that can be running in parallel for the integration.
- Knative has its own cap value that depends on the installation.
-
-
- Refer to the Knative documentation for more information.
+ description: "An upper bound for the number of Pods that
+ can be running in parallel for the integration. Knative
+ has its own cap value that depends on the installation.
+ \n Refer to the Knative documentation for more information."
type: integer
minScale:
- description: |-
- The minimum number of Pods that should be running at any time for the integration. It's **zero** by default, meaning that
- the integration is scaled down to zero when not used for a configured amount of time.
-
-
- Refer to the Knative documentation for more information.
+ description: "The minimum number of Pods that should be
+ running at any time for the integration. It's **zero**
+ by default, meaning that the integration is scaled down
+ to zero when not used for a configured amount of time.
+ \n Refer to the Knative documentation for more information."
type: integer
rolloutDuration:
- description: |-
- Enables to gradually shift traffic to the latest Revision and sets the rollout duration.
- It's disabled by default and must be expressed as a Golang `time.Duration` string representation,
- rounded to a second precision.
+ description: Enables to gradually shift traffic to the
+ latest Revision and sets the rollout duration. It's
+ disabled by default and must be expressed as a Golang
+ `time.Duration` string representation, rounded to a
+ second precision.
type: string
timeoutSeconds:
- description: |-
- The maximum duration in seconds that the request instance is allowed to respond to a request.
+ description: "The maximum duration in seconds that the
+ request instance is allowed to respond to a request.
This field propagates to the integration pod's terminationGracePeriodSeconds
-
-
- Refer to the Knative documentation for more information.
+ \n Refer to the Knative documentation for more information."
format: int64
type: integer
visibility:
- description: |-
- Setting `cluster-local`, Knative service becomes a private service.
- Specifically, this option applies the `networking.knative.dev/visibility` label to Knative service.
-
-
- Refer to the Knative documentation for more information.
+ description: "Setting `cluster-local`, Knative service
+ becomes a private service. Specifically, this option
+ applies the `networking.knative.dev/visibility` label
+ to Knative service. \n Refer to the Knative documentation
+ for more information."
enum:
- cluster-local
type: string
@@ -7540,9 +7964,8 @@ spec:
description: Colorize the log output
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7582,18 +8005,20 @@ spec:
description: The configuration of Mount trait
properties:
configs:
- description: |-
- A list of configuration pointing to configmap/secret.
- The configuration are expected to be UTF-8 resources as they are processed by runtime Camel Context and tried to be parsed as property files.
- They are also made available on the classpath in order to ease their usage directly from the Route.
- Syntax: [configmap|secret]:name[/key], where name represents the resource name and key optionally represents the resource key to be filtered
+ description: 'A list of configuration pointing to configmap/secret.
+ The configuration are expected to be UTF-8 resources
+ as they are processed by runtime Camel Context and tried
+ to be parsed as property files. They are also made available
+ on the classpath in order to ease their usage directly
+ from the Route. Syntax: [configmap|secret]:name[/key],
+ where name represents the resource name and key optionally
+ represents the resource key to be filtered'
items:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
emptyDirs:
@@ -7606,17 +8031,21 @@ spec:
description: 'Deprecated: no longer in use.'
type: boolean
hotReload:
- description: |-
- Enable "hot reload" when a secret/configmap mounted is edited (default `false`). The configmap/secret must be
- marked with `camel.apache.org/integration` label to be taken in account. The resource will be watched for any kind change, also for
- changes in metadata.
+ description: Enable "hot reload" when a secret/configmap
+ mounted is edited (default `false`). The configmap/secret
+ must be marked with `camel.apache.org/integration` label
+ to be taken in account. The resource will be watched
+ for any kind change, also for changes in metadata.
type: boolean
resources:
- description: |-
- A list of resources (text or binary content) pointing to configmap/secret.
- The resources are expected to be any resource type (text or binary content).
- The destination path can be either a default location or any path specified by the user.
- Syntax: [configmap|secret]:name[/key][@path], where name represents the resource name, key optionally represents the resource key to be filtered and path represents the destination path
+ description: 'A list of resources (text or binary content)
+ pointing to configmap/secret. The resources are expected
+ to be any resource type (text or binary content). The
+ destination path can be either a default location or
+ any path specified by the user. Syntax: [configmap|secret]:name[/key][@path],
+ where name represents the resource name, key optionally
+ represents the resource key to be filtered and path
+ represents the destination path'
items:
type: string
type: array
@@ -7641,9 +8070,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7654,9 +8082,8 @@ spec:
description: The configuration of Owner trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7678,9 +8105,8 @@ spec:
description: The configuration of PDB trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7688,53 +8114,56 @@ spec:
All traits share this common property.
type: boolean
maxUnavailable:
- description: |-
- The number of pods for the Integration that can be unavailable after an eviction.
- It can be either an absolute number or a percentage (default `1` if `min-available` is also not set).
- Only one of `max-unavailable` and `min-available` can be specified.
+ description: The number of pods for the Integration that
+ can be unavailable after an eviction. It can be either
+ an absolute number or a percentage (default `1` if `min-available`
+ is also not set). Only one of `max-unavailable` and
+ `min-available` can be specified.
type: string
minAvailable:
- description: |-
- The number of pods for the Integration that must still be available after an eviction.
- It can be either an absolute number or a percentage.
- Only one of `min-available` and `max-unavailable` can be specified.
+ description: The number of pods for the Integration that
+ must still be available after an eviction. It can be
+ either an absolute number or a percentage. Only one
+ of `min-available` and `max-unavailable` can be specified.
type: string
type: object
platform:
description: The configuration of Platform trait
properties:
auto:
- description: |-
- To automatically detect from the environment if a default platform can be created (it will be created on OpenShift or when a registry address is set).
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'To automatically detect from the environment
+ if a default platform can be created (it will be created
+ on OpenShift or when a registry address is set). Deprecated:
+ Platform is auto generated by the operator install procedure
+ - maintained for backward compatibility'
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
createDefault:
- description: |-
- To create a default (empty) platform when the platform is missing.
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'To create a default (empty) platform when
+ the platform is missing. Deprecated: Platform is auto
+ generated by the operator install procedure - maintained
+ for backward compatibility'
type: boolean
enabled:
description: 'Deprecated: no longer in use.'
type: boolean
global:
- description: |-
- Indicates if the platform should be created globally in the case of global operator (default true).
- Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility
+ description: 'Indicates if the platform should be created
+ globally in the case of global operator (default true).
+ Deprecated: Platform is auto generated by the operator
+ install procedure - maintained for backward compatibility'
type: boolean
type: object
pod:
description: The configuration of Pod trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7746,9 +8175,8 @@ spec:
description: The configuration of Prometheus trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7774,9 +8202,8 @@ spec:
secret on the pod if it is of type `kubernetes.io/dockerconfigjson`.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7799,10 +8226,11 @@ spec:
description: The configuration of Quarkus trait
properties:
buildMode:
- description: |-
- The Quarkus mode to run: either `jvm` or `native` (default `jvm`).
- In case both `jvm` and `native` are specified, two `IntegrationKit` resources are created,
- with the `native` kit having precedence over the `jvm` one once ready.
+ description: 'The Quarkus mode to run: either `jvm` or
+ `native` (default `jvm`). In case both `jvm` and `native`
+ are specified, two `IntegrationKit` resources are created,
+ with the `native` kit having precedence over the `jvm`
+ one once ready.'
items:
description: QuarkusMode is the type of Quarkus build
packaging.
@@ -7812,9 +8240,8 @@ spec:
type: string
type: array
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7830,18 +8257,19 @@ spec:
in the runtime catalog)
type: string
packageTypes:
- description: |-
- The Quarkus package types, `fast-jar` or `native` (default `fast-jar`).
- In case both `fast-jar` and `native` are specified, two `IntegrationKit` resources are created,
- with the native kit having precedence over the `fast-jar` one once ready.
- The order influences the resolution of the current kit for the integration.
- The kit corresponding to the first package type will be assigned to the
- integration in case no existing kit that matches the integration exists.
- Deprecated: use `build-mode` instead.
+ description: 'The Quarkus package types, `fast-jar` or
+ `native` (default `fast-jar`). In case both `fast-jar`
+ and `native` are specified, two `IntegrationKit` resources
+ are created, with the native kit having precedence over
+ the `fast-jar` one once ready. The order influences
+ the resolution of the current kit for the integration.
+ The kit corresponding to the first package type will
+ be assigned to the integration in case no existing kit
+ that matches the integration exists. Deprecated: use
+ `build-mode` instead.'
items:
- description: |-
- QuarkusPackageType is the type of Quarkus build packaging.
- Deprecated: use `QuarkusMode` instead.
+ description: 'QuarkusPackageType is the type of Quarkus
+ build packaging. Deprecated: use `QuarkusMode` instead.'
enum:
- fast-jar
- native
@@ -7849,14 +8277,13 @@ spec:
type: array
type: object
registry:
- description: |-
- The configuration of Registry trait (support removed since version 2.5.0).
- Deprecated: use jvm trait or read documentation.
+ description: 'The configuration of Registry trait (support
+ removed since version 2.5.0). Deprecated: use jvm trait
+ or read documentation.'
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7870,16 +8297,14 @@ spec:
annotations:
additionalProperties:
type: string
- description: |-
- The annotations added to route.
- This can be used to set route specific annotations
- For annotations options see https://docs.openshift.com/container-platform/3.11/architecture/networking/routes.html#route-specific-annotations
- CLI usage example: -t "route.annotations.'haproxy.router.openshift.io/balance'=true"
+ description: 'The annotations added to route. This can
+ be used to set route specific annotations For annotations
+ options see https://docs.openshift.com/container-platform/3.11/architecture/networking/routes.html#route-specific-annotations
+ CLI usage example: -t "route.annotations.''haproxy.router.openshift.io/balance''=true"'
type: object
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -7890,82 +8315,82 @@ spec:
description: To configure the host exposed by the route.
type: string
tlsCACertificate:
- description: |-
- The TLS CA certificate contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS CA certificate contents. \n Refer
+ to the OpenShift route documentation for additional
+ information."
type: string
tlsCACertificateSecret:
- description: |-
- The secret name and key reference to the TLS CA certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the
+ TLS CA certificate. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only
+ one key in the secret it will be read, otherwise you
+ can set a key name separated with a \"/\". \n Refer
+ to the OpenShift route documentation for additional
+ information."
type: string
tlsCertificate:
- description: |-
- The TLS certificate contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS certificate contents. \n Refer to
+ the OpenShift route documentation for additional information."
type: string
tlsCertificateSecret:
- description: |-
- The secret name and key reference to the TLS certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the
+ TLS certificate. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only
+ one key in the secret it will be read, otherwise you
+ can set a key name separated with a \"/\". \n Refer
+ to the OpenShift route documentation for additional
+ information."
type: string
tlsDestinationCACertificate:
- description: |-
- The destination CA certificate provides the contents of the ca certificate of the final destination. When using reencrypt
- termination this file should be provided in order to have routers use it for health checks on the secure connection.
- If this field is not specified, the router may provide its own destination CA and perform hostname validation using
- the short service name (service.namespace.svc), which allows infrastructure generated certificates to automatically
- verify.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The destination CA certificate provides
+ the contents of the ca certificate of the final destination.
+ \ When using reencrypt termination this file should
+ be provided in order to have routers use it for health
+ checks on the secure connection. If this field is not
+ specified, the router may provide its own destination
+ CA and perform hostname validation using the short service
+ name (service.namespace.svc), which allows infrastructure
+ generated certificates to automatically verify. \n Refer
+ to the OpenShift route documentation for additional
+ information."
type: string
tlsDestinationCACertificateSecret:
- description: |-
- The secret name and key reference to the destination CA certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the
+ destination CA certificate. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only
+ one key in the secret it will be read, otherwise you
+ can set a key name separated with a \"/\". \n Refer
+ to the OpenShift route documentation for additional
+ information."
type: string
tlsInsecureEdgeTerminationPolicy:
- description: |-
- To configure how to deal with insecure traffic, e.g. `Allow`, `Disable` or `Redirect` traffic.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "To configure how to deal with insecure traffic,
+ e.g. `Allow`, `Disable` or `Redirect` traffic. \n Refer
+ to the OpenShift route documentation for additional
+ information."
enum:
- None
- Allow
- Redirect
type: string
tlsKey:
- description: |-
- The TLS certificate key contents.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS certificate key contents. \n Refer
+ to the OpenShift route documentation for additional
+ information."
type: string
tlsKeySecret:
- description: |-
- The secret name and key reference to the TLS certificate key. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/".
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The secret name and key reference to the
+ TLS certificate key. The format is \"secret-name[/key-name]\",
+ the value represents the secret name, if there is only
+ one key in the secret it will be read, otherwise you
+ can set a key name separated with a \"/\". \n Refer
+ to the OpenShift route documentation for additional
+ information."
type: string
tlsTermination:
- description: |-
- The TLS termination type, like `edge`, `passthrough` or `reencrypt`.
-
-
- Refer to the OpenShift route documentation for additional information.
+ description: "The TLS termination type, like `edge`, `passthrough`
+ or `reencrypt`. \n Refer to the OpenShift route documentation
+ for additional information."
enum:
- edge
- reencrypt
@@ -7976,9 +8401,8 @@ spec:
description: The configuration of Security Context trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -8010,9 +8434,8 @@ spec:
a Service needs to be created.
type: boolean
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -8020,9 +8443,8 @@ spec:
All traits share this common property.
type: boolean
nodePort:
- description: |-
- Enable Service to be exposed as NodePort (default `false`).
- Deprecated: Use service type instead.
+ description: 'Enable Service to be exposed as NodePort
+ (default `false`). Deprecated: Use service type instead.'
type: boolean
type:
description: The type of service to be used, either 'ClusterIP',
@@ -8037,9 +8459,8 @@ spec:
description: The configuration of Service Binding trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -8066,9 +8487,8 @@ spec:
description: The configuration of Toleration trait
properties:
configuration:
- description: |-
- Legacy trait configuration parameters.
- Deprecated: for backward compatibility.
+ description: 'Legacy trait configuration parameters. Deprecated:
+ for backward compatibility.'
type: object
x-kubernetes-preserve-unknown-fields: true
enabled:
@@ -8133,43 +8553,35 @@ spec:
description: API version of the referent.
type: string
fieldPath:
- description: |-
- If referring to a piece of an object instead of an entire object, this string
- should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
- For example, if the object reference is to a container within a pod, this would take on a value like:
- "spec.containers{name}" (where "name" refers to the name of the container that triggered
- the event) or if no container name is specified "spec.containers[2]" (container with
- index 2 in this pod). This syntax is chosen only to have some well-defined way of
- referencing a part of an object.
- TODO: this design is not final and this field is subject to change in the future.
+ description: 'If referring to a piece of an object instead
+ of an entire object, this string should contain a valid
+ JSON/Go field access statement, such as desiredState.manifest.containers[2].
+ For example, if the object reference is to a container within
+ a pod, this would take on a value like: "spec.containers{name}"
+ (where "name" refers to the name of the container that triggered
+ the event) or if no container name is specified "spec.containers[2]"
+ (container with index 2 in this pod). This syntax is chosen
+ only to have some well-defined way of referencing a part
+ of an object. TODO: this design is not final and this field
+ is subject to change in the future.'
type: string
kind:
- description: |-
- Kind of the referent.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ 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: 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'
type: string
namespace:
- description: |-
- Namespace of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
+ description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type: string
resourceVersion:
- description: |-
- Specific resourceVersion to which this reference is made, if any.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
+ description: 'Specific resourceVersion to which this reference
+ is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
type: string
uid:
- description: |-
- UID of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
+ description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
type: string
type: object
- x-kubernetes-map-type: atomic
uri:
description: URI can be used to specify the (Camel) endpoint explicitly
type: string
@@ -8206,43 +8618,35 @@ spec:
description: API version of the referent.
type: string
fieldPath:
- description: |-
- If referring to a piece of an object instead of an entire object, this string
- should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
- For example, if the object reference is to a container within a pod, this would take on a value like:
- "spec.containers{name}" (where "name" refers to the name of the container that triggered
- the event) or if no container name is specified "spec.containers[2]" (container with
- index 2 in this pod). This syntax is chosen only to have some well-defined way of
- referencing a part of an object.
- TODO: this design is not final and this field is subject to change in the future.
+ description: 'If referring to a piece of an object instead
+ of an entire object, this string should contain a valid
+ JSON/Go field access statement, such as desiredState.manifest.containers[2].
+ For example, if the object reference is to a container within
+ a pod, this would take on a value like: "spec.containers{name}"
+ (where "name" refers to the name of the container that triggered
+ the event) or if no container name is specified "spec.containers[2]"
+ (container with index 2 in this pod). This syntax is chosen
+ only to have some well-defined way of referencing a part
+ of an object. TODO: this design is not final and this field
+ is subject to change in the future.'
type: string
kind:
- description: |-
- Kind of the referent.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ 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: 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'
type: string
namespace:
- description: |-
- Namespace of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
+ description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type: string
resourceVersion:
- description: |-
- Specific resourceVersion to which this reference is made, if any.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
+ description: 'Specific resourceVersion to which this reference
+ is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
type: string
uid:
- description: |-
- UID of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
+ description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
type: string
type: object
- x-kubernetes-map-type: atomic
uri:
description: URI can be used to specify the (Camel) endpoint explicitly
type: string
@@ -8282,43 +8686,36 @@ spec:
description: API version of the referent.
type: string
fieldPath:
- description: |-
- If referring to a piece of an object instead of an entire object, this string
- should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
- For example, if the object reference is to a container within a pod, this would take on a value like:
- "spec.containers{name}" (where "name" refers to the name of the container that triggered
- the event) or if no container name is specified "spec.containers[2]" (container with
- index 2 in this pod). This syntax is chosen only to have some well-defined way of
- referencing a part of an object.
- TODO: this design is not final and this field is subject to change in the future.
+ description: 'If referring to a piece of an object instead
+ of an entire object, this string should contain a valid
+ JSON/Go field access statement, such as desiredState.manifest.containers[2].
+ For example, if the object reference is to a container
+ within a pod, this would take on a value like: "spec.containers{name}"
+ (where "name" refers to the name of the container that
+ triggered the event) or if no container name is specified
+ "spec.containers[2]" (container with index 2 in this pod).
+ This syntax is chosen only to have some well-defined way
+ of referencing a part of an object. TODO: this design
+ is not final and this field is subject to change in the
+ future.'
type: string
kind:
- description: |-
- Kind of the referent.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ 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: 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'
type: string
namespace:
- description: |-
- Namespace of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
+ description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type: string
resourceVersion:
- description: |-
- Specific resourceVersion to which this reference is made, if any.
- More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
+ description: 'Specific resourceVersion to which this reference
+ is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
type: string
uid:
- description: |-
- UID of the referent.
- More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
+ description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
type: string
type: object
- x-kubernetes-map-type: atomic
uri:
description: URI can be used to specify the (Camel) endpoint
explicitly
@@ -8375,15 +8772,12 @@ spec:
the condition's last transition.
type: string
status:
- description: |-
- Status is the status of the condition.
- Can be True, False, Unknown.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
+ description: 'Status is the status of the condition.
+ Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions'
type: string
type:
- description: |-
- Type is the type of the condition.
- More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
+ description: 'Type is the type of the condition. More
+ info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions'
type: string
required:
- status
@@ -8393,10 +8787,10 @@ spec:
items:
properties:
data:
- description: |-
- RawMessage is a raw encoded JSON value.
+ description: RawMessage is a raw encoded JSON value.
It implements Marshaler and Unmarshaler and can
- be used to delay JSON decoding or precompute a JSON encoding.
+ be used to delay JSON decoding or precompute a
+ JSON encoding.
x-kubernetes-preserve-unknown-fields: true
name:
type: string
@@ -8449,3 +8843,9 @@ spec:
specReplicasPath: .spec.replicas
statusReplicasPath: .status.replicas
status: {}
+status:
+ acceptedNames:
+ kind: ""
+ plural: ""
+ conditions: []
+ storedVersions: []
diff --git a/pkg/trait/ingress.go b/pkg/trait/ingress.go
index 93a42b32b1..6ee6a4c1d8 100644
--- a/pkg/trait/ingress.go
+++ b/pkg/trait/ingress.go
@@ -43,12 +43,13 @@ func newIngressTrait() Trait {
return &ingressTrait{
BaseTrait: NewBaseTrait(ingressTraitID, ingressTraitOrder),
IngressTrait: traitv1.IngressTrait{
- Annotations: map[string]string{},
- Host: "",
- Path: "/",
- PathType: ptrFrom(networkingv1.PathTypePrefix),
- TLSHosts: []string{},
- TLSSecretName: "",
+ IngressClassName: "",
+ Annotations: map[string]string{},
+ Host: "",
+ Path: "/",
+ PathType: ptrFrom(networkingv1.PathTypePrefix),
+ TLSHosts: []string{},
+ TLSSecretName: "",
},
}
}
@@ -126,6 +127,9 @@ func (t *ingressTrait) Apply(e *Environment) error {
},
},
}
+ if t.IngressClassName != "" {
+ ingress.Spec.IngressClassName = &t.IngressClassName
+ }
if len(t.TLSHosts) > 0 && t.TLSSecretName != "" {
ingress.Spec.TLS = []networkingv1.IngressTLS{
diff --git a/pkg/trait/ingress_test.go b/pkg/trait/ingress_test.go
index a1b3105166..d07aa57ba6 100644
--- a/pkg/trait/ingress_test.go
+++ b/pkg/trait/ingress_test.go
@@ -120,6 +120,37 @@ func TestApplyIngressTraitDoesSucceed(t *testing.T) {
assert.NotNil(t, *ingress.Spec.Rules[0].HTTP.Paths[0].PathType)
assert.Nil(t, ingress.Spec.TLS)
assert.Equal(t, networkingv1.PathTypePrefix, *ingress.Spec.Rules[0].HTTP.Paths[0].PathType)
+ assert.Nil(t, ingress.Spec.IngressClassName)
+ }
+ })
+
+ conditions := environment.Integration.Status.Conditions
+ assert.Len(t, conditions, 1)
+ assert.Equal(t, "service-name(hostname) -> service-name(http)", conditions[0].Message)
+}
+
+func TestApplyIngressTraitWithIngressClassNameDoesSucceed(t *testing.T) {
+ ingressTrait, environment := createNominalIngressTestWithIngressClassName("someIngressClass")
+
+ err := ingressTrait.Apply(environment)
+
+ require.NoError(t, err)
+ assert.Len(t, environment.Integration.Status.Conditions, 1)
+
+ assert.Len(t, environment.Resources.Items(), 2)
+ environment.Resources.Visit(func(resource runtime.Object) {
+ if ingress, ok := resource.(*networkingv1.Ingress); ok {
+ assert.Equal(t, "service-name", ingress.Name)
+ assert.Equal(t, "namespace", ingress.Namespace)
+ assert.Len(t, ingress.Spec.Rules, 1)
+ assert.Equal(t, "hostname", ingress.Spec.Rules[0].Host)
+ assert.Len(t, ingress.Spec.Rules[0].HTTP.Paths, 1)
+ assert.Equal(t, "service-name", ingress.Spec.Rules[0].HTTP.Paths[0].Backend.Service.Name)
+ assert.Equal(t, "/", ingress.Spec.Rules[0].HTTP.Paths[0].Path)
+ assert.NotNil(t, *ingress.Spec.Rules[0].HTTP.Paths[0].PathType)
+ assert.Nil(t, ingress.Spec.TLS)
+ assert.Equal(t, networkingv1.PathTypePrefix, *ingress.Spec.Rules[0].HTTP.Paths[0].PathType)
+ assert.Equal(t, "someIngressClass", *ingress.Spec.IngressClassName)
}
})
@@ -221,6 +252,12 @@ func TestConfigureTLSWithoutSecretNameIngressTraitWDoesSucceed(t *testing.T) {
assert.Equal(t, "service-name(hostname) -> service-name(http)", conditions[0].Message)
}
+func createNominalIngressTestWithIngressClassName(ingressClassName string) (*ingressTrait, *Environment) {
+ trait, environment := createNominalIngressTest()
+ trait.IngressClassName = ingressClassName
+ return trait, environment
+}
+
func createNominalIngressTest() (*ingressTrait, *Environment) {
trait, _ := newIngressTrait().(*ingressTrait)
trait.Enabled = ptr.To(true)