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 f8ef11254d..c09d882a9d 100644
--- a/docs/modules/ROOT/partials/apis/camel-k-crds.adoc
+++ b/docs/modules/ROOT/partials/apis/camel-k-crds.adoc
@@ -8015,7 +8015,8 @@ A list of Persistent Volume Claims to be mounted. Syntax: [pvcname:/container/pa
|
-A list of EmptyDir volumes to be mounted. Syntax: [name:/container/path]
+A list of EmptyDir volumes to be mounted. An optional size limit may be configured (default 500Mi).
+Syntax: name:/container/path[:sizeLimit]
|`hotReload` +
bool
diff --git a/docs/modules/traits/pages/mount.adoc b/docs/modules/traits/pages/mount.adoc
index 64cbadf8ef..8e1052c614 100644
--- a/docs/modules/traits/pages/mount.adoc
+++ b/docs/modules/traits/pages/mount.adoc
@@ -49,7 +49,8 @@ Syntax: [configmap\|secret]:name[/key][@path], where name represents the resourc
| mount.empty-dirs
| []string
-| A list of EmptyDir volumes to be mounted. Syntax: [name:/container/path]
+| A list of EmptyDir volumes to be mounted. An optional size limit may be configured (default 500Mi).
+Syntax: name:/container/path[:sizeLimit]
| mount.hot-reload
| bool
diff --git a/helm/camel-k/crds/camel-k-crds.yaml b/helm/camel-k/crds/camel-k-crds.yaml
index 6c17ef7035..411fa3c73e 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,10 +797,9 @@ spec:
Kamelet
type: boolean
interceptors:
- description: |-
- Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
- uses to pre/post process sources
- Deprecated: no longer in use.
+ description: 'Interceptors are optional identifiers
+ the org.apache.camel.k.RoutesLoader uses to pre/post
+ process sources Deprecated: no longer in use.'
items:
type: string
type: array
@@ -814,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
@@ -851,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
@@ -1034,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
@@ -1150,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
@@ -1231,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.
@@ -1247,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
@@ -1259,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.
@@ -1301,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:
@@ -1314,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
@@ -1326,7 +1312,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -1335,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
@@ -1347,7 +1332,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
properties:
@@ -1370,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
@@ -1390,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
@@ -1434,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.
@@ -1445,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
@@ -1457,7 +1450,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -1466,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
@@ -1478,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.
@@ -1492,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
@@ -1504,7 +1494,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -1513,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
@@ -1525,7 +1514,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: object
name:
@@ -1540,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
@@ -1683,10 +1671,9 @@ spec:
Kamelet
type: boolean
interceptors:
- description: |-
- Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
- uses to pre/post process sources
- Deprecated: no longer in use.
+ description: 'Interceptors are optional identifiers
+ the org.apache.camel.k.RoutesLoader uses to pre/post
+ process sources Deprecated: no longer in use.'
items:
type: string
type: array
@@ -1695,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
@@ -1829,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
@@ -1931,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:
@@ -2010,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)
@@ -2075,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
@@ -2123,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
@@ -2436,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
@@ -2604,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
@@ -2655,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
@@ -2687,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.
@@ -2752,10 +2735,9 @@ 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
- uses to pre/post process sources
- Deprecated: no longer in use.
+ description: 'Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
+ uses to pre/post process sources Deprecated: no longer in
+ use.'
items:
type: string
type: array
@@ -2764,9 +2746,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
@@ -2812,14 +2793,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:
@@ -2830,21 +2810,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
@@ -2875,14 +2861,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`
@@ -2898,10 +2884,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
@@ -2928,18 +2915,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:
@@ -2952,23 +2938,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:
@@ -2977,9 +2965,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:
@@ -2995,18 +2982,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
@@ -3014,14 +3001,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:
@@ -3171,12 +3157,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
@@ -3222,26 +3215,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
@@ -3257,14 +3245,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
@@ -3330,13 +3317,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:
@@ -3345,10 +3332,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
@@ -3357,20 +3342,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.
@@ -3399,9 +3380,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:
@@ -3412,10 +3392,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
@@ -3424,7 +3403,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -3433,10 +3411,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
@@ -3445,7 +3422,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
properties:
@@ -3454,9 +3430,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.
@@ -3465,10 +3440,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
@@ -3477,7 +3451,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -3486,10 +3459,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
@@ -3498,12 +3470,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.
@@ -3512,10 +3482,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
@@ -3524,7 +3493,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -3533,10 +3501,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
@@ -3545,7 +3512,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: object
maxRunningBuilds:
@@ -3599,13 +3565,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.
@@ -3640,9 +3605,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
@@ -3670,9 +3636,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:
@@ -3691,9 +3656,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
@@ -3702,9 +3667,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
@@ -3719,14 +3684,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:
@@ -3737,21 +3701,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
@@ -3782,14 +3752,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`
@@ -3805,10 +3775,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
@@ -3835,18 +3806,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:
@@ -3859,10 +3829,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:
@@ -3890,9 +3862,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:
@@ -3903,10 +3874,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'
@@ -3974,48 +3948,46 @@ 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.
- 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. 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:
@@ -4023,19 +3995,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:
@@ -4046,9 +4018,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:
@@ -4059,9 +4030,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:
@@ -4077,52 +4047,50 @@ spec:
- knative-service
type: string
useSSA:
- description: |-
- Deprecated: won't be able to enforce client side update in the future.
- 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: 'Deprecated: won''t be able to enforce client
+ side update in the future. 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
@@ -4136,9 +4104,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:
@@ -4153,11 +4120,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
@@ -4166,9 +4134,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:
@@ -4183,15 +4150,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
@@ -4206,9 +4172,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:
@@ -4330,19 +4295,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:
@@ -4353,18 +4316,17 @@ spec:
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/
+ 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
@@ -4388,9 +4350,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:
@@ -4407,23 +4368,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:
@@ -4434,20 +4397,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
@@ -4478,9 +4441,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:
@@ -4509,9 +4471,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:
@@ -4522,9 +4484,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:
@@ -4557,16 +4518,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
@@ -4575,9 +4534,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:
@@ -4585,9 +4543,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
@@ -4598,50 +4556,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:
@@ -4650,47 +4612,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:
@@ -4698,43 +4652,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
@@ -4746,9 +4693,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:
@@ -4788,23 +4734,26 @@ 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:
- description: 'A list of EmptyDir volumes to be mounted. Syntax:
- [name:/container/path]'
+ description: 'A list of EmptyDir volumes to be mounted. An
+ optional size limit may be configured (default 500Mi). Syntax:
+ name:/container/path[:sizeLimit]'
items:
type: string
type: array
@@ -4812,17 +4761,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
@@ -4847,9 +4800,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:
@@ -4860,9 +4812,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:
@@ -4884,9 +4835,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:
@@ -4894,53 +4844,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:
@@ -4952,9 +4905,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:
@@ -4980,9 +4932,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:
@@ -5005,10 +4956,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:
@@ -5017,9 +4968,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:
@@ -5035,18 +4985,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
@@ -5054,14 +5004,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:
@@ -5075,16 +5023,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:
@@ -5095,82 +5041,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
@@ -5181,9 +5119,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:
@@ -5215,9 +5152,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:
@@ -5225,9 +5161,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',
@@ -5242,9 +5177,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:
@@ -5275,9 +5209,8 @@ spec:
including automatic discovery of the telemetry endpoint.
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:
@@ -5308,9 +5241,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:
@@ -5347,14 +5279,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
@@ -5420,13 +5351,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:
@@ -5435,10 +5366,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
@@ -5447,20 +5376,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.
@@ -5489,9 +5414,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:
@@ -5502,10 +5426,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
@@ -5514,7 +5437,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -5523,10 +5445,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
@@ -5535,7 +5456,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
properties:
@@ -5544,9 +5464,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.
@@ -5555,10 +5474,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
@@ -5567,7 +5485,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -5576,10 +5493,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
@@ -5588,12 +5504,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.
@@ -5602,10 +5516,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
@@ -5614,7 +5527,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -5623,10 +5535,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
@@ -5635,7 +5546,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: object
maxRunningBuilds:
@@ -5723,13 +5633,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.
@@ -5778,9 +5687,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
@@ -5808,9 +5718,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:
@@ -5829,9 +5738,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
@@ -5840,9 +5749,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
@@ -5857,14 +5766,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:
@@ -5875,21 +5783,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
@@ -5920,14 +5834,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`
@@ -5943,10 +5857,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
@@ -5973,18 +5888,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:
@@ -5997,10 +5911,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:
@@ -6028,9 +5944,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:
@@ -6041,10 +5956,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'
@@ -6112,48 +6030,46 @@ 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.
- 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. 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:
@@ -6161,19 +6077,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:
@@ -6184,9 +6100,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:
@@ -6197,9 +6112,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:
@@ -6215,52 +6129,50 @@ spec:
- knative-service
type: string
useSSA:
- description: |-
- Deprecated: won't be able to enforce client side update in the future.
- 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: 'Deprecated: won''t be able to enforce client
+ side update in the future. 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
@@ -6274,9 +6186,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:
@@ -6291,11 +6202,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
@@ -6304,9 +6216,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:
@@ -6321,15 +6232,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
@@ -6344,9 +6254,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:
@@ -6468,19 +6377,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:
@@ -6491,18 +6398,17 @@ spec:
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/
+ 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
@@ -6526,9 +6432,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:
@@ -6545,23 +6450,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:
@@ -6572,20 +6479,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
@@ -6616,9 +6523,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:
@@ -6647,9 +6553,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:
@@ -6660,9 +6566,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:
@@ -6695,16 +6600,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
@@ -6713,9 +6616,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:
@@ -6723,9 +6625,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
@@ -6736,50 +6638,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:
@@ -6788,47 +6694,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:
@@ -6836,43 +6734,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
@@ -6884,9 +6775,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:
@@ -6926,23 +6816,26 @@ 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:
- description: 'A list of EmptyDir volumes to be mounted. Syntax:
- [name:/container/path]'
+ description: 'A list of EmptyDir volumes to be mounted. An
+ optional size limit may be configured (default 500Mi). Syntax:
+ name:/container/path[:sizeLimit]'
items:
type: string
type: array
@@ -6950,17 +6843,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
@@ -6985,9 +6882,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:
@@ -6998,9 +6894,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:
@@ -7022,9 +6917,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:
@@ -7032,53 +6926,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:
@@ -7090,9 +6987,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:
@@ -7118,9 +7014,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:
@@ -7143,10 +7038,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:
@@ -7155,9 +7050,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:
@@ -7173,18 +7067,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
@@ -7192,14 +7086,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:
@@ -7213,16 +7105,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:
@@ -7233,82 +7123,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
@@ -7319,9 +7201,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:
@@ -7353,9 +7234,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:
@@ -7363,9 +7243,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',
@@ -7380,9 +7259,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:
@@ -7413,9 +7291,8 @@ spec:
including automatic discovery of the telemetry endpoint.
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:
@@ -7446,9 +7323,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:
@@ -7481,12 +7357,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
@@ -7516,25 +7399,21 @@ 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.
- Deprecated: may be removed in future releases. Make use of IntegrationPlatform instead.
+ 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. Deprecated: may be removed in future releases. Make use of IntegrationPlatform
+ instead.'
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
@@ -7546,22 +7425,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:
@@ -7570,10 +7449,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
@@ -7582,20 +7459,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.
@@ -7624,9 +7497,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:
@@ -7637,10 +7509,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
@@ -7649,7 +7520,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -7658,10 +7528,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
@@ -7670,7 +7539,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
properties:
@@ -7679,9 +7547,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.
@@ -7690,10 +7557,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
@@ -7702,7 +7568,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -7711,10 +7576,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
@@ -7723,12 +7587,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.
@@ -7737,10 +7599,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
@@ -7749,7 +7610,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -7758,10 +7618,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
@@ -7770,7 +7629,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: object
registry:
@@ -7849,9 +7707,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:
@@ -7870,9 +7727,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
@@ -7881,9 +7738,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
@@ -7898,14 +7755,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:
@@ -7916,21 +7772,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
@@ -7961,14 +7823,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`
@@ -7984,10 +7846,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
@@ -8014,18 +7877,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:
@@ -8038,10 +7900,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:
@@ -8069,9 +7933,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:
@@ -8082,10 +7945,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'
@@ -8153,48 +8019,46 @@ 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.
- 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. 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:
@@ -8202,19 +8066,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:
@@ -8225,9 +8089,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:
@@ -8238,9 +8101,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:
@@ -8256,52 +8118,50 @@ spec:
- knative-service
type: string
useSSA:
- description: |-
- Deprecated: won't be able to enforce client side update in the future.
- 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: 'Deprecated: won''t be able to enforce client
+ side update in the future. 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
@@ -8315,9 +8175,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:
@@ -8332,11 +8191,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
@@ -8345,9 +8205,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:
@@ -8362,15 +8221,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
@@ -8385,9 +8243,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:
@@ -8509,19 +8366,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:
@@ -8532,18 +8387,17 @@ spec:
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/
+ 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
@@ -8567,9 +8421,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:
@@ -8586,23 +8439,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:
@@ -8613,20 +8468,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
@@ -8657,9 +8512,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:
@@ -8688,9 +8542,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:
@@ -8701,9 +8555,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:
@@ -8736,16 +8589,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
@@ -8754,9 +8605,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:
@@ -8764,9 +8614,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
@@ -8777,50 +8627,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:
@@ -8829,47 +8683,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:
@@ -8877,43 +8723,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
@@ -8925,9 +8764,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:
@@ -8967,23 +8805,26 @@ 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:
- description: 'A list of EmptyDir volumes to be mounted. Syntax:
- [name:/container/path]'
+ description: 'A list of EmptyDir volumes to be mounted. An
+ optional size limit may be configured (default 500Mi). Syntax:
+ name:/container/path[:sizeLimit]'
items:
type: string
type: array
@@ -8991,17 +8832,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
@@ -9026,9 +8871,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:
@@ -9039,9 +8883,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:
@@ -9063,9 +8906,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:
@@ -9073,53 +8915,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:
@@ -9131,9 +8976,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:
@@ -9159,9 +9003,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:
@@ -9184,10 +9027,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:
@@ -9196,9 +9039,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:
@@ -9214,18 +9056,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
@@ -9233,14 +9075,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:
@@ -9254,16 +9094,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:
@@ -9274,82 +9112,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
@@ -9360,9 +9190,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:
@@ -9394,9 +9223,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:
@@ -9404,9 +9232,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',
@@ -9421,9 +9248,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:
@@ -9454,9 +9280,8 @@ spec:
including automatic discovery of the telemetry endpoint.
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:
@@ -9487,9 +9312,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:
@@ -9521,22 +9345,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:
@@ -9545,10 +9369,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
@@ -9557,20 +9379,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.
@@ -9599,9 +9417,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:
@@ -9612,10 +9429,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
@@ -9624,7 +9440,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -9633,10 +9448,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
@@ -9645,7 +9459,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
properties:
@@ -9654,9 +9467,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.
@@ -9665,10 +9477,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
@@ -9677,7 +9488,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -9686,10 +9496,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
@@ -9698,12 +9507,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.
@@ -9712,10 +9519,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
@@ -9724,7 +9530,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -9733,10 +9538,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
@@ -9745,7 +9549,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: object
registry:
@@ -9866,9 +9669,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:
@@ -9887,9 +9689,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
@@ -9898,9 +9700,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
@@ -9915,14 +9717,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:
@@ -9933,21 +9734,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
@@ -9978,14 +9785,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`
@@ -10001,10 +9808,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
@@ -10031,18 +9839,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:
@@ -10055,10 +9862,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:
@@ -10086,9 +9895,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:
@@ -10099,10 +9907,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'
@@ -10170,48 +9981,46 @@ 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.
- 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. 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:
@@ -10219,19 +10028,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:
@@ -10242,9 +10051,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:
@@ -10255,9 +10063,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:
@@ -10273,52 +10080,50 @@ spec:
- knative-service
type: string
useSSA:
- description: |-
- Deprecated: won't be able to enforce client side update in the future.
- 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: 'Deprecated: won''t be able to enforce client
+ side update in the future. 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
@@ -10332,9 +10137,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:
@@ -10349,11 +10153,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
@@ -10362,9 +10167,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:
@@ -10379,15 +10183,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
@@ -10402,9 +10205,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:
@@ -10526,19 +10328,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:
@@ -10549,18 +10349,17 @@ spec:
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/
+ 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
@@ -10584,9 +10383,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:
@@ -10603,23 +10401,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:
@@ -10630,20 +10430,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
@@ -10674,9 +10474,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:
@@ -10705,9 +10504,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:
@@ -10718,9 +10517,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:
@@ -10753,16 +10551,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
@@ -10771,9 +10567,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:
@@ -10781,9 +10576,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
@@ -10794,50 +10589,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:
@@ -10846,47 +10645,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:
@@ -10894,43 +10685,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
@@ -10942,9 +10726,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:
@@ -10984,23 +10767,26 @@ 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:
- description: 'A list of EmptyDir volumes to be mounted. Syntax:
- [name:/container/path]'
+ description: 'A list of EmptyDir volumes to be mounted. An
+ optional size limit may be configured (default 500Mi). Syntax:
+ name:/container/path[:sizeLimit]'
items:
type: string
type: array
@@ -11008,17 +10794,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
@@ -11043,9 +10833,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:
@@ -11056,9 +10845,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:
@@ -11080,9 +10868,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:
@@ -11090,53 +10877,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:
@@ -11148,9 +10938,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:
@@ -11176,9 +10965,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:
@@ -11201,10 +10989,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:
@@ -11213,9 +11001,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:
@@ -11231,18 +11018,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
@@ -11250,14 +11037,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:
@@ -11271,16 +11056,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:
@@ -11291,82 +11074,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
@@ -11377,9 +11152,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:
@@ -11411,9 +11185,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:
@@ -11421,9 +11194,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',
@@ -11438,9 +11210,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:
@@ -11471,9 +11242,8 @@ spec:
including automatic discovery of the telemetry endpoint.
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:
@@ -11504,9 +11274,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:
@@ -11536,12 +11305,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
@@ -11594,19 +11370,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
@@ -11614,12 +11385,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.
@@ -11660,43 +11429,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
@@ -11737,10 +11498,9 @@ 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
- uses to pre/post process sources
- Deprecated: no longer in use.
+ description: 'Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
+ uses to pre/post process sources Deprecated: no longer in
+ use.'
items:
type: string
type: array
@@ -11749,9 +11509,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
@@ -11795,35 +11554,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.
@@ -11833,16 +11595,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
@@ -11855,10 +11618,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
@@ -11867,11 +11630,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
@@ -11885,11 +11649,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
@@ -11910,7 +11675,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret in
the pod's namespace
@@ -11921,10 +11685,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
@@ -11933,20 +11697,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
@@ -11955,17 +11719,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.
@@ -11974,56 +11737,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
@@ -12033,8 +11797,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:
@@ -12045,9 +11809,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
@@ -12065,15 +11830,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
@@ -12091,10 +11855,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
@@ -12104,37 +11869,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
@@ -12144,8 +11916,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:
@@ -12156,9 +11928,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
@@ -12176,15 +11949,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
@@ -12202,10 +11974,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
@@ -12215,10 +11988,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
@@ -12226,29 +11999,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
@@ -12262,12 +12036,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
@@ -12277,9 +12050,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.
@@ -12289,9 +12062,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
@@ -12308,35 +12082,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:
@@ -12351,59 +12124,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:
@@ -12411,24 +12186,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
@@ -12439,29 +12213,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
@@ -12475,12 +12250,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
@@ -12490,9 +12264,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.
@@ -12502,9 +12276,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
@@ -12521,35 +12296,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:
@@ -12564,33 +12338,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
@@ -12601,14 +12378,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
@@ -12617,31 +12394,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
@@ -12657,9 +12428,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:
@@ -12668,52 +12438,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
@@ -12731,60 +12506,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
@@ -12804,92 +12585,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
@@ -12903,12 +12696,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
@@ -12918,9 +12710,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.
@@ -12930,9 +12722,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
@@ -12949,35 +12742,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:
@@ -12992,75 +12784,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:
@@ -13085,44 +12885,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
@@ -13130,11 +12930,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
@@ -13146,47 +12945,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.
@@ -13196,16 +12998,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
@@ -13218,10 +13021,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
@@ -13230,11 +13033,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
@@ -13248,11 +13052,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
@@ -13273,7 +13078,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret in
the pod's namespace
@@ -13284,10 +13088,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
@@ -13296,20 +13100,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
@@ -13318,17 +13122,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.
@@ -13337,53 +13140,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
@@ -13393,8 +13196,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:
@@ -13405,9 +13208,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
@@ -13425,15 +13229,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
@@ -13451,10 +13254,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
@@ -13464,37 +13268,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
@@ -13504,8 +13315,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:
@@ -13516,9 +13327,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
@@ -13536,15 +13348,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
@@ -13562,10 +13373,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
@@ -13575,10 +13387,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
@@ -13592,19 +13404,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
@@ -13618,12 +13433,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
@@ -13633,9 +13447,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.
@@ -13645,9 +13459,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
@@ -13664,35 +13479,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:
@@ -13707,40 +13521,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.
@@ -13749,9 +13566,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:
@@ -13759,24 +13576,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
@@ -13793,19 +13609,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
@@ -13819,12 +13638,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
@@ -13834,9 +13652,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.
@@ -13846,9 +13664,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
@@ -13865,35 +13684,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:
@@ -13908,33 +13726,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
@@ -13945,14 +13766,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
@@ -13961,30 +13782,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
@@ -14000,9 +13817,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:
@@ -14011,40 +13827,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
@@ -14062,60 +13879,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
@@ -14135,62 +13958,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
@@ -14201,19 +14032,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
@@ -14227,12 +14061,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
@@ -14242,9 +14075,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.
@@ -14254,9 +14087,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
@@ -14273,35 +14107,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:
@@ -14316,85 +14149,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:
@@ -14419,44 +14261,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
@@ -14464,11 +14307,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
@@ -14481,35 +14323,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.
@@ -14519,16 +14364,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
@@ -14541,10 +14387,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
@@ -14553,11 +14399,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
@@ -14571,11 +14418,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
@@ -14596,7 +14444,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret in
the pod's namespace
@@ -14607,10 +14454,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
@@ -14619,20 +14466,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
@@ -14641,17 +14488,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.
@@ -14660,56 +14506,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
@@ -14719,8 +14566,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:
@@ -14731,9 +14578,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
@@ -14751,15 +14599,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
@@ -14777,10 +14624,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
@@ -14790,37 +14638,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
@@ -14830,8 +14685,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:
@@ -14842,9 +14697,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
@@ -14862,15 +14718,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
@@ -14888,10 +14743,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
@@ -14901,10 +14757,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
@@ -14912,29 +14768,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
@@ -14948,12 +14805,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
@@ -14963,9 +14819,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.
@@ -14975,9 +14831,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
@@ -14994,35 +14851,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:
@@ -15037,59 +14893,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:
@@ -15097,24 +14955,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
@@ -15125,29 +14982,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
@@ -15161,12 +15019,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
@@ -15176,9 +15033,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.
@@ -15188,9 +15045,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
@@ -15207,35 +15065,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:
@@ -15250,33 +15107,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
@@ -15287,14 +15147,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
@@ -15303,31 +15163,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
@@ -15343,9 +15197,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:
@@ -15354,52 +15207,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
@@ -15417,60 +15275,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
@@ -15490,92 +15354,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
@@ -15589,12 +15465,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
@@ -15604,9 +15479,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.
@@ -15616,9 +15491,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
@@ -15635,35 +15511,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:
@@ -15678,75 +15553,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:
@@ -15771,44 +15654,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
@@ -15816,11 +15699,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
@@ -15838,68 +15720,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
@@ -15919,48 +15799,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
@@ -15977,35 +15859,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
@@ -16020,34 +15906,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
@@ -16059,134 +15946,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
@@ -16201,36 +16092,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
@@ -16252,10 +16144,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
@@ -16265,9 +16157,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
@@ -16278,9 +16170,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
@@ -16298,9 +16190,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
@@ -16310,72 +16201,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
@@ -16385,25 +16269,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.
@@ -16412,21 +16301,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
@@ -16434,60 +16327,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
@@ -16497,15 +16389,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:
@@ -16533,15 +16427,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:
@@ -16552,9 +16448,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
@@ -16575,132 +16472,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
@@ -16714,38 +16607,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
@@ -16756,22 +16662,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:
@@ -16780,9 +16695,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:
@@ -16791,11 +16706,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:
@@ -16807,9 +16725,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
@@ -16817,16 +16736,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
@@ -16838,37 +16761,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
@@ -16885,20 +16823,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
@@ -16907,27 +16846,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:
@@ -16936,26 +16876,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
@@ -16965,9 +16904,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.
@@ -16975,55 +16914,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
@@ -17036,61 +16977,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
@@ -17101,59 +17035,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
@@ -17161,51 +17097,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
@@ -17216,10 +17144,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
@@ -17233,15 +17161,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
@@ -17255,13 +17183,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:
@@ -17271,39 +17202,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
@@ -17311,15 +17242,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
@@ -17332,24 +17269,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:
@@ -17357,10 +17299,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
@@ -17370,14 +17313,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.
@@ -17386,21 +17334,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
@@ -17408,17 +17364,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
@@ -17450,15 +17405,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:
@@ -17471,9 +17432,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:
@@ -17496,7 +17460,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
required:
- path
type: object
@@ -17507,14 +17470,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.
@@ -17523,21 +17491,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
@@ -17545,42 +17521,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
@@ -17593,30 +17574,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
@@ -17627,68 +17607,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
@@ -17699,11 +17670,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
@@ -17714,30 +17684,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:
@@ -17749,9 +17719,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
@@ -17759,30 +17729,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.
@@ -17791,21 +17765,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
@@ -17817,9 +17795,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:
@@ -17827,42 +17804,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:
@@ -17870,10 +17848,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
@@ -17924,9 +17902,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:
@@ -17945,9 +17922,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
@@ -17956,9 +17933,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
@@ -17973,14 +17950,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:
@@ -17991,21 +17967,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
@@ -18036,14 +18018,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`
@@ -18059,10 +18041,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
@@ -18089,18 +18072,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:
@@ -18113,10 +18095,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:
@@ -18144,9 +18128,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:
@@ -18157,10 +18140,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'
@@ -18228,48 +18214,46 @@ 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.
- 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. 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:
@@ -18277,19 +18261,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:
@@ -18300,9 +18284,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:
@@ -18313,9 +18296,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:
@@ -18331,52 +18313,50 @@ spec:
- knative-service
type: string
useSSA:
- description: |-
- Deprecated: won't be able to enforce client side update in the future.
- 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: 'Deprecated: won''t be able to enforce client
+ side update in the future. 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
@@ -18390,9 +18370,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:
@@ -18407,11 +18386,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
@@ -18420,9 +18400,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:
@@ -18437,15 +18416,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
@@ -18460,9 +18438,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:
@@ -18584,19 +18561,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:
@@ -18607,18 +18582,17 @@ spec:
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/
+ 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
@@ -18642,9 +18616,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:
@@ -18661,23 +18634,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:
@@ -18688,20 +18663,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
@@ -18732,9 +18707,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:
@@ -18763,9 +18737,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:
@@ -18776,9 +18750,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:
@@ -18811,16 +18784,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
@@ -18829,9 +18800,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:
@@ -18839,9 +18809,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
@@ -18852,50 +18822,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:
@@ -18904,47 +18878,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:
@@ -18952,43 +18918,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
@@ -19000,9 +18959,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:
@@ -19042,23 +19000,26 @@ 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:
- description: 'A list of EmptyDir volumes to be mounted. Syntax:
- [name:/container/path]'
+ description: 'A list of EmptyDir volumes to be mounted. An
+ optional size limit may be configured (default 500Mi). Syntax:
+ name:/container/path[:sizeLimit]'
items:
type: string
type: array
@@ -19066,17 +19027,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
@@ -19101,9 +19066,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:
@@ -19114,9 +19078,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:
@@ -19138,9 +19101,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:
@@ -19148,53 +19110,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:
@@ -19206,9 +19171,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:
@@ -19234,9 +19198,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:
@@ -19259,10 +19222,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:
@@ -19271,9 +19234,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:
@@ -19289,18 +19251,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
@@ -19308,14 +19270,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:
@@ -19329,16 +19289,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:
@@ -19349,82 +19307,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
@@ -19435,9 +19385,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:
@@ -19469,9 +19418,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:
@@ -19479,9 +19427,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',
@@ -19496,9 +19443,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:
@@ -19529,9 +19475,8 @@ spec:
including automatic discovery of the telemetry endpoint.
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:
@@ -19562,9 +19507,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:
@@ -19657,15 +19601,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
@@ -19675,10 +19616,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
@@ -19707,9 +19648,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.
@@ -19760,10 +19699,9 @@ 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
- uses to pre/post process sources
- Deprecated: no longer in use.
+ description: 'Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
+ uses to pre/post process sources Deprecated: no longer in
+ use.'
items:
type: string
type: array
@@ -19772,9 +19710,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
@@ -19809,43 +19746,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.
@@ -19903,9 +19832,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:
@@ -19924,9 +19852,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
@@ -19935,9 +19863,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
@@ -19952,14 +19880,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:
@@ -19970,21 +19897,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
@@ -20015,14 +19948,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`
@@ -20038,10 +19971,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
@@ -20068,18 +20002,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:
@@ -20092,10 +20025,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:
@@ -20123,9 +20058,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:
@@ -20136,10 +20070,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'
@@ -20207,48 +20144,46 @@ 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.
- 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. 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:
@@ -20256,19 +20191,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:
@@ -20279,9 +20214,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:
@@ -20292,9 +20226,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:
@@ -20310,52 +20243,50 @@ spec:
- knative-service
type: string
useSSA:
- description: |-
- Deprecated: won't be able to enforce client side update in the future.
- 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: 'Deprecated: won''t be able to enforce client
+ side update in the future. 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
@@ -20369,9 +20300,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:
@@ -20386,11 +20316,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
@@ -20399,9 +20330,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:
@@ -20416,15 +20346,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
@@ -20439,9 +20368,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:
@@ -20563,19 +20491,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:
@@ -20586,18 +20512,17 @@ spec:
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/
+ 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
@@ -20621,9 +20546,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:
@@ -20640,23 +20564,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:
@@ -20667,20 +20593,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
@@ -20711,9 +20637,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:
@@ -20742,9 +20667,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:
@@ -20755,9 +20680,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:
@@ -20790,16 +20714,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
@@ -20808,9 +20730,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:
@@ -20818,9 +20739,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
@@ -20831,50 +20752,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:
@@ -20883,47 +20808,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:
@@ -20931,43 +20848,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
@@ -20979,9 +20889,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:
@@ -21021,23 +20930,26 @@ 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:
- description: 'A list of EmptyDir volumes to be mounted. Syntax:
- [name:/container/path]'
+ description: 'A list of EmptyDir volumes to be mounted. An
+ optional size limit may be configured (default 500Mi). Syntax:
+ name:/container/path[:sizeLimit]'
items:
type: string
type: array
@@ -21045,17 +20957,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
@@ -21080,9 +20996,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:
@@ -21093,9 +21008,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:
@@ -21117,9 +21031,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:
@@ -21127,53 +21040,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:
@@ -21185,9 +21101,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:
@@ -21213,9 +21128,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:
@@ -21238,10 +21152,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:
@@ -21250,9 +21164,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:
@@ -21268,18 +21181,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
@@ -21287,14 +21200,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:
@@ -21308,16 +21219,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:
@@ -21328,82 +21237,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
@@ -21414,9 +21315,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:
@@ -21448,9 +21348,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:
@@ -21458,9 +21357,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',
@@ -21475,9 +21373,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:
@@ -21508,9 +21405,8 @@ spec:
including automatic discovery of the telemetry endpoint.
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:
@@ -21541,9 +21437,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:
@@ -21580,12 +21475,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
@@ -21621,19 +21523,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
@@ -21650,12 +21547,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.
@@ -21696,43 +21591,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
@@ -21773,10 +21660,9 @@ 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
- uses to pre/post process sources
- Deprecated: no longer in use.
+ description: 'Interceptors are optional identifiers the
+ org.apache.camel.k.RoutesLoader uses to pre/post process
+ sources Deprecated: no longer in use.'
items:
type: string
type: array
@@ -21785,9 +21671,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
@@ -21831,35 +21716,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.
@@ -21869,16 +21758,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
@@ -21891,10 +21782,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
@@ -21903,11 +21794,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
@@ -21921,11 +21813,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
@@ -21947,7 +21841,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret
in the pod's namespace
@@ -21958,10 +21851,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
@@ -21970,20 +21863,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
@@ -21992,17 +21886,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
@@ -22012,57 +21905,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
@@ -22072,9 +21967,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
@@ -22086,9 +21982,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
@@ -22107,15 +22005,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
@@ -22134,10 +22031,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
@@ -22147,38 +22046,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
@@ -22188,9 +22096,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
@@ -22202,9 +22111,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
@@ -22223,15 +22134,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
@@ -22250,10 +22160,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
@@ -22263,10 +22175,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
@@ -22274,30 +22186,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:
@@ -22310,12 +22225,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
@@ -22325,8 +22239,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:
@@ -22337,9 +22251,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
@@ -22357,35 +22272,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:
@@ -22400,59 +22315,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:
@@ -22460,24 +22379,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
@@ -22488,30 +22407,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:
@@ -22524,12 +22447,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
@@ -22539,8 +22461,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:
@@ -22551,9 +22473,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
@@ -22571,35 +22494,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:
@@ -22614,33 +22537,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
@@ -22651,14 +22579,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
@@ -22667,31 +22595,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
@@ -22707,9 +22630,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:
@@ -22718,52 +22640,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
@@ -22781,60 +22712,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
@@ -22854,93 +22794,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:
@@ -22953,12 +22912,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
@@ -22968,8 +22926,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:
@@ -22980,9 +22938,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
@@ -23000,35 +22959,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:
@@ -23043,76 +23002,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
@@ -23136,45 +23106,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
@@ -23182,11 +23153,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
@@ -23198,47 +23168,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.
@@ -23248,16 +23222,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
@@ -23270,10 +23246,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
@@ -23282,11 +23258,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
@@ -23300,11 +23277,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
@@ -23326,7 +23305,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret
in the pod's namespace
@@ -23337,10 +23315,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
@@ -23349,20 +23327,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
@@ -23371,17 +23350,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
@@ -23391,54 +23369,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
@@ -23448,9 +23427,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
@@ -23462,9 +23442,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
@@ -23483,15 +23465,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
@@ -23510,10 +23491,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
@@ -23523,38 +23506,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
@@ -23564,9 +23556,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
@@ -23578,9 +23571,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
@@ -23599,15 +23594,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
@@ -23626,10 +23620,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
@@ -23639,10 +23635,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
@@ -23657,20 +23653,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:
@@ -23683,12 +23684,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
@@ -23698,8 +23698,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:
@@ -23710,9 +23710,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
@@ -23730,35 +23731,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:
@@ -23773,40 +23774,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
@@ -23816,9 +23823,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:
@@ -23826,24 +23833,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
@@ -23861,20 +23868,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:
@@ -23887,12 +23899,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
@@ -23902,8 +23913,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:
@@ -23914,9 +23925,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
@@ -23934,35 +23946,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:
@@ -23977,33 +23989,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
@@ -24014,14 +24031,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
@@ -24030,30 +24047,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
@@ -24069,9 +24083,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:
@@ -24080,40 +24093,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
@@ -24131,60 +24147,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
@@ -24204,62 +24229,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
@@ -24271,20 +24308,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:
@@ -24297,12 +24339,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
@@ -24312,8 +24353,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:
@@ -24324,9 +24365,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
@@ -24344,35 +24386,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:
@@ -24387,86 +24429,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
@@ -24490,45 +24544,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
@@ -24536,11 +24592,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
@@ -24553,35 +24608,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.
@@ -24591,16 +24650,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
@@ -24613,10 +24674,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
@@ -24625,11 +24686,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
@@ -24643,11 +24705,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
@@ -24669,7 +24733,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret
in the pod's namespace
@@ -24680,10 +24743,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
@@ -24692,20 +24755,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
@@ -24714,17 +24778,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
@@ -24734,57 +24797,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
@@ -24794,9 +24859,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
@@ -24808,9 +24874,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
@@ -24829,15 +24897,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
@@ -24856,10 +24923,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
@@ -24869,38 +24938,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
@@ -24910,9 +24988,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
@@ -24924,9 +25003,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
@@ -24945,15 +25026,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
@@ -24972,10 +25052,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
@@ -24985,10 +25067,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
@@ -24996,30 +25078,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:
@@ -25032,12 +25117,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
@@ -25047,8 +25131,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:
@@ -25059,9 +25143,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
@@ -25079,35 +25164,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:
@@ -25122,59 +25207,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:
@@ -25182,24 +25271,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
@@ -25210,30 +25299,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:
@@ -25246,12 +25339,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
@@ -25261,8 +25353,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:
@@ -25273,9 +25365,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
@@ -25293,35 +25386,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:
@@ -25336,33 +25429,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
@@ -25373,14 +25471,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
@@ -25389,31 +25487,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
@@ -25429,9 +25522,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:
@@ -25440,52 +25532,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
@@ -25503,60 +25604,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
@@ -25576,93 +25686,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:
@@ -25675,12 +25804,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
@@ -25690,8 +25818,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:
@@ -25702,9 +25830,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
@@ -25722,35 +25851,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:
@@ -25765,76 +25894,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
@@ -25858,45 +25998,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
@@ -25904,11 +26045,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
@@ -25926,68 +26066,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
@@ -26007,48 +26148,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
@@ -26065,35 +26210,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
@@ -26108,34 +26260,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
@@ -26148,134 +26304,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
@@ -26290,36 +26458,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
@@ -26341,10 +26513,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:
@@ -26354,9 +26527,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
@@ -26368,9 +26541,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
@@ -26389,9 +26562,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
@@ -26401,72 +26574,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
@@ -26476,25 +26645,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.
@@ -26503,21 +26678,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
@@ -26525,60 +26705,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
@@ -26588,15 +26770,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:
@@ -26624,15 +26809,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:
@@ -26644,9 +26833,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
@@ -26668,132 +26859,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
@@ -26807,38 +27000,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
@@ -26849,22 +27061,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:
@@ -26873,9 +27095,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:
@@ -26884,11 +27106,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:
@@ -26900,9 +27126,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
@@ -26910,16 +27138,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
@@ -26931,37 +27166,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
@@ -26979,11 +27232,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
@@ -26991,9 +27245,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
@@ -27002,27 +27256,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:
@@ -27031,26 +27287,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
@@ -27060,9 +27316,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
@@ -27071,55 +27327,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
@@ -27132,61 +27392,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
@@ -27197,27 +27451,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
@@ -27225,33 +27482,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
@@ -27259,51 +27516,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
@@ -27314,10 +27564,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
@@ -27331,15 +27582,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
@@ -27353,13 +27605,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:
@@ -27369,30 +27624,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
@@ -27400,9 +27656,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
@@ -27410,16 +27668,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
@@ -27431,35 +27696,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
@@ -27469,14 +27741,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.
@@ -27486,21 +27765,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
@@ -27508,10 +27796,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
@@ -27519,7 +27807,6 @@ spec:
defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
downwardAPI:
description: downwardAPI information about
the downwardAPI data to project
@@ -27552,15 +27839,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:
@@ -27574,9 +27868,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
@@ -27600,7 +27897,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
required:
- path
type: object
@@ -27611,14 +27907,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.
@@ -27628,21 +27931,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
@@ -27650,10 +27962,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
@@ -27661,33 +27973,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
@@ -27700,30 +28019,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
@@ -27734,68 +28053,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
@@ -27806,11 +28116,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
@@ -27822,31 +28131,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
@@ -27857,9 +28166,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
@@ -27867,30 +28176,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.
@@ -27899,21 +28213,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
@@ -27925,9 +28244,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:
@@ -27935,42 +28254,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:
@@ -27978,10 +28300,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
@@ -28032,9 +28355,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:
@@ -28053,9 +28375,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
@@ -28064,9 +28386,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
@@ -28081,14 +28404,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:
@@ -28099,21 +28422,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
@@ -28145,14 +28475,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`
@@ -28168,10 +28498,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
@@ -28198,18 +28529,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:
@@ -28222,10 +28552,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:
@@ -28255,9 +28587,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:
@@ -28268,10 +28599,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'
@@ -28339,48 +28674,49 @@ 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.
- 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.
+ 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:
@@ -28388,19 +28724,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:
@@ -28411,9 +28747,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:
@@ -28424,9 +28759,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:
@@ -28442,52 +28776,50 @@ spec:
- knative-service
type: string
useSSA:
- description: |-
- Deprecated: won't be able to enforce client side update in the future.
- 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: 'Deprecated: won''t be able to enforce client
+ side update in the future. 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
@@ -28501,9 +28833,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:
@@ -28518,11 +28849,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
@@ -28531,9 +28863,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:
@@ -28548,15 +28879,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
@@ -28571,9 +28901,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:
@@ -28695,19 +29024,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:
@@ -28718,18 +29045,17 @@ spec:
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/
+ 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
@@ -28754,9 +29080,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:
@@ -28773,23 +29098,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:
@@ -28800,20 +29127,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
@@ -28844,9 +29171,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:
@@ -28875,9 +29201,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:
@@ -28888,9 +29214,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:
@@ -28923,16 +29248,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
@@ -28941,9 +29266,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:
@@ -28951,9 +29275,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
@@ -28964,49 +29288,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
@@ -29016,47 +29347,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:
@@ -29064,43 +29389,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
@@ -29112,9 +29432,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:
@@ -29154,23 +29473,26 @@ 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:
description: 'A list of EmptyDir volumes to be mounted.
- Syntax: [name:/container/path]'
+ An optional size limit may be configured (default 500Mi).
+ Syntax: name:/container/path[:sizeLimit]'
items:
type: string
type: array
@@ -29178,17 +29500,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
@@ -29213,9 +29539,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:
@@ -29226,9 +29551,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:
@@ -29250,9 +29574,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:
@@ -29260,53 +29583,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:
@@ -29318,9 +29644,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:
@@ -29346,9 +29671,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:
@@ -29371,10 +29695,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.
@@ -29384,9 +29709,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:
@@ -29402,18 +29726,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
@@ -29421,14 +29746,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:
@@ -29442,16 +29766,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:
@@ -29462,82 +29784,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
@@ -29548,9 +29870,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:
@@ -29582,9 +29903,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:
@@ -29592,9 +29912,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',
@@ -29609,9 +29928,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:
@@ -29642,9 +29960,8 @@ spec:
including automatic discovery of the telemetry endpoint.
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:
@@ -29676,9 +29993,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:
@@ -29743,48 +30059,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
@@ -29799,9 +30106,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
@@ -29827,49 +30134,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
@@ -29932,9 +30254,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
@@ -29972,48 +30294,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
@@ -30028,9 +30341,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
@@ -30056,49 +30369,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
@@ -30161,9 +30489,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
@@ -30204,48 +30532,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
@@ -30260,9 +30580,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
@@ -30288,49 +30609,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
@@ -30393,9 +30730,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
@@ -30453,15 +30790,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
@@ -30471,10 +30805,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
@@ -30527,12 +30861,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
@@ -30573,19 +30914,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
@@ -30666,9 +31002,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
@@ -30694,49 +31031,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
@@ -30817,9 +31170,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
@@ -30845,49 +31198,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
@@ -30975,10 +31335,9 @@ 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
- uses to pre/post process sources
- Deprecated: no longer in use.
+ description: 'Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
+ uses to pre/post process sources Deprecated: no longer in
+ use.'
items:
type: string
type: array
@@ -30987,9 +31346,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
@@ -31019,9 +31377,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,
@@ -31036,9 +31393,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
@@ -31064,49 +31421,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
@@ -31165,9 +31534,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
versions:
additionalProperties:
@@ -31249,9 +31617,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
@@ -31277,49 +31646,70 @@ 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
+ 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.
+ - 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
@@ -31400,9 +31790,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
@@ -31428,49 +31818,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
@@ -31559,10 +31961,9 @@ 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
- uses to pre/post process sources
- Deprecated: no longer in use.
+ description: 'Interceptors are optional identifiers the
+ org.apache.camel.k.RoutesLoader uses to pre/post process
+ sources Deprecated: no longer in use.'
items:
type: string
type: array
@@ -31571,9 +31972,8 @@ spec:
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
@@ -31603,9 +32003,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
@@ -31620,9 +32019,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
@@ -31648,49 +32048,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
@@ -31753,23 +32169,22 @@ 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
- description: |-
- the optional versions available for this Kamelet. This field may not be taken in account by Camel core and is meant to support
- any user defined versioning model on cluster only. If the user wants to use any given version, she must materialize a file with the given version spec
- as the `main` Kamelet spec on the runtime.
+ description: the optional versions available for this Kamelet. This
+ field may not be taken in account by Camel core and is meant to
+ support any user defined versioning model on cluster only. If the
+ user wants to use any given version, she must materialize a file
+ with the given version spec as the `main` Kamelet spec on the runtime.
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 --
@@ -31845,19 +32260,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
@@ -31938,9 +32348,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
@@ -31966,49 +32377,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
@@ -32089,9 +32516,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
@@ -32117,49 +32544,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
@@ -32247,10 +32681,9 @@ 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
- uses to pre/post process sources
- Deprecated: no longer in use.
+ description: 'Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
+ uses to pre/post process sources Deprecated: no longer in
+ use.'
items:
type: string
type: array
@@ -32259,9 +32692,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
@@ -32291,9 +32723,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,
@@ -32308,9 +32739,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
@@ -32336,49 +32767,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
@@ -32437,9 +32880,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:
@@ -32506,12 +32948,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
@@ -32544,19 +32993,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
@@ -32569,17 +33013,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.
@@ -32620,43 +33062,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
@@ -32697,10 +33131,9 @@ 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
- uses to pre/post process sources
- Deprecated: no longer in use.
+ description: 'Interceptors are optional identifiers the
+ org.apache.camel.k.RoutesLoader uses to pre/post process
+ sources Deprecated: no longer in use.'
items:
type: string
type: array
@@ -32709,9 +33142,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
@@ -32755,35 +33187,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.
@@ -32793,16 +33229,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
@@ -32815,10 +33253,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
@@ -32827,11 +33265,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
@@ -32845,11 +33284,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
@@ -32871,7 +33312,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret
in the pod's namespace
@@ -32882,10 +33322,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
@@ -32894,20 +33334,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
@@ -32916,17 +33357,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
@@ -32936,57 +33376,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
@@ -32996,9 +33438,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
@@ -33010,9 +33453,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
@@ -33031,15 +33476,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
@@ -33058,10 +33502,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
@@ -33071,38 +33517,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
@@ -33112,9 +33567,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
@@ -33126,9 +33582,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
@@ -33147,15 +33605,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
@@ -33174,10 +33631,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
@@ -33187,10 +33646,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
@@ -33198,30 +33657,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:
@@ -33234,12 +33696,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
@@ -33249,8 +33710,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:
@@ -33261,9 +33722,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
@@ -33281,35 +33743,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:
@@ -33324,59 +33786,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:
@@ -33384,24 +33850,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
@@ -33412,30 +33878,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:
@@ -33448,12 +33918,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
@@ -33463,8 +33932,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:
@@ -33475,9 +33944,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
@@ -33495,35 +33965,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:
@@ -33538,33 +34008,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
@@ -33575,14 +34050,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
@@ -33591,31 +34066,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
@@ -33631,9 +34101,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:
@@ -33642,52 +34111,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
@@ -33705,60 +34183,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
@@ -33778,93 +34265,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:
@@ -33877,12 +34383,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
@@ -33892,8 +34397,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:
@@ -33904,9 +34409,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
@@ -33924,35 +34430,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:
@@ -33967,76 +34473,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
@@ -34060,45 +34577,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
@@ -34106,11 +34624,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
@@ -34122,47 +34639,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.
@@ -34172,16 +34693,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
@@ -34194,10 +34717,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
@@ -34206,11 +34729,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
@@ -34224,11 +34748,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
@@ -34250,7 +34776,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret
in the pod's namespace
@@ -34261,10 +34786,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
@@ -34273,20 +34798,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
@@ -34295,17 +34821,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
@@ -34315,54 +34840,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
@@ -34372,9 +34898,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
@@ -34386,9 +34913,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
@@ -34407,15 +34936,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
@@ -34434,10 +34962,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
@@ -34447,38 +34977,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
@@ -34488,9 +35027,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
@@ -34502,9 +35042,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
@@ -34523,15 +35065,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
@@ -34550,10 +35091,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
@@ -34563,10 +35106,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
@@ -34581,20 +35124,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:
@@ -34607,12 +35155,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
@@ -34622,8 +35169,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:
@@ -34634,9 +35181,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
@@ -34654,35 +35202,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:
@@ -34697,40 +35245,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
@@ -34740,9 +35294,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:
@@ -34750,24 +35304,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
@@ -34785,20 +35339,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:
@@ -34811,12 +35370,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
@@ -34826,8 +35384,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:
@@ -34838,9 +35396,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
@@ -34858,35 +35417,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:
@@ -34901,33 +35460,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
@@ -34938,14 +35502,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
@@ -34954,30 +35518,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
@@ -34993,9 +35554,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:
@@ -35004,40 +35564,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
@@ -35055,60 +35618,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
@@ -35128,62 +35700,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
@@ -35195,20 +35779,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:
@@ -35221,12 +35810,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
@@ -35236,8 +35824,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:
@@ -35248,9 +35836,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
@@ -35268,35 +35857,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:
@@ -35311,86 +35900,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
@@ -35414,45 +36015,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
@@ -35460,11 +36063,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
@@ -35477,35 +36079,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.
@@ -35515,16 +36121,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
@@ -35537,10 +36145,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
@@ -35549,11 +36157,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
@@ -35567,11 +36176,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
@@ -35593,7 +36204,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret
in the pod's namespace
@@ -35604,10 +36214,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
@@ -35616,20 +36226,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
@@ -35638,17 +36249,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
@@ -35658,57 +36268,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
@@ -35718,9 +36330,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
@@ -35732,9 +36345,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
@@ -35753,15 +36368,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
@@ -35780,10 +36394,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
@@ -35793,38 +36409,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
@@ -35834,9 +36459,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
@@ -35848,9 +36474,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
@@ -35869,15 +36497,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
@@ -35896,10 +36523,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
@@ -35909,10 +36538,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
@@ -35920,30 +36549,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:
@@ -35956,12 +36588,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
@@ -35971,8 +36602,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:
@@ -35983,9 +36614,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
@@ -36003,35 +36635,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:
@@ -36046,59 +36678,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:
@@ -36106,24 +36742,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
@@ -36134,30 +36770,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:
@@ -36170,12 +36810,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
@@ -36185,8 +36824,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:
@@ -36197,9 +36836,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
@@ -36217,35 +36857,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:
@@ -36260,33 +36900,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
@@ -36297,14 +36942,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
@@ -36313,31 +36958,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
@@ -36353,9 +36993,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:
@@ -36364,52 +37003,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
@@ -36427,60 +37075,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
@@ -36500,93 +37157,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:
@@ -36599,12 +37275,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
@@ -36614,8 +37289,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:
@@ -36626,9 +37301,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
@@ -36646,35 +37322,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:
@@ -36689,76 +37365,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
@@ -36782,45 +37469,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
@@ -36828,11 +37516,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
@@ -36850,68 +37537,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
@@ -36931,48 +37619,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
@@ -36989,35 +37681,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
@@ -37032,34 +37731,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
@@ -37072,134 +37775,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
@@ -37214,36 +37929,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
@@ -37265,10 +37984,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:
@@ -37278,9 +37998,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
@@ -37292,9 +38012,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
@@ -37313,9 +38033,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
@@ -37325,72 +38045,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
@@ -37400,25 +38116,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.
@@ -37427,21 +38149,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
@@ -37449,60 +38176,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
@@ -37512,15 +38241,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:
@@ -37548,15 +38280,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:
@@ -37568,9 +38304,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
@@ -37592,132 +38330,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
@@ -37731,38 +38471,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
@@ -37773,22 +38532,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:
@@ -37797,9 +38566,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:
@@ -37808,11 +38577,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:
@@ -37824,9 +38597,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
@@ -37834,16 +38609,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
@@ -37855,37 +38637,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
@@ -37903,11 +38703,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
@@ -37915,9 +38716,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
@@ -37926,27 +38727,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:
@@ -37955,26 +38758,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
@@ -37984,9 +38787,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
@@ -37995,55 +38798,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
@@ -38056,61 +38863,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
@@ -38121,27 +38922,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
@@ -38149,33 +38953,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
@@ -38183,51 +38987,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
@@ -38238,10 +39035,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
@@ -38255,15 +39053,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
@@ -38277,13 +39076,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:
@@ -38293,30 +39095,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
@@ -38324,9 +39127,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
@@ -38334,16 +39139,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
@@ -38355,35 +39167,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
@@ -38393,14 +39212,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.
@@ -38410,21 +39236,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
@@ -38432,10 +39267,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
@@ -38443,7 +39278,6 @@ spec:
defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
downwardAPI:
description: downwardAPI information about
the downwardAPI data to project
@@ -38476,15 +39310,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:
@@ -38498,9 +39339,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
@@ -38524,7 +39368,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
required:
- path
type: object
@@ -38535,14 +39378,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.
@@ -38552,21 +39402,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
@@ -38574,10 +39433,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
@@ -38585,33 +39444,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
@@ -38624,30 +39490,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
@@ -38658,68 +39524,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
@@ -38730,11 +39587,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
@@ -38746,31 +39602,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
@@ -38781,9 +39637,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
@@ -38791,30 +39647,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.
@@ -38823,21 +39684,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
@@ -38849,9 +39715,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:
@@ -38859,42 +39725,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:
@@ -38902,10 +39771,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
@@ -38956,9 +39826,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:
@@ -38977,9 +39846,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
@@ -38988,9 +39857,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
@@ -39005,14 +39875,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:
@@ -39023,21 +39893,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
@@ -39069,14 +39946,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`
@@ -39092,10 +39969,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
@@ -39122,18 +40000,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:
@@ -39146,10 +40023,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:
@@ -39179,9 +40058,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:
@@ -39192,10 +40070,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'
@@ -39263,48 +40145,49 @@ 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.
- 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.
+ 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:
@@ -39312,19 +40195,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:
@@ -39335,9 +40218,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:
@@ -39348,9 +40230,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:
@@ -39366,52 +40247,50 @@ spec:
- knative-service
type: string
useSSA:
- description: |-
- Deprecated: won't be able to enforce client side update in the future.
- 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: 'Deprecated: won''t be able to enforce client
+ side update in the future. 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
@@ -39425,9 +40304,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:
@@ -39442,11 +40320,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
@@ -39455,9 +40334,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:
@@ -39472,15 +40350,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
@@ -39495,9 +40372,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:
@@ -39619,19 +40495,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:
@@ -39642,18 +40516,17 @@ spec:
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/
+ 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
@@ -39678,9 +40551,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:
@@ -39697,23 +40569,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:
@@ -39724,20 +40598,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
@@ -39768,9 +40642,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:
@@ -39799,9 +40672,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:
@@ -39812,9 +40685,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:
@@ -39847,16 +40719,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
@@ -39865,9 +40737,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:
@@ -39875,9 +40746,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
@@ -39888,49 +40759,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
@@ -39940,47 +40818,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:
@@ -39988,43 +40860,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
@@ -40036,9 +40903,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:
@@ -40078,23 +40944,26 @@ 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:
description: 'A list of EmptyDir volumes to be mounted.
- Syntax: [name:/container/path]'
+ An optional size limit may be configured (default 500Mi).
+ Syntax: name:/container/path[:sizeLimit]'
items:
type: string
type: array
@@ -40102,17 +40971,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
@@ -40137,9 +41010,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:
@@ -40150,9 +41022,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:
@@ -40174,9 +41045,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:
@@ -40184,53 +41054,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:
@@ -40242,9 +41115,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:
@@ -40270,9 +41142,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:
@@ -40295,10 +41166,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.
@@ -40308,9 +41180,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:
@@ -40326,18 +41197,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
@@ -40345,14 +41217,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:
@@ -40366,16 +41237,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:
@@ -40386,82 +41255,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
@@ -40472,9 +41341,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:
@@ -40506,9 +41374,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:
@@ -40516,9 +41383,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',
@@ -40533,9 +41399,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:
@@ -40566,9 +41431,8 @@ spec:
including automatic discovery of the telemetry endpoint.
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:
@@ -40600,9 +41464,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:
@@ -40667,43 +41530,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
@@ -40740,43 +41595,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
@@ -40816,43 +41663,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
@@ -40909,15 +41749,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
@@ -40927,10 +41764,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
@@ -40983,3 +41820,9 @@ spec:
specReplicasPath: .spec.replicas
statusReplicasPath: .status.replicas
status: {}
+status:
+ acceptedNames:
+ kind: ""
+ plural: ""
+ conditions: []
+ storedVersions: []
diff --git a/pkg/apis/camel/v1/trait/zz_generated.deepcopy.go b/pkg/apis/camel/v1/trait/zz_generated.deepcopy.go
index 42b190f709..de4d84f659 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 a4362f7409..995f923155 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 adec723791..c048519816 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,10 +798,9 @@ spec:
Kamelet
type: boolean
interceptors:
- description: |-
- Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
- uses to pre/post process sources
- Deprecated: no longer in use.
+ description: 'Interceptors are optional identifiers
+ the org.apache.camel.k.RoutesLoader uses to pre/post
+ process sources Deprecated: no longer in use.'
items:
type: string
type: array
@@ -814,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
@@ -851,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
@@ -1034,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
@@ -1150,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
@@ -1231,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.
@@ -1247,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
@@ -1259,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.
@@ -1301,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:
@@ -1314,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
@@ -1326,7 +1313,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -1335,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
@@ -1347,7 +1333,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
properties:
@@ -1370,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
@@ -1390,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
@@ -1434,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.
@@ -1445,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
@@ -1457,7 +1451,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -1466,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
@@ -1478,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.
@@ -1492,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
@@ -1504,7 +1495,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -1513,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
@@ -1525,7 +1515,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: object
name:
@@ -1540,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
@@ -1683,10 +1672,9 @@ spec:
Kamelet
type: boolean
interceptors:
- description: |-
- Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
- uses to pre/post process sources
- Deprecated: no longer in use.
+ description: 'Interceptors are optional identifiers
+ the org.apache.camel.k.RoutesLoader uses to pre/post
+ process sources Deprecated: no longer in use.'
items:
type: string
type: array
@@ -1695,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
@@ -1829,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
@@ -1931,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:
@@ -2010,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)
@@ -2075,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 ca19be9882..07b8c0625e 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,10 +156,9 @@ 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
- uses to pre/post process sources
- Deprecated: no longer in use.
+ description: 'Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
+ uses to pre/post process sources Deprecated: no longer in
+ use.'
items:
type: string
type: array
@@ -173,9 +167,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
@@ -221,14 +214,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:
@@ -239,21 +231,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
@@ -284,14 +282,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`
@@ -307,10 +305,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
@@ -337,18 +336,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:
@@ -361,23 +359,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:
@@ -386,9 +386,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:
@@ -404,18 +403,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
@@ -423,14 +422,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:
@@ -580,3 +578,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 d4d043e9e3..74ab83d5fe 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
@@ -64,26 +66,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
@@ -99,14 +96,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
@@ -172,13 +168,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:
@@ -187,10 +183,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
@@ -199,20 +193,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.
@@ -241,9 +231,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:
@@ -254,10 +243,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
@@ -266,7 +254,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -275,10 +262,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
@@ -287,7 +273,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
properties:
@@ -296,9 +281,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.
@@ -307,10 +291,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
@@ -319,7 +302,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -328,10 +310,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
@@ -340,12 +321,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.
@@ -354,10 +333,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
@@ -366,7 +344,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -375,10 +352,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
@@ -387,7 +363,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: object
maxRunningBuilds:
@@ -441,13 +416,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.
@@ -482,9 +456,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
@@ -512,9 +487,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:
@@ -533,9 +507,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
@@ -544,9 +518,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
@@ -561,14 +535,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:
@@ -579,21 +552,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
@@ -624,14 +603,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`
@@ -647,10 +626,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
@@ -677,18 +657,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:
@@ -701,10 +680,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:
@@ -732,9 +713,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:
@@ -745,10 +725,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'
@@ -816,48 +799,46 @@ 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.
- 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. 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:
@@ -865,19 +846,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:
@@ -888,9 +869,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:
@@ -901,9 +881,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:
@@ -919,52 +898,50 @@ spec:
- knative-service
type: string
useSSA:
- description: |-
- Deprecated: won't be able to enforce client side update in the future.
- 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: 'Deprecated: won''t be able to enforce client
+ side update in the future. 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
@@ -978,9 +955,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:
@@ -995,11 +971,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
@@ -1008,9 +985,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:
@@ -1025,15 +1001,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
@@ -1048,9 +1023,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:
@@ -1172,19 +1146,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:
@@ -1195,18 +1167,17 @@ spec:
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/
+ 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
@@ -1230,9 +1201,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:
@@ -1249,23 +1219,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:
@@ -1276,20 +1248,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
@@ -1320,9 +1292,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:
@@ -1351,9 +1322,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:
@@ -1364,9 +1335,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:
@@ -1399,16 +1369,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
@@ -1417,9 +1385,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:
@@ -1427,9 +1394,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
@@ -1440,50 +1407,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:
@@ -1492,47 +1463,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:
@@ -1540,43 +1503,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
@@ -1588,9 +1544,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:
@@ -1630,23 +1585,26 @@ 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:
- description: 'A list of EmptyDir volumes to be mounted. Syntax:
- [name:/container/path]'
+ description: 'A list of EmptyDir volumes to be mounted. An
+ optional size limit may be configured (default 500Mi). Syntax:
+ name:/container/path[:sizeLimit]'
items:
type: string
type: array
@@ -1654,17 +1612,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
@@ -1689,9 +1651,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:
@@ -1702,9 +1663,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:
@@ -1726,9 +1686,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:
@@ -1736,53 +1695,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:
@@ -1794,9 +1756,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:
@@ -1822,9 +1783,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:
@@ -1847,10 +1807,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:
@@ -1859,9 +1819,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:
@@ -1877,18 +1836,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
@@ -1896,14 +1855,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:
@@ -1917,16 +1874,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:
@@ -1937,82 +1892,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
@@ -2023,9 +1970,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:
@@ -2057,9 +2003,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:
@@ -2067,9 +2012,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',
@@ -2084,9 +2028,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:
@@ -2117,9 +2060,8 @@ spec:
including automatic discovery of the telemetry endpoint.
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:
@@ -2150,9 +2092,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:
@@ -2189,14 +2130,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
@@ -2262,13 +2202,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:
@@ -2277,10 +2217,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
@@ -2289,20 +2227,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.
@@ -2331,9 +2265,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:
@@ -2344,10 +2277,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
@@ -2356,7 +2288,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -2365,10 +2296,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
@@ -2377,7 +2307,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
properties:
@@ -2386,9 +2315,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.
@@ -2397,10 +2325,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
@@ -2409,7 +2336,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -2418,10 +2344,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
@@ -2430,12 +2355,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.
@@ -2444,10 +2367,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
@@ -2456,7 +2378,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -2465,10 +2386,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
@@ -2477,7 +2397,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: object
maxRunningBuilds:
@@ -2565,13 +2484,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.
@@ -2620,9 +2538,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
@@ -2650,9 +2569,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:
@@ -2671,9 +2589,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
@@ -2682,9 +2600,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
@@ -2699,14 +2617,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:
@@ -2717,21 +2634,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
@@ -2762,14 +2685,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`
@@ -2785,10 +2708,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
@@ -2815,18 +2739,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:
@@ -2839,10 +2762,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:
@@ -2870,9 +2795,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:
@@ -2883,10 +2807,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'
@@ -2954,48 +2881,46 @@ 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.
- 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. 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:
@@ -3003,19 +2928,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:
@@ -3026,9 +2951,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:
@@ -3039,9 +2963,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:
@@ -3057,52 +2980,50 @@ spec:
- knative-service
type: string
useSSA:
- description: |-
- Deprecated: won't be able to enforce client side update in the future.
- 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: 'Deprecated: won''t be able to enforce client
+ side update in the future. 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
@@ -3116,9 +3037,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:
@@ -3133,11 +3053,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
@@ -3146,9 +3067,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:
@@ -3163,15 +3083,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
@@ -3186,9 +3105,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:
@@ -3310,19 +3228,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:
@@ -3333,18 +3249,17 @@ spec:
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/
+ 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
@@ -3368,9 +3283,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:
@@ -3387,23 +3301,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:
@@ -3414,20 +3330,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
@@ -3458,9 +3374,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:
@@ -3489,9 +3404,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:
@@ -3502,9 +3417,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:
@@ -3537,16 +3451,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
@@ -3555,9 +3467,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:
@@ -3565,9 +3476,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
@@ -3578,50 +3489,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:
@@ -3630,47 +3545,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:
@@ -3678,43 +3585,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
@@ -3726,9 +3626,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:
@@ -3768,23 +3667,26 @@ 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:
- description: 'A list of EmptyDir volumes to be mounted. Syntax:
- [name:/container/path]'
+ description: 'A list of EmptyDir volumes to be mounted. An
+ optional size limit may be configured (default 500Mi). Syntax:
+ name:/container/path[:sizeLimit]'
items:
type: string
type: array
@@ -3792,17 +3694,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
@@ -3827,9 +3733,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:
@@ -3840,9 +3745,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:
@@ -3864,9 +3768,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:
@@ -3874,53 +3777,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:
@@ -3932,9 +3838,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:
@@ -3960,9 +3865,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:
@@ -3985,10 +3889,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:
@@ -3997,9 +3901,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:
@@ -4015,18 +3918,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
@@ -4034,14 +3937,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:
@@ -4055,16 +3956,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:
@@ -4075,82 +3974,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
@@ -4161,9 +4052,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:
@@ -4195,9 +4085,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:
@@ -4205,9 +4094,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',
@@ -4222,9 +4110,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:
@@ -4255,9 +4142,8 @@ spec:
including automatic discovery of the telemetry endpoint.
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:
@@ -4288,9 +4174,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:
@@ -4323,3 +4208,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 b4178e2760..381a7824f8 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,25 +50,21 @@ 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.
- Deprecated: may be removed in future releases. Make use of IntegrationPlatform instead.
+ 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. Deprecated: may be removed in future releases. Make use of IntegrationPlatform
+ instead.'
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
@@ -78,22 +76,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:
@@ -102,10 +100,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
@@ -114,20 +110,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.
@@ -156,9 +148,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:
@@ -169,10 +160,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
@@ -181,7 +171,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -190,10 +179,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
@@ -202,7 +190,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
properties:
@@ -211,9 +198,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.
@@ -222,10 +208,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
@@ -234,7 +219,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -243,10 +227,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
@@ -255,12 +238,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.
@@ -269,10 +250,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
@@ -281,7 +261,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -290,10 +269,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
@@ -302,7 +280,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: object
registry:
@@ -381,9 +358,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:
@@ -402,9 +378,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
@@ -413,9 +389,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
@@ -430,14 +406,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:
@@ -448,21 +423,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
@@ -493,14 +474,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`
@@ -516,10 +497,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
@@ -546,18 +528,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:
@@ -570,10 +551,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:
@@ -601,9 +584,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:
@@ -614,10 +596,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'
@@ -685,48 +670,46 @@ 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.
- 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. 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:
@@ -734,19 +717,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:
@@ -757,9 +740,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:
@@ -770,9 +752,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:
@@ -788,52 +769,50 @@ spec:
- knative-service
type: string
useSSA:
- description: |-
- Deprecated: won't be able to enforce client side update in the future.
- 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: 'Deprecated: won''t be able to enforce client
+ side update in the future. 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
@@ -847,9 +826,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:
@@ -864,11 +842,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
@@ -877,9 +856,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:
@@ -894,15 +872,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
@@ -917,9 +894,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:
@@ -1041,19 +1017,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:
@@ -1064,18 +1038,17 @@ spec:
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/
+ 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
@@ -1099,9 +1072,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:
@@ -1118,23 +1090,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:
@@ -1145,20 +1119,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
@@ -1189,9 +1163,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:
@@ -1220,9 +1193,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:
@@ -1233,9 +1206,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:
@@ -1268,16 +1240,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
@@ -1286,9 +1256,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:
@@ -1296,9 +1265,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
@@ -1309,50 +1278,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:
@@ -1361,47 +1334,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:
@@ -1409,43 +1374,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
@@ -1457,9 +1415,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:
@@ -1499,23 +1456,26 @@ 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:
- description: 'A list of EmptyDir volumes to be mounted. Syntax:
- [name:/container/path]'
+ description: 'A list of EmptyDir volumes to be mounted. An
+ optional size limit may be configured (default 500Mi). Syntax:
+ name:/container/path[:sizeLimit]'
items:
type: string
type: array
@@ -1523,17 +1483,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
@@ -1558,9 +1522,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:
@@ -1571,9 +1534,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:
@@ -1595,9 +1557,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:
@@ -1605,53 +1566,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:
@@ -1663,9 +1627,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:
@@ -1691,9 +1654,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:
@@ -1716,10 +1678,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:
@@ -1728,9 +1690,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:
@@ -1746,18 +1707,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
@@ -1765,14 +1726,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:
@@ -1786,16 +1745,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:
@@ -1806,82 +1763,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
@@ -1892,9 +1841,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:
@@ -1926,9 +1874,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:
@@ -1936,9 +1883,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',
@@ -1953,9 +1899,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:
@@ -1986,9 +1931,8 @@ spec:
including automatic discovery of the telemetry endpoint.
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:
@@ -2019,9 +1963,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:
@@ -2053,22 +1996,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:
@@ -2077,10 +2020,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
@@ -2089,20 +2030,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.
@@ -2131,9 +2068,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:
@@ -2144,10 +2080,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
@@ -2156,7 +2091,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -2165,10 +2099,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
@@ -2177,7 +2110,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: array
properties:
@@ -2186,9 +2118,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.
@@ -2197,10 +2128,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
@@ -2209,7 +2139,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -2218,10 +2147,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
@@ -2230,12 +2158,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.
@@ -2244,10 +2170,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
@@ -2256,7 +2181,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret.
properties:
@@ -2265,10 +2189,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
@@ -2277,7 +2200,6 @@ spec:
required:
- key
type: object
- x-kubernetes-map-type: atomic
type: object
type: object
registry:
@@ -2398,9 +2320,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:
@@ -2419,9 +2340,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
@@ -2430,9 +2351,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
@@ -2447,14 +2368,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:
@@ -2465,21 +2385,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
@@ -2510,14 +2436,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`
@@ -2533,10 +2459,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
@@ -2563,18 +2490,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:
@@ -2587,10 +2513,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:
@@ -2618,9 +2546,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:
@@ -2631,10 +2558,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'
@@ -2702,48 +2632,46 @@ 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.
- 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. 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:
@@ -2751,19 +2679,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:
@@ -2774,9 +2702,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:
@@ -2787,9 +2714,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:
@@ -2805,52 +2731,50 @@ spec:
- knative-service
type: string
useSSA:
- description: |-
- Deprecated: won't be able to enforce client side update in the future.
- 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: 'Deprecated: won''t be able to enforce client
+ side update in the future. 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
@@ -2864,9 +2788,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:
@@ -2881,11 +2804,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
@@ -2894,9 +2818,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:
@@ -2911,15 +2834,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
@@ -2934,9 +2856,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:
@@ -3058,19 +2979,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:
@@ -3081,18 +3000,17 @@ spec:
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/
+ 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
@@ -3116,9 +3034,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:
@@ -3135,23 +3052,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:
@@ -3162,20 +3081,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
@@ -3206,9 +3125,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:
@@ -3237,9 +3155,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:
@@ -3250,9 +3168,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:
@@ -3285,16 +3202,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
@@ -3303,9 +3218,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:
@@ -3313,9 +3227,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
@@ -3326,50 +3240,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:
@@ -3378,47 +3296,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:
@@ -3426,43 +3336,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
@@ -3474,9 +3377,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:
@@ -3516,23 +3418,26 @@ 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:
- description: 'A list of EmptyDir volumes to be mounted. Syntax:
- [name:/container/path]'
+ description: 'A list of EmptyDir volumes to be mounted. An
+ optional size limit may be configured (default 500Mi). Syntax:
+ name:/container/path[:sizeLimit]'
items:
type: string
type: array
@@ -3540,17 +3445,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
@@ -3575,9 +3484,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:
@@ -3588,9 +3496,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:
@@ -3612,9 +3519,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:
@@ -3622,53 +3528,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:
@@ -3680,9 +3589,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:
@@ -3708,9 +3616,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:
@@ -3733,10 +3640,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:
@@ -3745,9 +3652,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:
@@ -3763,18 +3669,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
@@ -3782,14 +3688,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:
@@ -3803,16 +3707,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:
@@ -3823,82 +3725,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
@@ -3909,9 +3803,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:
@@ -3943,9 +3836,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:
@@ -3953,9 +3845,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',
@@ -3970,9 +3861,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:
@@ -4003,9 +3893,8 @@ spec:
including automatic discovery of the telemetry endpoint.
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:
@@ -4036,9 +3925,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:
@@ -4068,3 +3956,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 406bd06eef..b6e97ec939 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
@@ -71,19 +73,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
@@ -91,12 +88,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.
@@ -137,43 +132,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
@@ -214,10 +201,9 @@ 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
- uses to pre/post process sources
- Deprecated: no longer in use.
+ description: 'Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
+ uses to pre/post process sources Deprecated: no longer in
+ use.'
items:
type: string
type: array
@@ -226,9 +212,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
@@ -272,35 +257,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.
@@ -310,16 +298,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
@@ -332,10 +321,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
@@ -344,11 +333,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
@@ -362,11 +352,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
@@ -387,7 +378,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret in
the pod's namespace
@@ -398,10 +388,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
@@ -410,20 +400,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
@@ -432,17 +422,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.
@@ -451,56 +440,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
@@ -510,8 +500,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:
@@ -522,9 +512,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
@@ -542,15 +533,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
@@ -568,10 +558,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
@@ -581,37 +572,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
@@ -621,8 +619,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:
@@ -633,9 +631,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
@@ -653,15 +652,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
@@ -679,10 +677,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
@@ -692,10 +691,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
@@ -703,29 +702,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
@@ -739,12 +739,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
@@ -754,9 +753,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.
@@ -766,9 +765,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
@@ -785,35 +785,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:
@@ -828,59 +827,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:
@@ -888,24 +889,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
@@ -916,29 +916,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
@@ -952,12 +953,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
@@ -967,9 +967,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.
@@ -979,9 +979,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
@@ -998,35 +999,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:
@@ -1041,33 +1041,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
@@ -1078,14 +1081,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
@@ -1094,31 +1097,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
@@ -1134,9 +1131,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:
@@ -1145,52 +1141,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
@@ -1208,60 +1209,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
@@ -1281,92 +1288,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
@@ -1380,12 +1399,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
@@ -1395,9 +1413,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.
@@ -1407,9 +1425,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
@@ -1426,35 +1445,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:
@@ -1469,75 +1487,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:
@@ -1562,44 +1588,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
@@ -1607,11 +1633,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
@@ -1623,47 +1648,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.
@@ -1673,16 +1701,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
@@ -1695,10 +1724,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
@@ -1707,11 +1736,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
@@ -1725,11 +1755,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
@@ -1750,7 +1781,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret in
the pod's namespace
@@ -1761,10 +1791,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
@@ -1773,20 +1803,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
@@ -1795,17 +1825,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.
@@ -1814,53 +1843,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
@@ -1870,8 +1899,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:
@@ -1882,9 +1911,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
@@ -1902,15 +1932,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
@@ -1928,10 +1957,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
@@ -1941,37 +1971,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
@@ -1981,8 +2018,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:
@@ -1993,9 +2030,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
@@ -2013,15 +2051,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
@@ -2039,10 +2076,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
@@ -2052,10 +2090,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
@@ -2069,19 +2107,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
@@ -2095,12 +2136,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
@@ -2110,9 +2150,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.
@@ -2122,9 +2162,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
@@ -2141,35 +2182,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:
@@ -2184,40 +2224,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.
@@ -2226,9 +2269,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:
@@ -2236,24 +2279,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
@@ -2270,19 +2312,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
@@ -2296,12 +2341,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
@@ -2311,9 +2355,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.
@@ -2323,9 +2367,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
@@ -2342,35 +2387,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:
@@ -2385,33 +2429,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
@@ -2422,14 +2469,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
@@ -2438,30 +2485,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
@@ -2477,9 +2520,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:
@@ -2488,40 +2530,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
@@ -2539,60 +2582,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
@@ -2612,62 +2661,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
@@ -2678,19 +2735,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
@@ -2704,12 +2764,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
@@ -2719,9 +2778,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.
@@ -2731,9 +2790,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
@@ -2750,35 +2810,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:
@@ -2793,85 +2852,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:
@@ -2896,44 +2964,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
@@ -2941,11 +3010,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
@@ -2958,35 +3026,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.
@@ -2996,16 +3067,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
@@ -3018,10 +3090,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
@@ -3030,11 +3102,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
@@ -3048,11 +3121,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
@@ -3073,7 +3147,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret in
the pod's namespace
@@ -3084,10 +3157,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
@@ -3096,20 +3169,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
@@ -3118,17 +3191,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.
@@ -3137,56 +3209,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
@@ -3196,8 +3269,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:
@@ -3208,9 +3281,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
@@ -3228,15 +3302,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
@@ -3254,10 +3327,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
@@ -3267,37 +3341,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
@@ -3307,8 +3388,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:
@@ -3319,9 +3400,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
@@ -3339,15 +3421,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
@@ -3365,10 +3446,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
@@ -3378,10 +3460,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
@@ -3389,29 +3471,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
@@ -3425,12 +3508,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
@@ -3440,9 +3522,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.
@@ -3452,9 +3534,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
@@ -3471,35 +3554,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:
@@ -3514,59 +3596,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:
@@ -3574,24 +3658,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
@@ -3602,29 +3685,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
@@ -3638,12 +3722,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
@@ -3653,9 +3736,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.
@@ -3665,9 +3748,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
@@ -3684,35 +3768,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:
@@ -3727,33 +3810,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
@@ -3764,14 +3850,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
@@ -3780,31 +3866,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
@@ -3820,9 +3900,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:
@@ -3831,52 +3910,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
@@ -3894,60 +3978,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
@@ -3967,92 +4057,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
@@ -4066,12 +4168,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
@@ -4081,9 +4182,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.
@@ -4093,9 +4194,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
@@ -4112,35 +4214,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:
@@ -4155,75 +4256,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:
@@ -4248,44 +4357,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
@@ -4293,11 +4402,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
@@ -4315,68 +4423,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
@@ -4396,48 +4502,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
@@ -4454,35 +4562,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
@@ -4497,34 +4609,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
@@ -4536,134 +4649,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
@@ -4678,36 +4795,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
@@ -4729,10 +4847,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
@@ -4742,9 +4860,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
@@ -4755,9 +4873,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
@@ -4775,9 +4893,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
@@ -4787,72 +4904,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
@@ -4862,25 +4972,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.
@@ -4889,21 +5004,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
@@ -4911,60 +5030,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
@@ -4974,15 +5092,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:
@@ -5010,15 +5130,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:
@@ -5029,9 +5151,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
@@ -5052,132 +5175,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
@@ -5191,38 +5310,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
@@ -5233,22 +5365,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:
@@ -5257,9 +5398,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:
@@ -5268,11 +5409,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:
@@ -5284,9 +5428,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
@@ -5294,16 +5439,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
@@ -5315,37 +5464,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
@@ -5362,20 +5526,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
@@ -5384,27 +5549,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:
@@ -5413,26 +5579,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
@@ -5442,9 +5607,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.
@@ -5452,55 +5617,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
@@ -5513,61 +5680,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
@@ -5578,59 +5738,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
@@ -5638,51 +5800,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
@@ -5693,10 +5847,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
@@ -5710,15 +5864,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
@@ -5732,13 +5886,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:
@@ -5748,39 +5905,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
@@ -5788,15 +5945,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
@@ -5809,24 +5972,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:
@@ -5834,10 +6002,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
@@ -5847,14 +6016,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.
@@ -5863,21 +6037,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
@@ -5885,17 +6067,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
@@ -5927,15 +6108,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:
@@ -5948,9 +6135,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:
@@ -5973,7 +6163,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
required:
- path
type: object
@@ -5984,14 +6173,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.
@@ -6000,21 +6194,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
@@ -6022,42 +6224,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
@@ -6070,30 +6277,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
@@ -6104,68 +6310,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
@@ -6176,11 +6373,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
@@ -6191,30 +6387,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:
@@ -6226,9 +6422,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
@@ -6236,30 +6432,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.
@@ -6268,21 +6468,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
@@ -6294,9 +6498,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:
@@ -6304,42 +6507,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:
@@ -6347,10 +6551,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
@@ -6401,9 +6605,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:
@@ -6422,9 +6625,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
@@ -6433,9 +6636,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
@@ -6450,14 +6653,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:
@@ -6468,21 +6670,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
@@ -6513,14 +6721,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`
@@ -6536,10 +6744,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
@@ -6566,18 +6775,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:
@@ -6590,10 +6798,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:
@@ -6621,9 +6831,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:
@@ -6634,10 +6843,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'
@@ -6705,48 +6917,46 @@ 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.
- 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. 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:
@@ -6754,19 +6964,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:
@@ -6777,9 +6987,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:
@@ -6790,9 +6999,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:
@@ -6808,52 +7016,50 @@ spec:
- knative-service
type: string
useSSA:
- description: |-
- Deprecated: won't be able to enforce client side update in the future.
- 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: 'Deprecated: won''t be able to enforce client
+ side update in the future. 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
@@ -6867,9 +7073,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:
@@ -6884,11 +7089,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
@@ -6897,9 +7103,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:
@@ -6914,15 +7119,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
@@ -6937,9 +7141,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:
@@ -7061,19 +7264,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:
@@ -7084,18 +7285,17 @@ spec:
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/
+ 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
@@ -7119,9 +7319,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:
@@ -7138,23 +7337,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:
@@ -7165,20 +7366,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
@@ -7209,9 +7410,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:
@@ -7240,9 +7440,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:
@@ -7253,9 +7453,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:
@@ -7288,16 +7487,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
@@ -7306,9 +7503,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:
@@ -7316,9 +7512,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
@@ -7329,50 +7525,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:
@@ -7381,47 +7581,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:
@@ -7429,43 +7621,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
@@ -7477,9 +7662,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:
@@ -7519,23 +7703,26 @@ 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:
- description: 'A list of EmptyDir volumes to be mounted. Syntax:
- [name:/container/path]'
+ description: 'A list of EmptyDir volumes to be mounted. An
+ optional size limit may be configured (default 500Mi). Syntax:
+ name:/container/path[:sizeLimit]'
items:
type: string
type: array
@@ -7543,17 +7730,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
@@ -7578,9 +7769,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:
@@ -7591,9 +7781,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:
@@ -7615,9 +7804,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:
@@ -7625,53 +7813,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:
@@ -7683,9 +7874,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:
@@ -7711,9 +7901,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:
@@ -7736,10 +7925,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:
@@ -7748,9 +7937,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:
@@ -7766,18 +7954,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
@@ -7785,14 +7973,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:
@@ -7806,16 +7992,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:
@@ -7826,82 +8010,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
@@ -7912,9 +8088,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:
@@ -7946,9 +8121,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:
@@ -7956,9 +8130,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',
@@ -7973,9 +8146,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:
@@ -8006,9 +8178,8 @@ spec:
including automatic discovery of the telemetry endpoint.
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:
@@ -8039,9 +8210,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:
@@ -8134,15 +8304,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
@@ -8152,10 +8319,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
@@ -8184,9 +8351,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.
@@ -8237,10 +8402,9 @@ 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
- uses to pre/post process sources
- Deprecated: no longer in use.
+ description: 'Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
+ uses to pre/post process sources Deprecated: no longer in
+ use.'
items:
type: string
type: array
@@ -8249,9 +8413,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
@@ -8286,43 +8449,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.
@@ -8380,9 +8535,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:
@@ -8401,9 +8555,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
@@ -8412,9 +8566,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
@@ -8429,14 +8583,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:
@@ -8447,21 +8600,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
@@ -8492,14 +8651,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`
@@ -8515,10 +8674,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
@@ -8545,18 +8705,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:
@@ -8569,10 +8728,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:
@@ -8600,9 +8761,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:
@@ -8613,10 +8773,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'
@@ -8684,48 +8847,46 @@ 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.
- 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. 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:
@@ -8733,19 +8894,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:
@@ -8756,9 +8917,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:
@@ -8769,9 +8929,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:
@@ -8787,52 +8946,50 @@ spec:
- knative-service
type: string
useSSA:
- description: |-
- Deprecated: won't be able to enforce client side update in the future.
- 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: 'Deprecated: won''t be able to enforce client
+ side update in the future. 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
@@ -8846,9 +9003,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:
@@ -8863,11 +9019,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
@@ -8876,9 +9033,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:
@@ -8893,15 +9049,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
@@ -8916,9 +9071,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:
@@ -9040,19 +9194,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:
@@ -9063,18 +9215,17 @@ spec:
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/
+ 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
@@ -9098,9 +9249,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:
@@ -9117,23 +9267,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:
@@ -9144,20 +9296,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
@@ -9188,9 +9340,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:
@@ -9219,9 +9370,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:
@@ -9232,9 +9383,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:
@@ -9267,16 +9417,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
@@ -9285,9 +9433,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:
@@ -9295,9 +9442,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
@@ -9308,50 +9455,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:
@@ -9360,47 +9511,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:
@@ -9408,43 +9551,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
@@ -9456,9 +9592,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:
@@ -9498,23 +9633,26 @@ 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:
- description: 'A list of EmptyDir volumes to be mounted. Syntax:
- [name:/container/path]'
+ description: 'A list of EmptyDir volumes to be mounted. An
+ optional size limit may be configured (default 500Mi). Syntax:
+ name:/container/path[:sizeLimit]'
items:
type: string
type: array
@@ -9522,17 +9660,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
@@ -9557,9 +9699,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:
@@ -9570,9 +9711,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:
@@ -9594,9 +9734,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:
@@ -9604,53 +9743,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:
@@ -9662,9 +9804,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:
@@ -9690,9 +9831,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:
@@ -9715,10 +9855,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:
@@ -9727,9 +9867,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:
@@ -9745,18 +9884,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
@@ -9764,14 +9903,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:
@@ -9785,16 +9922,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:
@@ -9805,82 +9940,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
@@ -9891,9 +10018,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:
@@ -9925,9 +10051,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:
@@ -9935,9 +10060,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',
@@ -9952,9 +10076,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:
@@ -9985,9 +10108,8 @@ spec:
including automatic discovery of the telemetry endpoint.
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:
@@ -10018,9 +10140,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:
@@ -10057,3 +10178,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 c6db8e8c2a..610e291918 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,10 +193,9 @@ 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
- uses to pre/post process sources
- Deprecated: no longer in use.
+ description: 'Interceptors are optional identifiers the
+ org.apache.camel.k.RoutesLoader uses to pre/post process
+ sources Deprecated: no longer in use.'
items:
type: string
type: array
@@ -218,9 +204,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
@@ -264,35 +249,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.
@@ -302,16 +291,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
@@ -324,10 +315,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
@@ -336,11 +327,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
@@ -354,11 +346,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
@@ -380,7 +374,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret
in the pod's namespace
@@ -391,10 +384,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
@@ -403,20 +396,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
@@ -425,17 +419,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
@@ -445,57 +438,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
@@ -505,9 +500,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
@@ -519,9 +515,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
@@ -540,15 +538,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
@@ -567,10 +564,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
@@ -580,38 +579,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
@@ -621,9 +629,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
@@ -635,9 +644,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
@@ -656,15 +667,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
@@ -683,10 +693,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
@@ -696,10 +708,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
@@ -707,30 +719,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:
@@ -743,12 +758,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
@@ -758,8 +772,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:
@@ -770,9 +784,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
@@ -790,35 +805,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:
@@ -833,59 +848,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:
@@ -893,24 +912,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
@@ -921,30 +940,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:
@@ -957,12 +980,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
@@ -972,8 +994,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:
@@ -984,9 +1006,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
@@ -1004,35 +1027,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:
@@ -1047,33 +1070,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
@@ -1084,14 +1112,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
@@ -1100,31 +1128,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
@@ -1140,9 +1163,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:
@@ -1151,52 +1173,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
@@ -1214,60 +1245,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
@@ -1287,93 +1327,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:
@@ -1386,12 +1445,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
@@ -1401,8 +1459,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:
@@ -1413,9 +1471,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
@@ -1433,35 +1492,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:
@@ -1476,76 +1535,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
@@ -1569,45 +1639,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
@@ -1615,11 +1686,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
@@ -1631,47 +1701,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.
@@ -1681,16 +1755,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
@@ -1703,10 +1779,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
@@ -1715,11 +1791,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
@@ -1733,11 +1810,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
@@ -1759,7 +1838,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret
in the pod's namespace
@@ -1770,10 +1848,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
@@ -1782,20 +1860,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
@@ -1804,17 +1883,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
@@ -1824,54 +1902,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
@@ -1881,9 +1960,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
@@ -1895,9 +1975,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
@@ -1916,15 +1998,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
@@ -1943,10 +2024,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
@@ -1956,38 +2039,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
@@ -1997,9 +2089,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
@@ -2011,9 +2104,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
@@ -2032,15 +2127,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
@@ -2059,10 +2153,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
@@ -2072,10 +2168,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
@@ -2090,20 +2186,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:
@@ -2116,12 +2217,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
@@ -2131,8 +2231,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:
@@ -2143,9 +2243,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
@@ -2163,35 +2264,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:
@@ -2206,40 +2307,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
@@ -2249,9 +2356,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:
@@ -2259,24 +2366,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
@@ -2294,20 +2401,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:
@@ -2320,12 +2432,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
@@ -2335,8 +2446,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:
@@ -2347,9 +2458,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
@@ -2367,35 +2479,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:
@@ -2410,33 +2522,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
@@ -2447,14 +2564,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
@@ -2463,30 +2580,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
@@ -2502,9 +2616,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:
@@ -2513,40 +2626,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
@@ -2564,60 +2680,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
@@ -2637,62 +2762,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
@@ -2704,20 +2841,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:
@@ -2730,12 +2872,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
@@ -2745,8 +2886,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:
@@ -2757,9 +2898,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
@@ -2777,35 +2919,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:
@@ -2820,86 +2962,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
@@ -2923,45 +3077,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
@@ -2969,11 +3125,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
@@ -2986,35 +3141,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.
@@ -3024,16 +3183,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
@@ -3046,10 +3207,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
@@ -3058,11 +3219,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
@@ -3076,11 +3238,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
@@ -3102,7 +3266,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret
in the pod's namespace
@@ -3113,10 +3276,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
@@ -3125,20 +3288,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
@@ -3147,17 +3311,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
@@ -3167,57 +3330,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
@@ -3227,9 +3392,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
@@ -3241,9 +3407,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
@@ -3262,15 +3430,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
@@ -3289,10 +3456,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
@@ -3302,38 +3471,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
@@ -3343,9 +3521,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
@@ -3357,9 +3536,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
@@ -3378,15 +3559,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
@@ -3405,10 +3585,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
@@ -3418,10 +3600,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
@@ -3429,30 +3611,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:
@@ -3465,12 +3650,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
@@ -3480,8 +3664,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:
@@ -3492,9 +3676,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
@@ -3512,35 +3697,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:
@@ -3555,59 +3740,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:
@@ -3615,24 +3804,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
@@ -3643,30 +3832,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:
@@ -3679,12 +3872,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
@@ -3694,8 +3886,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:
@@ -3706,9 +3898,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
@@ -3726,35 +3919,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:
@@ -3769,33 +3962,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
@@ -3806,14 +4004,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
@@ -3822,31 +4020,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
@@ -3862,9 +4055,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:
@@ -3873,52 +4065,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
@@ -3936,60 +4137,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
@@ -4009,93 +4219,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:
@@ -4108,12 +4337,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
@@ -4123,8 +4351,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:
@@ -4135,9 +4363,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
@@ -4155,35 +4384,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:
@@ -4198,76 +4427,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
@@ -4291,45 +4531,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
@@ -4337,11 +4578,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
@@ -4359,68 +4599,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
@@ -4440,48 +4681,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
@@ -4498,35 +4743,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
@@ -4541,34 +4793,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
@@ -4581,134 +4837,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
@@ -4723,36 +4991,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
@@ -4774,10 +5046,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:
@@ -4787,9 +5060,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
@@ -4801,9 +5074,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
@@ -4822,9 +5095,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
@@ -4834,72 +5107,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
@@ -4909,25 +5178,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.
@@ -4936,21 +5211,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
@@ -4958,60 +5238,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
@@ -5021,15 +5303,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:
@@ -5057,15 +5342,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:
@@ -5077,9 +5366,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
@@ -5101,132 +5392,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
@@ -5240,38 +5533,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
@@ -5282,22 +5594,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:
@@ -5306,9 +5628,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:
@@ -5317,11 +5639,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:
@@ -5333,9 +5659,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
@@ -5343,16 +5671,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
@@ -5364,37 +5699,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
@@ -5412,11 +5765,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
@@ -5424,9 +5778,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
@@ -5435,27 +5789,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:
@@ -5464,26 +5820,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
@@ -5493,9 +5849,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
@@ -5504,55 +5860,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
@@ -5565,61 +5925,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
@@ -5630,27 +5984,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
@@ -5658,33 +6015,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
@@ -5692,51 +6049,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
@@ -5747,10 +6097,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
@@ -5764,15 +6115,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
@@ -5786,13 +6138,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:
@@ -5802,30 +6157,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
@@ -5833,9 +6189,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
@@ -5843,16 +6201,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
@@ -5864,35 +6229,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
@@ -5902,14 +6274,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.
@@ -5919,21 +6298,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
@@ -5941,10 +6329,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
@@ -5952,7 +6340,6 @@ spec:
defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
downwardAPI:
description: downwardAPI information about
the downwardAPI data to project
@@ -5985,15 +6372,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:
@@ -6007,9 +6401,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
@@ -6033,7 +6430,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
required:
- path
type: object
@@ -6044,14 +6440,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.
@@ -6061,21 +6464,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
@@ -6083,10 +6495,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
@@ -6094,33 +6506,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
@@ -6133,30 +6552,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
@@ -6167,68 +6586,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
@@ -6239,11 +6649,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
@@ -6255,31 +6664,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
@@ -6290,9 +6699,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
@@ -6300,30 +6709,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.
@@ -6332,21 +6746,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
@@ -6358,9 +6777,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:
@@ -6368,42 +6787,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:
@@ -6411,10 +6833,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
@@ -6465,9 +6888,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:
@@ -6486,9 +6908,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
@@ -6497,9 +6919,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
@@ -6514,14 +6937,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:
@@ -6532,21 +6955,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
@@ -6578,14 +7008,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`
@@ -6601,10 +7031,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
@@ -6631,18 +7062,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:
@@ -6655,10 +7085,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:
@@ -6688,9 +7120,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:
@@ -6701,10 +7132,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'
@@ -6772,48 +7207,49 @@ 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.
- 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.
+ 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:
@@ -6821,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:
@@ -6844,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:
@@ -6857,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:
@@ -6875,52 +7309,50 @@ spec:
- knative-service
type: string
useSSA:
- description: |-
- Deprecated: won't be able to enforce client side update in the future.
- 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: 'Deprecated: won''t be able to enforce client
+ side update in the future. 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 +7366,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 +7382,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 +7396,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 +7412,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 +7434,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 +7557,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:
@@ -7151,18 +7578,17 @@ spec:
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/
+ 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
@@ -7187,9 +7613,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:
@@ -7206,23 +7631,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:
@@ -7233,20 +7660,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
@@ -7277,9 +7704,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:
@@ -7308,9 +7734,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:
@@ -7321,9 +7747,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:
@@ -7356,16 +7781,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
@@ -7374,9 +7799,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:
@@ -7384,9 +7808,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
@@ -7397,49 +7821,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
@@ -7449,47 +7880,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:
@@ -7497,43 +7922,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
@@ -7545,9 +7965,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:
@@ -7587,23 +8006,26 @@ 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:
description: 'A list of EmptyDir volumes to be mounted.
- Syntax: [name:/container/path]'
+ An optional size limit may be configured (default 500Mi).
+ Syntax: name:/container/path[:sizeLimit]'
items:
type: string
type: array
@@ -7611,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
@@ -7646,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:
@@ -7659,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:
@@ -7683,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:
@@ -7693,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:
@@ -7751,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:
@@ -7779,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:
@@ -7804,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.
@@ -7817,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:
@@ -7835,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
@@ -7854,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:
@@ -7875,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:
@@ -7895,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
@@ -7981,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:
@@ -8015,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:
@@ -8025,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',
@@ -8042,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:
@@ -8075,9 +8493,8 @@ spec:
including automatic discovery of the telemetry endpoint.
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:
@@ -8109,9 +8526,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:
@@ -8176,48 +8592,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
@@ -8232,9 +8639,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
@@ -8260,49 +8667,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
@@ -8365,9 +8787,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
@@ -8405,48 +8827,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
@@ -8461,9 +8874,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
@@ -8489,49 +8902,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
@@ -8594,9 +9022,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
@@ -8637,48 +9065,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
@@ -8693,9 +9113,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
@@ -8721,49 +9142,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
@@ -8826,9 +9263,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
@@ -8886,15 +9323,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
@@ -8904,10 +9338,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
@@ -8960,3 +9394,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 7a61e23e24..35561b6201 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
@@ -59,19 +61,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
@@ -152,9 +149,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
@@ -180,49 +178,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
@@ -303,9 +317,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
@@ -331,49 +345,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
@@ -461,10 +482,9 @@ 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
- uses to pre/post process sources
- Deprecated: no longer in use.
+ description: 'Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
+ uses to pre/post process sources Deprecated: no longer in
+ use.'
items:
type: string
type: array
@@ -473,9 +493,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
@@ -505,9 +524,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,
@@ -522,9 +540,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
@@ -550,49 +568,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
@@ -651,9 +681,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
versions:
additionalProperties:
@@ -735,9 +764,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
@@ -763,49 +793,70 @@ 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
+ 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.
+ - 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
@@ -886,9 +937,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
@@ -914,49 +965,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
@@ -1045,10 +1108,9 @@ 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
- uses to pre/post process sources
- Deprecated: no longer in use.
+ description: 'Interceptors are optional identifiers the
+ org.apache.camel.k.RoutesLoader uses to pre/post process
+ sources Deprecated: no longer in use.'
items:
type: string
type: array
@@ -1057,9 +1119,8 @@ spec:
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
@@ -1089,9 +1150,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
@@ -1106,9 +1166,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
@@ -1134,49 +1195,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
@@ -1239,23 +1316,22 @@ 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
- description: |-
- the optional versions available for this Kamelet. This field may not be taken in account by Camel core and is meant to support
- any user defined versioning model on cluster only. If the user wants to use any given version, she must materialize a file with the given version spec
- as the `main` Kamelet spec on the runtime.
+ description: the optional versions available for this Kamelet. This
+ field may not be taken in account by Camel core and is meant to
+ support any user defined versioning model on cluster only. If the
+ user wants to use any given version, she must materialize a file
+ with the given version spec as the `main` Kamelet spec on the runtime.
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 --
@@ -1331,19 +1407,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
@@ -1424,9 +1495,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
@@ -1452,49 +1524,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
@@ -1575,9 +1663,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
@@ -1603,49 +1691,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
@@ -1733,10 +1828,9 @@ 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
- uses to pre/post process sources
- Deprecated: no longer in use.
+ description: 'Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader
+ uses to pre/post process sources Deprecated: no longer in
+ use.'
items:
type: string
type: array
@@ -1745,9 +1839,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
@@ -1777,9 +1870,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,
@@ -1794,9 +1886,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
@@ -1822,49 +1914,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
@@ -1923,9 +2027,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:
@@ -1992,3 +2095,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 2600c40803..be5164106e 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,10 +191,9 @@ 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
- uses to pre/post process sources
- Deprecated: no longer in use.
+ description: 'Interceptors are optional identifiers the
+ org.apache.camel.k.RoutesLoader uses to pre/post process
+ sources Deprecated: no longer in use.'
items:
type: string
type: array
@@ -216,9 +202,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
@@ -262,35 +247,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.
@@ -300,16 +289,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
@@ -322,10 +313,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
@@ -334,11 +325,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
@@ -352,11 +344,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
@@ -378,7 +372,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret
in the pod's namespace
@@ -389,10 +382,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
@@ -401,20 +394,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
@@ -423,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
@@ -443,57 +436,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
@@ -503,9 +498,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
@@ -517,9 +513,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
@@ -538,15 +536,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
@@ -565,10 +562,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
@@ -578,38 +577,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
@@ -619,9 +627,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
@@ -633,9 +642,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
@@ -654,15 +665,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
@@ -681,10 +691,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
@@ -694,10 +706,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
@@ -705,30 +717,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:
@@ -741,12 +756,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
@@ -756,8 +770,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:
@@ -768,9 +782,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
@@ -788,35 +803,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:
@@ -831,59 +846,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:
@@ -891,24 +910,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
@@ -919,30 +938,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:
@@ -955,12 +978,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
@@ -970,8 +992,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:
@@ -982,9 +1004,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
@@ -1002,35 +1025,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:
@@ -1045,33 +1068,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
@@ -1082,14 +1110,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
@@ -1098,31 +1126,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
@@ -1138,9 +1161,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:
@@ -1149,52 +1171,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
@@ -1212,60 +1243,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
@@ -1285,93 +1325,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:
@@ -1384,12 +1443,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
@@ -1399,8 +1457,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:
@@ -1411,9 +1469,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
@@ -1431,35 +1490,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:
@@ -1474,76 +1533,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
@@ -1567,45 +1637,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
@@ -1613,11 +1684,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
@@ -1629,47 +1699,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.
@@ -1679,16 +1753,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
@@ -1701,10 +1777,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
@@ -1713,11 +1789,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
@@ -1731,11 +1808,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
@@ -1757,7 +1836,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret
in the pod's namespace
@@ -1768,10 +1846,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
@@ -1780,20 +1858,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
@@ -1802,17 +1881,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
@@ -1822,54 +1900,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
@@ -1879,9 +1958,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
@@ -1893,9 +1973,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
@@ -1914,15 +1996,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
@@ -1941,10 +2022,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
@@ -1954,38 +2037,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
@@ -1995,9 +2087,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
@@ -2009,9 +2102,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
@@ -2030,15 +2125,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
@@ -2057,10 +2151,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
@@ -2070,10 +2166,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
@@ -2088,20 +2184,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:
@@ -2114,12 +2215,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
@@ -2129,8 +2229,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:
@@ -2141,9 +2241,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
@@ -2161,35 +2262,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:
@@ -2204,40 +2305,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
@@ -2247,9 +2354,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:
@@ -2257,24 +2364,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
@@ -2292,20 +2399,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:
@@ -2318,12 +2430,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
@@ -2333,8 +2444,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:
@@ -2345,9 +2456,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
@@ -2365,35 +2477,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:
@@ -2408,33 +2520,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
@@ -2445,14 +2562,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
@@ -2461,30 +2578,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
@@ -2500,9 +2614,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:
@@ -2511,40 +2624,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
@@ -2562,60 +2678,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
@@ -2635,62 +2760,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
@@ -2702,20 +2839,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:
@@ -2728,12 +2870,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
@@ -2743,8 +2884,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:
@@ -2755,9 +2896,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
@@ -2775,35 +2917,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:
@@ -2818,86 +2960,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
@@ -2921,45 +3075,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
@@ -2967,11 +3123,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
@@ -2984,35 +3139,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.
@@ -3022,16 +3181,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
@@ -3044,10 +3205,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
@@ -3056,11 +3217,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
@@ -3074,11 +3236,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
@@ -3100,7 +3264,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
secretKeyRef:
description: Selects a key of a secret
in the pod's namespace
@@ -3111,10 +3274,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
@@ -3123,20 +3286,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
@@ -3145,17 +3309,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
@@ -3165,57 +3328,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
@@ -3225,9 +3390,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
@@ -3239,9 +3405,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
@@ -3260,15 +3428,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
@@ -3287,10 +3454,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
@@ -3300,38 +3469,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
@@ -3341,9 +3519,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
@@ -3355,9 +3534,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
@@ -3376,15 +3557,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
@@ -3403,10 +3583,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
@@ -3416,10 +3598,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
@@ -3427,30 +3609,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:
@@ -3463,12 +3648,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
@@ -3478,8 +3662,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:
@@ -3490,9 +3674,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
@@ -3510,35 +3695,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:
@@ -3553,59 +3738,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:
@@ -3613,24 +3802,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
@@ -3641,30 +3830,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:
@@ -3677,12 +3870,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
@@ -3692,8 +3884,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:
@@ -3704,9 +3896,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
@@ -3724,35 +3917,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:
@@ -3767,33 +3960,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
@@ -3804,14 +4002,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
@@ -3820,31 +4018,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
@@ -3860,9 +4053,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:
@@ -3871,52 +4063,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
@@ -3934,60 +4135,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
@@ -4007,93 +4217,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:
@@ -4106,12 +4335,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
@@ -4121,8 +4349,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:
@@ -4133,9 +4361,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
@@ -4153,35 +4382,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:
@@ -4196,76 +4425,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
@@ -4289,45 +4529,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
@@ -4335,11 +4576,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
@@ -4357,68 +4597,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
@@ -4438,48 +4679,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
@@ -4496,35 +4741,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
@@ -4539,34 +4791,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
@@ -4579,134 +4835,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
@@ -4721,36 +4989,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
@@ -4772,10 +5044,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:
@@ -4785,9 +5058,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
@@ -4799,9 +5072,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
@@ -4820,9 +5093,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
@@ -4832,72 +5105,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
@@ -4907,25 +5176,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.
@@ -4934,21 +5209,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
@@ -4956,60 +5236,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
@@ -5019,15 +5301,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:
@@ -5055,15 +5340,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:
@@ -5075,9 +5364,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
@@ -5099,132 +5390,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
@@ -5238,38 +5531,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
@@ -5280,22 +5592,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:
@@ -5304,9 +5626,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:
@@ -5315,11 +5637,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:
@@ -5331,9 +5657,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
@@ -5341,16 +5669,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
@@ -5362,37 +5697,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
@@ -5410,11 +5763,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
@@ -5422,9 +5776,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
@@ -5433,27 +5787,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:
@@ -5462,26 +5818,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
@@ -5491,9 +5847,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
@@ -5502,55 +5858,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
@@ -5563,61 +5923,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
@@ -5628,27 +5982,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
@@ -5656,33 +6013,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
@@ -5690,51 +6047,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
@@ -5745,10 +6095,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
@@ -5762,15 +6113,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
@@ -5784,13 +6136,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:
@@ -5800,30 +6155,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
@@ -5831,9 +6187,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
@@ -5841,16 +6199,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
@@ -5862,35 +6227,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
@@ -5900,14 +6272,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.
@@ -5917,21 +6296,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
@@ -5939,10 +6327,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
@@ -5950,7 +6338,6 @@ spec:
defined
type: boolean
type: object
- x-kubernetes-map-type: atomic
downwardAPI:
description: downwardAPI information about
the downwardAPI data to project
@@ -5983,15 +6370,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:
@@ -6005,9 +6399,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
@@ -6031,7 +6428,6 @@ spec:
required:
- resource
type: object
- x-kubernetes-map-type: atomic
required:
- path
type: object
@@ -6042,14 +6438,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.
@@ -6059,21 +6462,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
@@ -6081,10 +6493,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
@@ -6092,33 +6504,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
@@ -6131,30 +6550,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
@@ -6165,68 +6584,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
@@ -6237,11 +6647,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
@@ -6253,31 +6662,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
@@ -6288,9 +6697,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
@@ -6298,30 +6707,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.
@@ -6330,21 +6744,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
@@ -6356,9 +6775,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:
@@ -6366,42 +6785,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:
@@ -6409,10 +6831,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
@@ -6463,9 +6886,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:
@@ -6484,9 +6906,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
@@ -6495,9 +6917,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
@@ -6512,14 +6935,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:
@@ -6530,21 +6953,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
@@ -6576,14 +7006,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`
@@ -6599,10 +7029,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
@@ -6629,18 +7060,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:
@@ -6653,10 +7083,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:
@@ -6686,9 +7118,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:
@@ -6699,10 +7130,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'
@@ -6770,48 +7205,49 @@ 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.
- 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.
+ 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:
@@ -6819,19 +7255,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:
@@ -6842,9 +7278,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:
@@ -6855,9 +7290,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:
@@ -6873,52 +7307,50 @@ spec:
- knative-service
type: string
useSSA:
- description: |-
- Deprecated: won't be able to enforce client side update in the future.
- 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: 'Deprecated: won''t be able to enforce client
+ side update in the future. 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
@@ -6932,9 +7364,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:
@@ -6949,11 +7380,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
@@ -6962,9 +7394,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:
@@ -6979,15 +7410,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
@@ -7002,9 +7432,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:
@@ -7126,19 +7555,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:
@@ -7149,18 +7576,17 @@ spec:
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/
+ 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
@@ -7185,9 +7611,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:
@@ -7204,23 +7629,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:
@@ -7231,20 +7658,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
@@ -7275,9 +7702,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:
@@ -7306,9 +7732,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:
@@ -7319,9 +7745,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:
@@ -7354,16 +7779,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
@@ -7372,9 +7797,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:
@@ -7382,9 +7806,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
@@ -7395,49 +7819,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
@@ -7447,47 +7878,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:
@@ -7495,43 +7920,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
@@ -7543,9 +7963,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:
@@ -7585,23 +8004,26 @@ 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:
description: 'A list of EmptyDir volumes to be mounted.
- Syntax: [name:/container/path]'
+ An optional size limit may be configured (default 500Mi).
+ Syntax: name:/container/path[:sizeLimit]'
items:
type: string
type: array
@@ -7609,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
@@ -7644,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:
@@ -7657,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:
@@ -7681,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:
@@ -7691,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:
@@ -7749,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:
@@ -7777,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:
@@ -7802,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.
@@ -7815,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:
@@ -7833,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
@@ -7852,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:
@@ -7873,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:
@@ -7893,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
@@ -7979,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:
@@ -8013,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:
@@ -8023,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',
@@ -8040,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:
@@ -8073,9 +8491,8 @@ spec:
including automatic discovery of the telemetry endpoint.
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:
@@ -8107,9 +8524,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:
@@ -8174,43 +8590,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
@@ -8247,43 +8655,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
@@ -8323,43 +8723,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
@@ -8416,15 +8809,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
@@ -8434,10 +8824,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
@@ -8490,3 +8880,9 @@ spec:
specReplicasPath: .spec.replicas
statusReplicasPath: .status.replicas
status: {}
+status:
+ acceptedNames:
+ kind: ""
+ plural: ""
+ conditions: []
+ storedVersions: []